Skip to content

Update an existing 10DLC brand registration. Business fields are editable before carrier submission; workflow status is managed by Pingram.

PATCH
/registrations/us/10dlc/brand
curl --request PATCH \
  --url https://api.pingram.io/registrations/us/10dlc/brand \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "scenarioId": "own_brand", "businessType": "PRIVATE_PROFIT", "legalName": "example", "displayName": "example", "firstName": "example", "lastName": "example", "taxId": "example", "website": "example", "country": "example", "street": "example", "city": "example", "state": "example", "postalCode": "example", "complianceContactEmail": "example", "complianceContactPhone": "example" }'

Authorizations

Request Bodyrequired

Media typeapplication/json

Request body for PATCH /registrations/us/10dlc/brand

object
scenarioId

Who the 10DLC brand is registered for.

  • own_brand: personal or company project
  • client_brand: agency or contractor
string
Allowed values: own_brand client_brand
businessType

Legal entity type for a 10DLC brand.

  • PRIVATE_PROFIT: private for-profit (LLC, corp, etc.)
  • SOLE_PROPRIETOR: sole proprietorship
  • PUBLIC_PROFIT: publicly traded for-profit
  • NON_PROFIT: non-profit
  • GOVERNMENT: government
string
Allowed values: PRIVATE_PROFIT SOLE_PROPRIETOR PUBLIC_PROFIT NON_PROFIT GOVERNMENT
legalName

Official registered legal business name. For SOLE_PROPRIETOR, optional DBA or trade name (defaults to firstName and lastName).

string
displayName

Public brand name shown to recipients and carriers. Use the name customers recognize (your DBA or trade name). For SOLE_PROPRIETOR, this is the brand you send as — not the individual’s legal name. Omit to keep the existing value. If you change legalName and omit displayName, displayName is reset to the new legalName.

string
firstName

Legal first name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.

string
lastName

Legal last name of the sole proprietor. Required when businessType is SOLE_PROPRIETOR.

string
taxId

For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Required except when businessType is SOLE_PROPRIETOR.

string
website

Public website for the brand. Include a scheme (https://) or a domain; https:// is prepended when omitted. Carriers expect a working site with privacy policy and terms.

string
country

ISO 3166-1 alpha-2 country of incorporation (for example US or CA).

string
street

Street address that matches official tax registration.

string
city

City that matches official tax registration.

string
state

State (US) or province (CA) that matches official tax registration.

string
postalCode

ZIP code (US) or postal code (CA) that matches official tax registration.

string
complianceContactEmail

Email for the 10DLC compliance contact. Used for carrier and registration follow-up.

string
complianceContactPhone

Phone number for the 10DLC compliance contact. E.164 preferred; national numbers are normalized using country.

string

Responses

200

Successful response

Media typeapplication/json

Public response type for 10DLC brand registration

object
accountId
required
string
scenarioId
required
string
businessType
required
string
legalName
required

Official registered legal business name. For SOLE_PROPRIETOR, may be a DBA or trade name.

string
displayName

Public brand name shown to recipients and carriers.

string
firstName

Legal first name of the sole proprietor. Present when businessType is SOLE_PROPRIETOR.

string
lastName

Legal last name of the sole proprietor. Present when businessType is SOLE_PROPRIETOR.

string
taxId

For US companies (country US): 9-digit EIN (Employer Identification Number). For Canada (country CA): 9-digit BN (Business Number). For other countries: national business tax identifier. Omitted when businessType is SOLE_PROPRIETOR.

string
website
required

Public website for the brand.

string
country
required

ISO 3166-1 alpha-2 country of incorporation (for example US or CA).

string
street

Street address that matches official tax registration.

string
city

City that matches official tax registration.

string
state

State (US) or province (CA) that matches official tax registration.

string
postalCode

ZIP code (US) or postal code (CA) that matches official tax registration.

string
fullAddress

Legacy records only; new submissions use structured address fields.

string
complianceContactEmail
required

Email for the 10DLC compliance contact.

string
complianceContactPhone
required

Phone number for the 10DLC compliance contact.

string
brandStatus
required

Pingram-side 10DLC registration workflow status (brand or campaign).

  • not_started: no customer submission yet
  • pending_review: customer submitted; Pingram has not submitted to carriers
  • in_progress: submitted for carrier review
  • approved | rejected | info_needed: review outcome
string
Allowed values: not_started in_progress pending_review approved rejected info_needed
campaignStatus
required

Pingram-side 10DLC registration workflow status (brand or campaign).

  • not_started: no customer submission yet
  • pending_review: customer submitted; Pingram has not submitted to carriers
  • in_progress: submitted for carrier review
  • approved | rejected | info_needed: review outcome
string
Allowed values: not_started in_progress pending_review approved rejected info_needed
createdAt
required
string
updatedAt
required
string
Example
{
  "brandStatus": "not_started",
  "campaignStatus": "not_started"
}

400

Bad Request - validation errors, invalid input

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

401

Unauthorized

402

Payment Required - usage limits exceeded

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

500

Internal Server Error

502

Bad Gateway - provider error

Media typeapplication/json

Standard error response for API errors.

object
trackingId
required

Unique tracking ID for the request.

string
error
required

Structured error details for API error responses.

object
code
required

Machine-readable error code.

string
message
required

Human-readable error message.

string
fix

Actionable hint for fixing the error.

string
Examplegenerated
{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}