Create brand registrations

POST /v1/a2p/BrandRegistrations

A Messaging Service resource to add and fetch Brand Registrations.

Body

A2PProfileBundleSid string Required

A2P Messaging Profile Bundle Sid.

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BU[0-9a-fA-F]{32}$.
BrandType string

Type of brand being created. One of: "STANDARD", "STARTER". STARTER is for low volume, starter use cases. STANDARD is for all other use cases.
CustomerProfileBundleSid string Required

Customer Profile Bundle Sid.

Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BU[0-9a-fA-F]{32}$.
Mock boolean

A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided.
SkipAutomaticSecVet boolean

A flag to disable automatic secondary vetting for brands which it would otherwise be done.

Responses

201

Created
Hide response attributes Show response attributes object
- a2p_profile_bundle_sid string | null
  
  A2P Messaging Profile Bundle BundleSid
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BU[0-9a-fA-F]{32}$.
- account_sid string | null
  
  The SID of the Account that created the resource
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.
- brand_feedback array[string] | null
  
  Brand feedback
  
  Values are TAX_ID, STOCK_SYMBOL, NONPROFIT, GOVERNMENT_ENTITY, or OTHERS.
- brand_score integer | null
  
  Brand score
- brand_type string | null
  
  Type of brand. One of: "STANDARD", "STARTER".
- customer_profile_bundle_sid string | null
  
  A2P Messaging Profile Bundle BundleSid
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BU[0-9a-fA-F]{32}$.
- date_created string(date-time) | null
  
  The ISO 8601 date and time in GMT when the resource was created
- date_updated string(date-time) | null
  
  The ISO 8601 date and time in GMT when the resource was last updated
- failure_reason string | null
  
  A reason why brand registration has failed
- government_entity boolean | null
  
  Government Entity
- identity_status string | null
  
  Identity Status
  
  Values are SELF_DECLARED, UNVERIFIED, VERIFIED, or VETTED_VERIFIED.
- links object(uri-map) | null
- mock boolean | null
  
  A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided.
- russell_3000 boolean | null
  
  Russell 3000
- sid string | null
  
  A2P BrandRegistration Sid
  
  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BN[0-9a-fA-F]{32}$.
- skip_automatic_sec_vet boolean | null
  
  Skip Automatic Secondary Vetting
- status string | null
  
  Brand Registration status.
  
  Values are PENDING, APPROVED, FAILED, IN_REVIEW, or DELETED.
- tax_exempt_status string | null
  
  Tax Exempt Status
- tcr_id string | null
  
  Campaign Registry (TCR) Brand ID
- url string(uri) | null
  
  The absolute URL of the Brand Registration

POST /v1/a2p/BrandRegistrations

curl \
 -X POST https://messaging.twilio.com/v1/a2p/BrandRegistrations \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'A2PProfileBundleSid=string&BrandType=string&CustomerProfileBundleSid=string&Mock=true&SkipAutomaticSecVet=true'

Request example

{
  "A2PProfileBundleSid": "string",
  "BrandType": "string",
  "CustomerProfileBundleSid": "string",
  "Mock": true,
  "SkipAutomaticSecVet": true
}

Request examples

{
  "A2PProfileBundleSid": "string",
  "BrandType": "string",
  "CustomerProfileBundleSid": "string",
  "Mock": true,
  "SkipAutomaticSecVet": true
}

Response examples (201)

{
  "a2p_profile_bundle_sid": "string",
  "account_sid": "string",
  "brand_feedback": [
    "TAX_ID"
  ],
  "brand_score": 42,
  "brand_type": "string",
  "customer_profile_bundle_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "failure_reason": "string",
  "government_entity": true,
  "identity_status": "SELF_DECLARED",
  "links": {},
  "mock": true,
  "russell_3000": true,
  "sid": "string",
  "skip_automatic_sec_vet": true,
  "status": "PENDING",
  "tax_exempt_status": "string",
  "tcr_id": "string",
  "url": "https://example.com"
}

Response examples (201)

{
  "a2p_profile_bundle_sid": "string",
  "account_sid": "string",
  "brand_feedback": [
    "TAX_ID"
  ],
  "brand_score": 42,
  "brand_type": "string",
  "customer_profile_bundle_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "failure_reason": "string",
  "government_entity": true,
  "identity_status": "SELF_DECLARED",
  "links": {},
  "mock": true,
  "russell_3000": true,
  "sid": "string",
  "skip_automatic_sec_vet": true,
  "status": "PENDING",
  "tax_exempt_status": "string",
  "tcr_id": "string",
  "url": "https://example.com"
}