10DLC

Update a 10DLC Brand

Changed on

Updates the 10DLC Brand identified by brand_id. Changing identity fields, including ein_taxid, ein_taxid_country, and entity_type, resets the Brand status to UNVERIFIED and triggers automatic re-submission. Brands in VETTED_VERIFIED status or with active Campaigns cannot be updated.

put/v3/10dlc/brands/{brand_id}

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v3/10dlc/brands/{brand_id}
  • Auth
    HTTP bearer

Path parameters

brand_idstring required
Example:BM20QP9

The unique ID of the 10DLC Brand.

Request body

dba_namestring

Brand name or DBA

company_namestring

Legal name of the company

entity_type'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT'

Legal entity type of the company. One of PRIVATE_PROFIT (privately held for-profit company), PUBLIC_PROFIT (publicly traded for-profit company), NON_PROFIT (non-profit organization), or GOVERNMENT (government entity).

vertical'HEALTHCARE' | 'PROFESSIONAL' | 'RETAIL' | 'TECHNOLOGY' | 'EDUCATION' | 'FINANCIAL' | 'NON_PROFIT' | 'GOVERNMENT' | 'OTHER'

Business segment the Brand operates in. One of:

  • HEALTHCARE — healthcare.
  • PROFESSIONAL — professional services.
  • RETAIL — retail.
  • TECHNOLOGY — technology.
  • EDUCATION — education.
  • FINANCIAL — financial services.
  • NON_PROFIT — non-profit organizations.
  • GOVERNMENT — government entities.
  • OTHER — any segment not listed above.
ein_taxidstring

IRS Employee Identification Number (EIN) for US-based or foreign companies with EIN. The numeric portion of Tax ID for companies incorporated in other countries.

ein_taxid_countrystring

2-letter ISO country code of the Tax ID issuing country

websitestring

The website of the business

stock_symbolstring nullable

The stock symbol of the Brand. For PUBLIC_PROFIT Brands only.

stock_exchangestring nullable

The stock exchange code. For PUBLIC_PROFIT Brands only.

first_namestring

The first name of the business contact

last_namestring

The last name of the business contact

phone_numberstring

The support contact telephone in E.164 format

emailstring email

The email address of the support contact

street_addressstring

Street name and house number

citystring

The city name

state_or_provincestring nullable

State or province. For the United States, it is a 2-character code.

zipstring

The business zip or postal code

countrystring

2-letter ISO country code the business address

mockboolean

Mock flag for testing (optional, defaults to false)

Example request

{
  "dba_name": "Brand",
  "company_name": "Company",
  "entity_type": "PRIVATE_PROFIT",
  "vertical": "HEALTHCARE",
  "ein_taxid": "999999999",
  "ein_taxid_country": "US",
  "website": "https://brand.com",
  "first_name": "John",
  "last_name": "Dow",
  "phone_number": "12123450099",
  "email": "support@brand.com",
  "street_address": "10, City Name",
  "city": "Miami",
  "state_or_province": "FL",
  "zip": "12346",
  "country": "US"
}

Response

Returns the updated 10DLC Brand.

brand_idstring required

Unique identifier of the Brand assigned by the registry.

dba_namestring required

Doing-business-as name, or the public-facing brand name.

company_namestring required

Registered legal name of the company that owns the Brand.

entity_type'PRIVATE_PROFIT' | 'PUBLIC_PROFIT' | 'NON_PROFIT' | 'GOVERNMENT' required

Legal entity type of the 10DLC Brand. One of PRIVATE_PROFIT (privately held for-profit company), PUBLIC_PROFIT (publicly traded for-profit company), NON_PROFIT (non-profit organization), or GOVERNMENT (government entity).

verticalstring required

Industry vertical the Brand operates in.

ein_taxidstring required

IRS Employer Identification Number (EIN) or other tax ID of the company.

ein_taxid_countrystring required

ISO 3166-1 alpha-2 country code where the Tax ID was issued.

status'REVIEW' | 'VERIFIED' | 'UNVERIFIED' | 'VETTED_VERIFIED' | 'SUSPENDED' required

Identity verification status of the 10DLC Brand. One of:

  • REVIEW — verification is in progress.
  • VERIFIED — the Brand passed standard verification.
  • UNVERIFIED — verification has not succeeded.
  • VETTED_VERIFIED — the Brand also passed third-party vetting.
  • SUSPENDED — the Brand is blocked from sending.
websitestring nullable

Business website URL.

stock_symbolstring nullable

Stock ticker symbol of the company. Required for publicly traded companies.

stock_exchangestring nullable

Code of the stock exchange the company is listed on. Required for publicly traded companies.

first_namestring required

Business contact first name.

last_namestring required

Business contact last name.

phone_numberstring required

Support contact phone number in E.164 format.

emailstring required

Support contact email address.

street_addressstring required

Street address of the business.

citystring required

City of the business address.

state_or_provincestring nullable

State or province of the business address.

countrystring required

ISO 3166-1 alpha-2 country code of the business address.

zipstring required

ZIP or postal code of the business address.

feedbackstring nullable required

Feedback from the identity verification process explaining the current status.

mockboolean

Indicates whether the Brand is a mock brand for testing.

created_atstring required

Timestamp when the Brand was created, in ISO 8601 format.

updated_atstring required

Timestamp when the Brand was last updated, in ISO 8601 format.

Example response

{
  "brand_id": "BM20QP9",
  "city": "Miami",
  "company_name": "Company legal name",
  "country": "US",
  "created_at": "2024-07-24T08:10:49",
  "dba_name": "New Brand",
  "ein_taxid": "12345",
  "ein_taxid_country": "US",
  "email": "support@brand.com",
  "entity_type": "PRIVATE_PROFIT",
  "feedback": null,
  "first_name": "John",
  "last_name": "Dow",
  "mock": false,
  "phone_number": "12123450099",
  "state_or_province": "FL",
  "status": "VERIFIED",
  "stock_exchange": null,
  "stock_symbol": null,
  "street_address": "10, Street name",
  "updated_at": "2024-07-24T08:29:09",
  "vertical": "HEALTHCARE",
  "website": "https://brand.com",
  "zip": "12345"
}

Changes

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • warning

      added the new GOVERNMENT enum value to the response property for the response status

    • warning

      added the new NON_PROFIT enum value to the response property for the response status

    • warning

      added the new PRIVATE_PROFIT enum value to the response property for the response status

    • warning

      added the new PUBLIC_PROFIT enum value to the response property for the response status

    • warning

      added the new REVIEW enum value to the response property for the response status

    • warning

      added the new SUSPENDED enum value to the response property for the response status

    • warning

      added the new UNVERIFIED enum value to the response property for the response status

    • warning

      added the new VERIFIED enum value to the response property for the response status

    • warning

      added the new VETTED_VERIFIED enum value to the response property for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • info

      removed subschema #2 from the response property allOf list for the response status

    • breaking

      added the pattern ^B[A-Z0-9]{6}$ to the path request parameter brand_id

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status