Skip to main content
PATCH
JavaScript

Authorizations

Authorization
string
header
required

Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.

Path Parameters

dir_id
string<uuid>
required

The DIR id. Lowercase UUID.

Example:

"16635d38-75a6-4481-82e8-69af60e05011"

Body

application/json

All fields are optional; only those supplied are updated. Same per-field rules as DirCreateRequest.

display_name
string

Name shown to call recipients. 1–35 characters, no emoji, not whitespace-only.

Required string length: 1 - 35
reselling
boolean

Set to true if your organization places calls on behalf of other enterprises (BPO/reseller). Updating this triggers re-vetting on next submit.

authorizer_name
string

Name of the person at your enterprise authorizing this DIR. Must be a real individual.

Maximum string length: 255
authorizer_email
string<email>

Contact email of the authorizer. Telnyx may send verification or infringement notices here.

logo_url
string<uri>

Publicly accessible HTTPS URL (max 128 chars) to a 256x256 BMP logo (max 1 MB).

Maximum string length: 128
call_reasons
string[]

1–10 reasons your business calls customers. Validate phrasing against POST /call_reasons/validate.

Required array length: 1 - 10 elements
Maximum string length: 64
certify_brand_is_accurate
boolean

Certification that the DIR information is accurate. Must be true for the DIR to be submitted for vetting.

Example:

true

certify_no_shaft_content
boolean

Certification that this DIR is not used for SHAFT content (Sex, Hate, Alcohol, Firearms, Tobacco) where prohibited. Must be true for the DIR to be submitted for vetting.

Example:

true

certify_ip_ownership
boolean

Certification of ownership of any logos/trademarks shown. Must be true for the DIR to be submitted for vetting.

Example:

true

documents
object[]

Additional supporting documents to attach. Append-only: existing documents are never removed or replaced, and an empty or omitted list is a no-op. Each document_id may appear at most once on a DIR.

Maximum array length: 20
webhook_url
string<uri> | null

Optional https:// URL that receives webhook notifications when this DIR's compliance review completes. Send null to clear. Changing only this field on a verified DIR does not re-vet it. Maximum 2048 characters.

Maximum string length: 2048
Example:

"https://mapleridge.example.com/webhooks/branded-calling"

bpo_authorizations
object[]

Optional. Replace this DIR's authorized BPO (Business Process Outsourcer) accounts with these, each with its signed Letter of Authorization. The supplied list replaces the current one: a BPO left out has its authorization removed, and a new BPO (or a changed Letter of Authorization) is created pending admin review. Send an empty list to clear all authorizations; omit the field to leave them unchanged. Editing this list does not re-vet the DIR. Maximum 10.

Maximum array length: 10

Response

DIR updated.

data
object
required