Skip to main content

Update a Tenant

PATCH 

/tenants/:id

This endpoint updates the Tenant data.

Request

Path Parameters

    id stringrequired

    ID of the Tenant.

Body

required

List of fields to update for the tenant

    base_url string

    The SDP backend server's base URL.

    sdp_ui_base_url string

    The SDP UI/dashboard Base URL.

    status string

    Possible values: [TENANT_CREATED, TENANT_PROVISIONED, TENANT_ACTIVATED, TENANT_DEACTIVATED]

Responses

Updated Tenant details

Schema

    id stringrequired
    name stringrequired

    The tenant name. It should match the pattern ^[a-z-]+$.

    base_url stringrequired

    The SDP backend server's base URL.

    sdp_ui_base_url stringrequired

    The SDP UI/dashboard Base URL.

    status stringrequired

    Possible values: [TENANT_CREATED, TENANT_PROVISIONED, TENANT_ACTIVATED, TENANT_DEACTIVATED]

    distribution_account_address stringrequired

    The Stellar account address used for distributing funds.

    distribution_account_type stringrequired

    Possible values: [DISTRIBUTION_ACCOUNT.STELLAR.ENV, DISTRIBUTION_ACCOUNT.STELLAR.DB_VAULT, DISTRIBUTION_ACCOUNT.CIRCLE.DB_VAULT]

    The Stellar account type used for distributing funds.

    distribution_account_status stringrequired

    Possible values: [ACTIVE, PENDING_USER_ACTIVATION]

    The status of the distribution account used for distributing funds.

    is_default booleanrequired

    Boolean flag that shows whether the tenant is the default or not.

    created_at date-timerequired
    updated_at date-timerequired
    deleted_at date-time

    The timestamp when the tenant was (soft) deleted.

Loading...