Sign in
latestOpenAPI 3.1.0MIT2026-08-102135157.7 KB

fcc788f31a0a

brands

Patches an existing Brand in US with the request data.

Patches an existing brand. Fields omitted from the request body are unchanged. Fields set to null are treated as an explicit request to clear the field; if a field does not support clearing, the request will fail with 400.

patch/v1/projects/{projectId}/us/brands/{brandId}

Path parameters

projectIdstring required

Customer's project id

brandIdstring required

Brand Id

Request body

displayNamestring

The name of the brand. DisplayName must be unique per projectId and marketCode (US)

legalCompanyNamestring

Legal company name. Required for all product verification.

dbastring

Doing Business As. Optional for Short Code verification (not necessary for RCS/10DLC)

entityType'CORPORATION' | 'LLC' | 'PARTNERSHIP' | 'S_CORPORATION'

Specifies the legal structure of the business or organization being registered. This is a critical field that affects compliance requirements, verification processes, and the availability of certain products. Required for all product verification.

verticalType'PROFESSIONAL' | 'REAL_ESTATE' | 'HEALTHCARE' | 'HUMAN_RESOURCES' | 'ENERGY' | 'ENTERTAINMENT' | 'RETAIL' | 'TRANSPORTATION' | 'AGRICULTURE' | 'INSURANCE' | 'POSTAL' | 'EDUCATION' | 'HOSPITALITY' | 'FINANCIAL' | 'POLITICAL' | 'GAMBLING' | 'LEGAL' | 'CONSTRUCTION' | 'NGO' | 'MANUFACTURING' | 'GOVERNMENT' | 'TECHNOLOGY' | 'COMMUNICATION'

It is required for 10DLC, RCS

programType'STANDARD' | 'GOVERNMENT' | 'CHARITY' | 'POLITICAL'

Specifies the type of messaging program associated with the brand. This field helps classify the intended use case and may affect compliance requirements and carrier routing.

registrationCountrystring

Country of registration, 2 letters country ISO Code. Required for Short Code product verification.

registrationStatestring

State of registration. Required for Short Code product verification.

stockMarketSymbolstring

Stock market symbol. Optional for all product verification processes.

exchangestring

Where the stock market is set. Optional for 10DLC and RCS.

websitestring

Company website. Required for all product verification processes. It must have valid url format.

companyEmailstring

Company email account. Required for 10DLC, RCS. It must have valid email format. Contains PII Data.

estimatedAnnualRevenuestring

Optional for Short Code product verification.

countrystring

Country of brand address, 2 letters country ISO Code. Required for all product verification processes.

streetstring

brand street address. Required for all product verification processes. Contains PII Data.

street2string

brand street 2 address. Optional for Short Code product verification. Contains PII Data.

citystring

brand city address. Required for all product verification processes. Contains PII Data.

statestring

brand state address. Required for all product verification processes. Contains PII Data.

stateCodestring

brand state code address. Required for Short Code product verification. Contains PII Data.

zipstring

brand zip code address. Required for all product verification processes. Contains PII Data.

taxCountrystring

Tax country, 2 letters country ISO Code. Required for 10DLC, RCS.

federalTaxIdstring

If US, EIN must be provided. If not, VAT ID. Required for all product verification processes.

dunsstring

Optional for all product verification processes.

giinstring

Optional for all product verification processes.

leistring

Optional for all product verification processes.

firstNamestring

Required for Short Code product verification. Contains PII Data.

lastNamestring

Required for Short Code product verification. Contains PII Data.

phoneNumberstring

Required for Short Code product verification. Contains PII Data. Must be in E.164 format (e.g. +19176393200).

phoneNumberExtensionstring

Optional for Short Code product verification

mobilePhoneNumberstring

Required for sending OTP request in 10DLC Sole Proprietor registration process. It must be a US/CA number.

contactEmailstring

It is required for all product verification processes. It must have valid email format. Contains PII Data.

politicalTokenstring password

A required authorization token for political campaigns sending messages in the US. This token is issued by Campaign Verify and serves as a credential to verify the legitimacy of a political committee (e.g., candidate, party, or PAC). Mandatory for Short Code verification when Political program type.

