Managed Accounts

Managed Accounts operations

Lists accounts managed by the current user.

Lists the accounts managed by the current user. Users need to be explictly approved by Telnyx in order to become manager accounts.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[email][contains]
string
Default: "null"

If present, email containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.

filter[email][eq]
string
Default: "null"

If present, only returns results with the email matching exactly the value given.

filter[organization_name][contains]
string
Default: "null"

If present, only returns results with the organization_name containing the given value. Matching is not case-sensitive. Requires at least three characters.

filter[organization_name][eq]
string
Default: "null"

If present, only returns results with the organization_name matching exactly the value given.

sort
string
Default: "created_at"

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

That is:

  • email: sorts the result by the email field in ascending order.

  • -email: sorts the result by the email field in descending order.

If not given, results are sorted by created_at in descending order.
Enum: "created_at" "email"
Example: sort=email
include_cancelled_accounts
boolean
Default: "false"

Specifies if cancelled accounts should be included in the results.

Example: include_cancelled_accounts=true
Responses
200

Successful response with a list of managed accounts.

Response Schema: application/json
Array of objects (ManagedAccount)
object (PaginationMeta)
401

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

get/managed_accounts
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "record_type": "managed_account",
      • "id": "f65ceda4-6522-4ad6-aede-98de83385123",
      • "email": "[email protected]",
      • "api_user": "[email protected]",
      • "organization_name": "Example Company LLC",
      • "manager_account_id": "f65ceda4-6522-4ad6-aede-98de83385123",
      • "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
      }
    ],
  • "meta": {
    • "total_pages": 3,
    • "total_results": 55,
    • "page_number": 2,
    • "page_size": 25
    }
}
Create a new managed account.
Create a new managed account owned by the authenticated user. You need to be explictly approved by Telnyx in order to become a manager account.


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
Parameters that define the managed account to be created


email
string
The email address for the managed account. If not provided, the email address will be generated based on the email address of the manager account.


 
password
string
Password for the managed account. If a password is not supplied, the account will not be able to be signed into directly. (A password reset may still be performed later to enable sign-in via password.)


 
business_name
required
string
The name of the business for which the new managed account is being created, that will be used as the managed accounts's organization's name.


 
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. This value may be changed after creation, but 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.


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


Response Schema: application/json
object (ManagedAccount) 
 
record_type
required
string
Identifies the type of the resource.


 Value: "managed_account"  
id
required
string <UUID> 
Uniquely identifies the managed account.


 
email
required
string <email> 
The managed account's email.


 
api_key
required
string
The managed account's V2 API access key


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


 
api_token
required
string
The managed account's V1 API token


 
organization_name
string
The organization the managed account is associated with.


 
manager_account_id
required
string
The ID of the manager account associated with the managed account.


 
object (ManagedAccountBalance) 
 
created_at
required
string
ISO 8601 formatted date indicating when the resource was created.


 
updated_at
required
string
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.


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


Response Schema: application/json
Array of objects (UnprocessableEntityError) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
post/managed_accounts
Request samples 
application/json
{
  • "email": "[email protected]",
  • "password": "3jVjLq!tMuWKyWx4NN*CvhnB",
  • "business_name": "Larry's Cat Food Inc",
  • "managed_account_allow_custom_pricing": false,
  • "rollup_billing": false
}
Response samples 
application/json
{
  • "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
    }
}
Display information about allocatable global outbound channels for the current user.
Display information about allocatable global outbound channels for the current user. Only usable by account managers.


SecuritybearerAuth 
Responses 
200
Successful response with information about allocatable global outbound channels.


Response Schema: application/json
object (Managed Accounts Global Outbound Channels) 
 
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. This value may be changed, but there may be time lag between when the value is changed and pricing changes take effect.


 
allocatable_global_outbound_channels
integer
The total amount of allocatable global outbound channels available to the authenticated manager. Will be 0 if the feature is not enabled for their account.


 
record_type
string
The type of the data contained in this record.


 
total_global_channels_allocated
integer
The total number of allocatable global outbound channels currently allocated across all managed accounts for the authenticated user. This includes any amount of channels allocated by default at managed account creation time. Will be 0 if the feature is not enabled for their account.


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


403
Unauthorized response. Happens when the current user is not authorized to access the endpoint.


get/managed_accounts/allocatable_global_outbound_channels
Request samples 
Response samples 
application/json
{
  • "data": {
    • "allocatable_global_outbound_channels": 500,
    • "record_type": "allocatable_global_outbound_channels",
    • "total_global_channels_allocated": 135
    }
}
Retrieve a managed account
Retrieves the details of a single managed account.


SecuritybearerAuth 
Request 
path Parameters
id
required
string
Managed Account User ID


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


Response Schema: application/json
object (ManagedAccount) 
 
record_type
required
string
Identifies the type of the resource.


 Value: "managed_account"  
id
required
string <UUID> 
Uniquely identifies the managed account.


 
email
required
string <email> 
The managed account's email.


 
api_key
required
string
The managed account's V2 API access key


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


 
api_token
required
string
The managed account's V1 API token


 
organization_name
string
The organization the managed account is associated with.


 
manager_account_id
required
string
The ID of the manager account associated with the managed account.


 
object (ManagedAccountBalance) 
 
