3b532aaaf51c

latestOpenAPI 3.1.02026-08-148392235.7 KB

registration

Update A2P Registration

Update an existing A2P 10DLC registration.

Send only the fields that changed — everything is optional. There is no fee. Changes are applied after review, and your registration keeps sending under its current approval while an update to an approved registration is reviewed.

Registrations created with create_sub_account=true (the default) live on a sub-account; this resolves to it automatically when there's exactly one, or honors the X-Sub-Account-Id header.

patch/v1/register

Request body

business_namestring nullable

Legal/registered business name.

brand_namestring nullable

Public-facing brand name if different from business_name.

website_urlstring nullable

descriptionstring nullable

What your business does, who you message, and what types of messages you send. Min 40 chars.

use_casesUseCase[] nullable

1-5 specific use cases for your SMS campaign.

volume'low' | 'high'

message_samplesstring[] nullable

2-5 example messages. Each must be 20-1024 chars and include your brand name.

consent_flowstring nullable

How users opt in to receive messages. Min 40 chars.

privacy_policy_urlstring nullable

terms_of_service_urlstring nullable

opt_in_image_urlstring nullable

Publicly accessible URL to a screenshot of your opt-in flow (PNG, JPG, WEBP, or GIF, max 2MB)

includesCampaignInclude[] nullable

Content types included in messages.

link_samplestring nullable

Example URL if messages contain links.

Response

Successful Response

okboolean required

messagestring required

campaign_statusstring required

updated_fieldsstring[] required

sub_account_idstring nullable

Set when the update was applied to a registration on a sub-account of the calling account (the default for POST /v1/register).