Buy a number

POSThttps://api.trillet.ai/partner/v1/tenants/{tenantId}/numbers

Buys a number for the tenant, billed to your partner account at the standard Trillet number price. The first month is charged when you buy, then the number renews monthly. Find numbers first with GET /v1/api/twilio/available-numbers and the tenant ID in x-workspace-id. Needs numbers:write. Idempotency-Key is required.

Loading code example

Loading code example

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tenantIdstringrequired

The tenant ID.

Pattern: ^[a-fA-F0-9]{24}$

Header Parameters

Idempotency-Keystringrequired

1 to 255 printable ASCII characters, no spaces. A retry with the same key and request returns the stored response for 24 hours instead of running again.

Length: >= 1, <= 255

Body

phoneNumberstringrequired

E.164 format.

Pattern: ^\+[1-9]\d{6,14}$

countrystringrequired

Two-letter country code.

Length: >= 2, <= 2

type"local" | "mobile"

Allowed values: "local" | "mobile"

Default: "local"

addressSidstring

Regulatory address, for countries that need one.

Length: <= 64

bundleSidstring

Regulatory bundle, for countries that need one.

Length: <= 64

Response

application/json

The number.

objectstringrequired

idstringrequired

Use it as phoneNumberId when binding the number to an agent.

Pattern: ^[a-fA-F0-9]{24}$

tenantIdstringrequired

Pattern: ^[a-fA-F0-9]{24}$

phoneNumberstringrequired

E.164 format.

providerstring | null

typestring | null

externalbooleanrequired

true for numbers you registered yourself.

statusstring | null

agentIdstring | null

callFlowIdstring | null

billingany

Present for numbers bought through Trillet OEM, null for your own numbers.

createdAtstring | null<date-time>