politicalType'FEDERAL' | 'LOCAL' | 'TRIBAL' | 'STATE' | 'OTHER'

The classification of the political campaign. This is crucial for determining the specific compliance requirements that apply. Mandatory for Short Code verification when Political program type.

politicalUrlstring

A URL or other reference number that links to official political filing records. This information serves as verifiable proof of the campaign's registration with a relevant government body (like the FEC in the US). Mandatory for Short Code verification when Political program type.

governmentWebsitestring

The official website URL for the government agency. The URL must be a valid, active, and secure (HTTPS) link to a government-owned domain (e.g., .gov, .gov.uk, .gc.ca, etc.). This information is used for verification purposes. Mandatory for Short Code verification when Government program type.

governmentType'FEDERAL' | 'LOCAL' | 'TRIBAL' | 'STATE' | 'OTHER'

Specifies the type of government agency. This helps categorize the entity for compliance and routing purposes. Select the most appropriate value from the accepted list. This field is mandatory for Short Code verification when Government program type.

governmentTypeOtherstring

A free-text field to provide details if OTHER is selected in the governmentType field. This field is required and should be used only when none of the predefined agency types apply, only for Short Code verification when Government program type.

charitableAccreditationstring

The name of the organization that has accredited the charitable entity. This is used to verify the non-profit status and legitimacy of the organization. This field is mandatory for Short Code verification when Charity program type.

scType'VANITY' | 'RANDOM'

Short Code type. It is required for Short Code product verification US_SC_REGISTRY and it determines the type of Short Code that will be requested in the order. Vanity Short Codes are custom and can be chosen by the customer, while Random Short Codes are assigned by the provider without customer input.

scTextstring

Field to explain the short code request. Optional for Short Code verification.

Example request

{
  "displayName": "My End Customer Brand Name",
  "legalCompanyName": "Alpha Adventures Corp.",
  "dba": "Alpha Adventures",
  "registrationCountry": "US",
  "registrationState": "California",
  "stockMarketSymbol": "SINCH",
  "exchange": "NASDAQ",
  "website": "https://www.sinch.com",
  "companyEmail": "john.doe@sinch.com",
  "estimatedAnnualRevenue": "100K-1M USD",
  "country": "US",
  "street": "129 MacDougal Street, Manhattan",
  "street2": "D, 7th floor",
  "city": "New York",
  "state": "New York",
  "stateCode": "NY",
  "zip": "10012",
  "taxCountry": "US",
  "federalTaxId": "123456789",
  "duns": "123456789",
  "giin": "ABC9EF.A23FF.US.724",
  "lei": "549300L4R7HSB20U5D88",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+19176393200",
  "phoneNumberExtension": "343",
  "mobilePhoneNumber": "+12015550143",
  "contactEmail": "john.doe@sinch.com",
  "politicalToken": "cv_a1b2c3d4e5f67890a1b2c3d4e5f67890",
  "politicalUrl": "https://www.fec.gov/data/committee/C00123456/",
  "governmentWebsite": "https://www.fcc.gov",
  "governmentTypeOther": "International Port Authority Commission",
  "charitableAccreditation": "BBB Wise Giving Alliance",
  "scText": "We need 11111, if not available please provide SINCH",
  "attachmentInputs": [
    {
      "fileName": "sender_id_registration_form.docx",
      "attachmentType": "COMPANY_BANNER",
      "fileUrl": "https://www.files.com/myfile.png"
    }
  ]
}

Response

Brand Content OK

displayNamestring required

The name of the brand. DisplayName must be unique per projectId and marketCode (US)

legalCompanyNamestring

Legal company name. Required for all product verification.

dbastring

Doing Business As. Optional for Short Code verification (not necessary for RCS/10DLC)

entityType'CORPORATION' | 'LLC' | 'PARTNERSHIP' | 'S_CORPORATION'

Specifies the legal structure of the business or organization being registered. This is a critical field that affects compliance requirements, verification processes, and the availability of certain products. Required for all product verification.