created_at
required
string
ISO 8601 formatted date indicating when the resource was created.


 
updated_at
required
string
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


get/managed_accounts/{id}
Request samples 
Response samples 
application/json
{
  • "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
    }
}
Update a managed account
Update a single managed account.


SecuritybearerAuth 
Request 
path Parameters
id
required
string
Managed Account User ID


 
Request Body schema: application/json
required
Parameters that define the updates to the managed account


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. This value may be changed, but there may be time lag between when the value is changed and pricing changes take effect.


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


Response Schema: application/json
object (ManagedAccount) 
 
record_type
required
string
Identifies the type of the resource.


 Value: "managed_account"  
id
required
string <UUID> 
Uniquely identifies the managed account.


 
email
required
string <email> 
The managed account's email.


 
api_key
required
string
The managed account's V2 API access key


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


 
api_token
required
string
The managed account's V1 API token


 
organization_name
string
The organization the managed account is associated with.


 
manager_account_id
required
string
The ID of the manager account associated with the managed account.


 
object (ManagedAccountBalance) 
 
created_at
required
string
ISO 8601 formatted date indicating when the resource was created.


 
updated_at
required
string
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.


Response Schema: application/json
Array of objects (UnprocessableEntityError) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
patch/managed_accounts/{id}
Request samples 
application/json
{
  • "managed_account_allow_custom_pricing": true
}
Response samples 
application/json
{
  • "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
    }
}
Update the amount of allocatable global outbound channels allocated to a specific managed account.
Update the amount of allocatable global outbound channels allocated to a specific managed account.


SecuritybearerAuth 
Request 
path Parameters
id
required
string
Managed Account User ID


 
Request Body schema: application/json
required
Parameters that define the changes to the global outbounds channels for the managed account


channel_limit
integer
Integer value that indicates the number of allocatable global outbound channels that should be allocated to the managed account. Must be 0 or more. If the value is 0 then the account will have no usable channels and will not be able to perform outbound calling.


 
Responses 
200
Successful response with information about the allocatable global outbound channels for the given account.


Response Schema: application/json
object (Global Outbound Channels Details for a Managed Account) 
 
channel_limit
integer
Integer value that indicates the number of allocatable global outbound channels that are allocated to the managed account. If the value is 0 then the account will have no usable channels and will not be able to perform outbound calling.


 
email
string
The email of the managed account.


 
id
string
The user ID of the managed account.


 
manager_account_id
string
The user ID of the manager of the account.


 
record_type
string
The name of the type of data in the response.


 
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.


Response Schema: application/json
Array of objects (UnprocessableEntityError) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
patch/managed_accounts/{id}/update_global_channel_limit
Request samples 
application/json
{
  • "channel_limit": 30
}
Response samples 
application/json
{
  • "data": {
    • "channel_limit": 30,
    • "email": "[email protected]",
    • "id": "096abcde-1122-3344-ab77-ff0123456789",
    • "manager_account_id": "beeabcde-1122-3344-ab77-ff0123456789",
    • "record_type": "managed_account_global_outbound_settings"
    }
}
Enables a managed account
Enables a managed account and its sub-users to use Telnyx services.


SecuritybearerAuth 
Request 
path Parameters
id
required
string
Managed Account User ID


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


Response Schema: application/json
object (ManagedAccount) 
 
record_type
required
string
Identifies the type of the resource.


 Value: "managed_account"  
id
required
string <UUID> 
Uniquely identifies the managed account.


 
email
required
string <email> 
The managed account's email.


 
api_key
required
string
The managed account's V2 API access key


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


 
api_token
required
string
The managed account's V1 API token


 
organization_name
string
The organization the managed account is associated with.


 
manager_account_id
required
string
The ID of the manager account associated with the managed account.


 
object (ManagedAccountBalance) 
 
created_at
required
string
ISO 8601 formatted date indicating when the resource was created.


 
updated_at
required
string
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.


Response Schema: application/json
Array of objects (UnprocessableEntityError) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
post/managed_accounts/{id}/actions/enable
Request samples 
Response samples 
application/json
{
  • "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
    }
}
Disables a managed account
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.


SecuritybearerAuth 
Request 
path Parameters
id
required
string
Managed Account User ID


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


Response Schema: application/json
object (ManagedAccount) 
 
record_type
required
string
Identifies the type of the resource.


 Value: "managed_account"  
id
required
string <UUID> 
Uniquely identifies the managed account.


 
email
required
string <email> 
The managed account's email.


 
api_key
required
string
The managed account's V2 API access key


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


 
api_token
required
string
The managed account's V1 API token


 
organization_name
string
The organization the managed account is associated with.


 
manager_account_id
required
string
The ID of the manager account associated with the managed account.


 
object (ManagedAccountBalance) 
 
created_at
required
string
ISO 8601 formatted date indicating when the resource was created.


 
updated_at
required
string
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.


Response Schema: application/json
Array of objects (UnprocessableEntityError) 
 
 Array 
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
post/managed_accounts/{id}/actions/disable
Request samples 
Response samples 
application/json
{
  • "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
    }
}