Patches an existing Brand in US with the request data.

Request

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.

Security

OAuth2(Required scopes: write)

Path

projectIdstringrequired

Customer's project id

brandIdstringrequired

Brand Id

Bodyapplication/jsonrequired

Brand object to be updated. The request body can include any subset of the fields required for the brand creation. Only the fields included in the request body with a non-null value will be updated, while the rest of the fields will remain unchanged. This method allows partial updates to the brand properties without the need to provide all the details as in the case of a full update. About attachments, the patch endpoint will not delete any existing attachments, and will include the new ones.

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)

entityTypestring

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.

Enum Value	Description
CORPORATION	A standard corporation (often a C Corp), a legal entity that is separate from its owners (shareholders). Choose this unless you are specifically registered as an S Corp.
LLC	Limited Liability Company. A business structure that combines the pass-through taxation of a partnership or sole proprietorship with the limited liability of a corporation.
PARTNERSHIP	A business owned and operated by two or more individuals or entities. Includes various types like General Partnerships (GP) and Limited Partnerships (LP).
S_CORPORATION	A special type of corporation that passes corporate income, losses, deductions, and credits through to its shareholders for federal tax purposes.

verticalTypestring

It is required for 10DLC, RCS

Enum Value	Description
PROFESSIONAL	Professional services firms such as law, accounting, consulting, staffing, and financial advisory.
REAL_ESTATE	Businesses involved in buying, selling, renting, or managing residential or commercial real estate.
HEALTHCARE	Hospitals, clinics, pharmacies, medical device manufacturers, and other health services providers.
HUMAN_RESOURCES	HR software, staffing agencies, payroll processors, and workforce management services.
ENERGY	Utilities, oil and gas companies, renewable energy producers, and energy services providers.
ENTERTAINMENT	Media, gaming, live events, streaming platforms, and entertainment content producers.
RETAIL	Brick-and-mortar or e-commerce retailers selling goods directly to consumers.
TRANSPORTATION	Logistics, freight carriers, ride-sharing services, airlines, and other transport providers.
AGRICULTURE	Farming, agribusiness, food production, and agricultural technology companies.
INSURANCE	Property, casualty, life, health, and specialty insurance carriers and brokers.
POSTAL	Postal services, courier companies, and parcel delivery providers.
EDUCATION	Schools, universities, e-learning platforms, tutoring services, and educational content providers.
HOSPITALITY	Hotels, restaurants, travel agencies, and other hospitality and tourism businesses.
FINANCIAL	Banks, credit unions, payment processors, investment firms, and other financial services.
POLITICAL	Political parties, campaigns, PACs, and other organizations engaged in political messaging.
GAMBLING	Casinos, online betting platforms, lottery operators, and other gaming and wagering services.
LEGAL	Law firms, legal technology providers, and other organizations delivering legal services.
CONSTRUCTION	General contractors, sub-contractors, engineering firms, and building materials suppliers.
NGO	Non-governmental and non-profit organizations with a charitable or humanitarian mission.
MANUFACTURING	Factories, industrial producers, and companies that fabricate or assemble physical goods.
GOVERNMENT	Federal, state, provincial, or local government agencies and public sector entities.
TECHNOLOGY	Software companies, hardware makers, IT services firms, and technology platform providers.
COMMUNICATION	Telecommunications carriers, internet service providers, and messaging platform operators.

programTypestring

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.

Enum Value	Description
STANDARD	A standard commercial program used by businesses for general messaging purposes, including marketing, customer service, and transactional notifications.
GOVERNMENT	A program operated by a federal, state, provincial, or local government entity or agency. Used for public service announcements, emergency alerts, and official government communications.
CHARITY	A program operated by a non-profit or charitable organization, typically a 501(c) entity, used for fundraising, donor outreach, and mission-related communications.
POLITICAL	A program used for political messaging, including campaigns, voter outreach, and political action committees (PACs). Subject to specific regulatory and compliance requirements.

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.

politicalTypestring

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.

