Skip to main content

Disables a managed account

POST 
/managed_accounts/:id/actions/disable

Disables a managed account, forbidding it to use Telnyx services, including sending or receiving phone calls and SMS messages. Ongoing phone calls will not be affected. The managed account and its sub-users will no longer be able to log in via the mission control portal.

Request​

Path Parameters

    id stringrequired

    Managed Account User ID

Responses​

200: Successful response with information about a single managed account.

Schema

    data

    object

    record_type stringrequired

    Possible values: [managed_account]

    Identifies the type of the resource.

    id UUIDrequired

    Uniquely identifies the managed account.

    email emailrequired

    The managed account's email.

    api_key stringrequired

    The managed account's V2 API access key

    api_user stringrequired

    The manager account's email, which serves as the V1 API user identifier

    api_token stringrequired

    The managed account's V1 API token

    organization_name string

    The organization the managed account is associated with.

    manager_account_id stringrequired

    The ID of the manager account associated with the managed account.

    balance

    object

    record_type string

    Possible values: [balance]

    Identifies the type of the resource.

    balance decimal

    The account's current balance.

    credit_limit decimal

    The account's credit limit.

    available_credit decimal

    Available amount to spend (balance + credit limit)

    currency iso4217

    The ISO 4217 currency identifier.

    created_at stringrequired

    ISO 8601 formatted date indicating when the resource was created.

    updated_at stringrequired

    ISO 8601 formatted date indicating when the resource was updated.

    managed_account_allow_custom_pricing boolean

    Boolean value that indicates if the managed account is able to have custom pricing set for it or not. If false, uses the pricing of the manager account. Defaults to false. There may be time lag between when the value is changed and pricing changes take effect.

    rollup_billing boolean

    Boolean value that indicates if the billing information and charges to the managed account "roll up" to the manager account. If true, the managed account will not have its own balance and will use the shared balance with the manager account. This value cannot be changed after account creation without going through Telnyx support as changes require manual updates to the account ledger. Defaults to false.

401: Unauthenticated response. Happens when the current user cannot be authenticated.

404: Resource not found

422: Unprocessable entity. Check the 'detail' field in response for details.

Schema

    errors

    UnprocessableEntityError[]

  • Array [

    • code intrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta object

  • ]

Request samples

curl -L -X POST 'https://api.telnyx.com/v2/managed_accounts/:id/actions/disable' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "data": {
    "record_type": "managed_account",
    "id": "f65ceda4-6522-4ad6-aede-98de83385123",
    "email": "[email protected]",
    "api_key": "KEY01236170692E74656C6E79782E636F6D_YmlnIGlyb24gaXMgZGVhZA",
    "api_user": "[email protected]",
    "api_token": "x6oexQNHTs-fZ7-QsDMOeg",
    "organization_name": "Example Company LLC",
    "manager_account_id": "f65ceda4-6522-4ad6-aede-98de83385123",
    "balance": {
      "record_type": "balance",
      "balance": "300.00",
      "credit_limit": "100.00",
      "available_credit": "400.00",
      "currency": "USD"
    },
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "managed_account_allow_custom_pricing": true,
    "rollup_billing": false
  }
}