verticalType'PROFESSIONAL' | 'REAL_ESTATE' | 'HEALTHCARE' | 'HUMAN_RESOURCES' | 'ENERGY' | 'ENTERTAINMENT' | 'RETAIL' | 'TRANSPORTATION' | 'AGRICULTURE' | 'INSURANCE' | 'POSTAL' | 'EDUCATION' | 'HOSPITALITY' | 'FINANCIAL' | 'POLITICAL' | 'GAMBLING' | 'LEGAL' | 'CONSTRUCTION' | 'NGO' | 'MANUFACTURING' | 'GOVERNMENT' | 'TECHNOLOGY' | 'COMMUNICATION'

It is required for 10DLC, RCS

programType'STANDARD' | 'GOVERNMENT' | 'CHARITY' | 'POLITICAL'

Specifies the type of messaging program associated with the brand. This field helps classify the intended use case and may affect compliance requirements and carrier routing.

registrationCountrystring

Country of registration, 2 letters country ISO Code. Required for Short Code product verification.

registrationStatestring

State of registration. Required for Short Code product verification.

stockMarketSymbolstring

Stock market symbol. Optional for all product verification processes.

exchangestring

Where the stock market is set. Optional for 10DLC and RCS.

websitestring

Company website. Required for all product verification processes. It must have valid url format.

companyEmailstring

Company email account. Required for 10DLC, RCS. It must have valid email format. Contains PII Data.

estimatedAnnualRevenuestring

Optional for Short Code product verification.

countrystring

Country of brand address, 2 letters country ISO Code. Required for all product verification processes.

streetstring

brand street address. Required for all product verification processes. Contains PII Data.

street2string

brand street 2 address. Optional for Short Code product verification. Contains PII Data.

citystring

brand city address. Required for all product verification processes. Contains PII Data.

statestring

brand state address. Required for all product verification processes. Contains PII Data.

stateCodestring

brand state code address. Required for Short Code product verification. Contains PII Data.

zipstring

brand zip code address. Required for all product verification processes. Contains PII Data.

taxCountrystring

Tax country, 2 letters country ISO Code. Required for 10DLC, RCS.

federalTaxIdstring

If US, EIN must be provided. If not, VAT ID. Required for all product verification processes.

dunsstring

Optional for all product verification processes.

giinstring

Optional for all product verification processes.

leistring

Optional for all product verification processes.

firstNamestring

Required for Short Code product verification. Contains PII Data.

lastNamestring

Required for Short Code product verification. Contains PII Data.

phoneNumberstring

Required for Short Code product verification. Contains PII Data. Must be in E.164 format (e.g. +19176393200).

phoneNumberExtensionstring

Optional for Short Code product verification

mobilePhoneNumberstring

Required for sending OTP request in 10DLC Sole Proprietor registration process. It must be a US/CA number.

contactEmailstring

It is required for all product verification processes. It must have valid email format. Contains PII Data.

politicalTokenstring password

A required authorization token for political campaigns sending messages in the US. This token is issued by Campaign Verify and serves as a credential to verify the legitimacy of a political committee (e.g., candidate, party, or PAC). Mandatory for Short Code verification when Political program type.

politicalType'FEDERAL' | 'LOCAL' | 'TRIBAL' | 'STATE' | 'OTHER'

The classification of the political campaign. This is crucial for determining the specific compliance requirements that apply. Mandatory for Short Code verification when Political program type.

politicalUrlstring

A URL or other reference number that links to official political filing records. This information serves as verifiable proof of the campaign's registration with a relevant government body (like the FEC in the US). Mandatory for Short Code verification when Political program type.

governmentWebsitestring

The official website URL for the government agency. The URL must be a valid, active, and secure (HTTPS) link to a government-owned domain (e.g., .gov, .gov.uk, .gc.ca, etc.). This information is used for verification purposes. Mandatory for Short Code verification when Government program type.

governmentType'FEDERAL' | 'LOCAL' | 'TRIBAL' | 'STATE' | 'OTHER'

Specifies the type of government agency. This helps categorize the entity for compliance and routing purposes. Select the most appropriate value from the accepted list. This field is mandatory for Short Code verification when Government program type.