Enum Value	Description
FEDERAL	For political campaigns at the national or federal level.
LOCAL	For political campaigns at the city, county, or municipal level.
STATE	For political campaigns at the state, provincial, or regional level.
TRIBAL	For tribal political campaigns.
OTHER	For any other type of political campaigns not listed above.

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.

governmentTypestring

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.

Enum Value	Description
FEDERAL	For agencies at the national or federal level.
LOCAL	For agencies at the city, county, or municipal level.
STATE	For agencies at the state, provincial, or regional level.
TRIBAL	For recognized tribal governments.
OTHER	For any other type of government agency not listed above. If selected, the governmentTypeOther field must be filled.

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.

scTypestring

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. When VANITY is selected, scText must be provided with the list of requested short codes.

Enum Value	Description
VANITY	Vanity Short Code
RANDOM	Random Short Code

scTextstring

Comma separated list of potential vanity short codes requested by the customer, in order of preference. Required when scType is VANITY. Optional otherwise for Short Code verification.

attachmentInputsArray of objects(AttachmentInput)

Attachments can be added by url or using the specified endpoint. Only the latest version of each attachment type is kept per Brand.

curl -i -X PATCH \
  'https://compliance.api.sinch.com/v1/projects/{projectId}/us/brands/{brandId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "My End Customer Brand Name",
    "legalCompanyName": "Alpha Adventures Corp.",
    "dba": "Alpha Adventures",
    "entityType": "CORPORATION",
    "verticalType": "PROFESSIONAL",
    "programType": "STANDARD",
    "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",
    "politicalType": "FEDERAL",
    "politicalUrl": "https://www.fec.gov/data/committee/C00123456/",
    "governmentWebsite": "https://www.fcc.gov",
    "governmentType": "FEDERAL",
    "governmentTypeOther": "International Port Authority Commission",
    "charitableAccreditation": "BBB Wise Giving Alliance",
    "scType": "VANITY",
    "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"
      }
    ]
  }'

Responses

Brand Content OK

Bodyapplication/json

brandIdstringread-onlyrequired

The unique identifier for the brand.

displayNamestringrequired

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

statusstring(BrandStatus)required

Brand status, it can be DRAFT, ACTIVE and ARCHIVED.

Enum Value	Description
DRAFT	The brand is in draft status. It can be updated and submitted for validation.
ACTIVE	The brand has at least one channel assigned.
ARCHIVED	The brand is archived after a cancellation. It can not be updated or submitted for validation.

contentProviderbooleanread-onlyrequired

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.

createTimestring, (date-time)read-onlyrequired

The date and time when the brand was created.

updateTimestring, (date-time)read-onlyrequired

The date and time when the brand was updated.

legalCompanyNamestring

Legal company name. Required for all product verification.

dbastring

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

entityTypestring

Enum Value	Description
CORPORATION	A standard corporation (often a C Corp), a legal entity that is separate from its owners (shareholders). Choose this unless you are specifically registered as an S Corp.
LLC	Limited Liability Company. A business structure that combines the pass-through taxation of a partnership or sole proprietorship with the limited liability of a corporation.
PARTNERSHIP	A business owned and operated by two or more individuals or entities. Includes various types like General Partnerships (GP) and Limited Partnerships (LP).
S_CORPORATION	A special type of corporation that passes corporate income, losses, deductions, and credits through to its shareholders for federal tax purposes.

verticalTypestring

It is required for 10DLC, RCS

