AGagentphone
registration

Update A2P Registration

Changed on

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

  • Base URL
    https://api.agentphone.ai
  • URL
    https://api.agentphone.ai/v1/register
  • Auth
    HTTP bearer

Request body

first_namestring nullable

Contact first name.

last_namestring nullable

Contact last name.

emailstring nullable

Contact email address.

phone_numberstring nullable

E.164 format, e.g. +15551234567

business_namestring nullable

Legal/registered business name.

brand_namestring nullable

Public-facing brand name if different from business_name.

organization_type'sole_proprietor' | 'private_corporation' | 'public_corporation' | 'llc' | 'partnership' | 'non_profit' | 'co_op' | 'government'
contact_title'ceo' | 'cfo' | 'cto' | 'coo' | 'vp' | 'gm' | 'director' | 'other'
contact_title_otherstring nullable

Custom title when contact_title is 'other'.

einstring nullable

EIN / Tax ID.

website_urlstring nullable
industrystring nullable

e.g. technology, real_estate, retail, healthcare

business_regionsstring[] nullable

e.g. ['usa_and_canada']

street_addressstring nullable

Street address line 1.

street_address_2string nullable

Street address line 2 (suite, unit, etc.).

citystring nullable

City.

statestring nullable

State/region code.

zip_codestring nullable

Postal/ZIP code.

countrystring nullable

Country code, e.g. US.

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).

Changes

  • 344aa757057eRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • 3b532aaaf51cRevision changes
    • info

      endpoint added