governmentTypeOtherstring

A free-text field to provide details if OTHER is selected in the governmentType field. This field is required and should be used only when none of the predefined agency types apply, only for Short Code verification when Government program type.

charitableAccreditationstring

The name of the organization that has accredited the charitable entity. This is used to verify the non-profit status and legitimacy of the organization. This field is mandatory for Short Code verification when Charity program type.

scType'VANITY' | 'RANDOM'

Short Code type. It is required for Short Code product verification US_SC_REGISTRY and it determines the type of Short Code that will be requested in the order. Vanity Short Codes are custom and can be chosen by the customer, while Random Short Codes are assigned by the provider without customer input.

scTextstring

Field to explain the short code request. Optional for Short Code verification.

brandIdstring required

The unique identifier for the brand.

status'DRAFT' | 'ACTIVE' | 'ARCHIVED' required

Brand status represents the current state of the brand in the system. It is determined by the status of the brand orders and the channels assigned to the brand. The status can be DRAFT when the brand is being created or updated, ACTIVE when the brand has at least one channel assigned and it is ready to be used, or ARCHIVED when the brand has been cancelled and it can not be used anymore.

contentProviderboolean required

Indicates whether the brand is a Content Provider (true) or a standard Brand (false). This choice determines the types of orders that can be requested, as they follow different registration processes and are available for different products. It cannot be updated after the brand creation.

channelsChannel[]

Channels available for this Brand

createTimestring date-time required

The date and time when the brand was created.

updateTimestring date-time required

The date and time when the brand was updated.

Example response

{
  "displayName": "My End Customer Brand Name",
  "legalCompanyName": "Alpha Adventures Corp.",
  "dba": "Alpha Adventures",
  "registrationCountry": "US",
  "registrationState": "California",
  "stockMarketSymbol": "SINCH",
  "exchange": "NASDAQ",
  "website": "https://www.sinch.com",
  "companyEmail": "john.doe@sinch.com",
  "estimatedAnnualRevenue": "100K-1M USD",
  "country": "US",
  "street": "129 MacDougal Street, Manhattan",
  "street2": "D, 7th floor",
  "city": "New York",
  "state": "New York",
  "stateCode": "NY",
  "zip": "10012",
  "taxCountry": "US",
  "federalTaxId": "123456789",
  "duns": "123456789",
  "giin": "ABC9EF.A23FF.US.724",
  "lei": "549300L4R7HSB20U5D88",
  "firstName": "John",
  "lastName": "Doe",
  "phoneNumber": "+19176393200",
  "phoneNumberExtension": "343",
  "mobilePhoneNumber": "+12015550143",
  "contactEmail": "john.doe@sinch.com",
  "politicalToken": "cv_a1b2c3d4e5f67890a1b2c3d4e5f67890",
  "politicalUrl": "https://www.fec.gov/data/committee/C00123456/",
  "governmentWebsite": "https://www.fcc.gov",
  "governmentTypeOther": "International Port Authority Commission",
  "charitableAccreditation": "BBB Wise Giving Alliance",
  "scText": "We need 11111, if not available please provide SINCH",
  "brandId": "1234567890",
  "status": "ACTIVE",
  "contentProvider": true,
  "attachments": [
    {
      "attachmentId": "d1c7ccbf-919d-462f-8587-dec95a1b11ee",
      "fileName": "sender_id_registration_form.docx",
      "attachmentType": "COMPANY_BANNER",
      "mimeType": "application/pdf",
      "uploadStatus": "COMPLETED",
      "createTime": "2021-11-03T14:30:03Z",
      "updateTime": "2021-11-03T14:30:03Z"
    }
  ],
  "logs": [
    {
      "createTime": "2021-11-03T14:30:03Z",
      "message": "Please update the attachment connected to your request.",
      "brandCurrentState": "ACTIVE"
    }
  ],
  "channels": [
    "RCS"
  ],
  "createTime": "2023-10-01T12:00:00Z",
  "updateTime": "2023-10-01T12:00:00Z"
}