Enum Value	Description
PROFESSIONAL	Professional services firms such as law, accounting, consulting, staffing, and financial advisory.
REAL_ESTATE	Businesses involved in buying, selling, renting, or managing residential or commercial real estate.
HEALTHCARE	Hospitals, clinics, pharmacies, medical device manufacturers, and other health services providers.
HUMAN_RESOURCES	HR software, staffing agencies, payroll processors, and workforce management services.
ENERGY	Utilities, oil and gas companies, renewable energy producers, and energy services providers.
ENTERTAINMENT	Media, gaming, live events, streaming platforms, and entertainment content producers.
RETAIL	Brick-and-mortar or e-commerce retailers selling goods directly to consumers.
TRANSPORTATION	Logistics, freight carriers, ride-sharing services, airlines, and other transport providers.
AGRICULTURE	Farming, agribusiness, food production, and agricultural technology companies.
INSURANCE	Property, casualty, life, health, and specialty insurance carriers and brokers.
POSTAL	Postal services, courier companies, and parcel delivery providers.
EDUCATION	Schools, universities, e-learning platforms, tutoring services, and educational content providers.
HOSPITALITY	Hotels, restaurants, travel agencies, and other hospitality and tourism businesses.
FINANCIAL	Banks, credit unions, payment processors, investment firms, and other financial services.
POLITICAL	Political parties, campaigns, PACs, and other organizations engaged in political messaging.
GAMBLING	Casinos, online betting platforms, lottery operators, and other gaming and wagering services.
LEGAL	Law firms, legal technology providers, and other organizations delivering legal services.
CONSTRUCTION	General contractors, sub-contractors, engineering firms, and building materials suppliers.
NGO	Non-governmental and non-profit organizations with a charitable or humanitarian mission.
MANUFACTURING	Factories, industrial producers, and companies that fabricate or assemble physical goods.
GOVERNMENT	Federal, state, provincial, or local government agencies and public sector entities.
TECHNOLOGY	Software companies, hardware makers, IT services firms, and technology platform providers.
COMMUNICATION	Telecommunications carriers, internet service providers, and messaging platform operators.

programTypestring

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.

Enum Value	Description
STANDARD	A standard commercial program used by businesses for general messaging purposes, including marketing, customer service, and transactional notifications.
GOVERNMENT	A program operated by a federal, state, provincial, or local government entity or agency. Used for public service announcements, emergency alerts, and official government communications.
CHARITY	A program operated by a non-profit or charitable organization, typically a 501(c) entity, used for fundraising, donor outreach, and mission-related communications.
POLITICAL	A program used for political messaging, including campaigns, voter outreach, and political action committees (PACs). Subject to specific regulatory and compliance requirements.

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)

politicalTypestring

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.

Enum Value	Description
FEDERAL	For political campaigns at the national or federal level.
LOCAL	For political campaigns at the city, county, or municipal level.
STATE	For political campaigns at the state, provincial, or regional level.
TRIBAL	For tribal political campaigns.
OTHER	For any other type of political campaigns not listed above.

politicalUrlstring

governmentWebsitestring

governmentTypestring

Enum Value	Description
FEDERAL	For agencies at the national or federal level.
LOCAL	For agencies at the city, county, or municipal level.
STATE	For agencies at the state, provincial, or regional level.
TRIBAL	For recognized tribal governments.
OTHER	For any other type of government agency not listed above. If selected, the governmentTypeOther field must be filled.

governmentTypeOtherstring

charitableAccreditationstring

scTypestring

Enum Value	Description
VANITY	Vanity Short Code
RANDOM	Random Short Code

scTextstring

Comma separated list of potential vanity short codes requested by the customer, in order of preference. Required when scType is VANITY. Optional otherwise for Short Code verification.

attachmentsArray of objects(Attachment)read-only

Files attached to this brand

logsArray of objects(BrandLog)read-only

Detailed history of the status changes this brand went through

channelsArray of stringsread-only

Channels available for this Brand

Response

{
  "brandId": "b1c7ccbf-919d-462f-8587-dec95a1b11ee",
  "displayName": "Alpha Adventures Corp.",
  "status": "DRAFT",
  "legalCompanyName": "Alpha Adventures Corp.",
  "entityType": "CORPORATION",
  "verticalType": "RETAIL",
  "country": "US",
  "street": "129 MacDougal Street, Manhattan",
  "city": "New York",
  "state": "New York",
  "zip": "10012",
  "taxCountry": "US",
  "federalTaxId": "123456789",
  "website": "https://www.alphaadventures.com",
  "companyEmail": "contact@alphaadventures.com",
  "contactEmail": "contact@alphaadventures.com",
  "contentProvider": false,
  "channels": [],
  "attachments": [],
  "logs": [],
  "createTime": "2024-01-15T10:00:00Z",
  "updateTime": "2024-01-15T10:00:00Z"
}

We'd love to hear from you!