API reference

Carrier accounts

Manage the customer accounts on your carrier — create them, set defaults, suspend or restore, and read their metadata.

Account resource

Accountjson

{
  "data": {
    "id": "AC…",
    "type": "account",
    "attributes": {
      "name": "Clover Logistics",
      "status": "active",
      "default_tts_voice": "alice",
      "metadata": { "onboarded": true },
      "created_at": "…"
    }
  }
}

Create an account

POST/carrier/v1/accounts

Parameter	Type	Description
`data.type` required	`string`	`account`
`data.attributes.name` required	`string`	Account name.
`data.attributes.default_tts_voice` optional	`string`	Default TTS voice.
`data.attributes.metadata` optional	`object`	Arbitrary key/value metadata.

Example

curlbash

curl -X POST "https://voice.ruut.chat/carrier/v1/accounts" \
  -H "Authorization: Bearer $CARRIER_API_KEY" -H "Content-Type: application/json" \
  -d '{
    "data": {
      "type": "account",
      "attributes": { "name": "Clover Logistics", "metadata": { "onboarded": true } }
    }
  }'

List accounts

GET/carrier/v1/accounts

Return all accounts on the carrier.

Fetch an account

GET/carrier/v1/accounts/{id}

Return a single account.

Update an account

PATCH/carrier/v1/accounts/{id}

Parameter	Type	Description
`data.type` required	`string`	`account`
`data.id` required	`string`	The account ID.
`data.attributes.name` optional	`string`	Account name.
`data.attributes.status` optional	`string`	`active` or `suspended`.
`data.attributes.default_tts_voice` optional	`string`	Default TTS voice.
`data.attributes.metadata` optional	`object`	Arbitrary key/value metadata.

Delete an account

DELETE/carrier/v1/accounts/{id}

Permanently delete the account and its resources. This cannot be undone.

Response — 200 OK (JSON:API).

Deleting an account removes its numbers, credentials, and call history. Consider suspending instead to preserve records.