Latest Legacy

Register a starter brand

This API lets you register a starter brand using a pre-existing profile.

API Endpoint

POST https://api.plivo.com/v1/Account/{auth_id}/10dlc/Brand/

Arguments

brand_aliasstring

A friendly name for your brand.

profile_uuidstringrequired

A unique identifier for the profile that you want to use for creating a brand. The profile should not have been used to create another brand.

brand_typestringrequired

Indicates the type of registration.
Use STARTER for starter registration.

mobile_phonestringrequired

A US or Canadian mobile number which will be used to verify the brand.

url string

The fully qualified URL to which status update callbacks for the message should be sent.

method string

The HTTP method to be used when calling the URL defined above.

Allowed values: GET,POST
Defaults to POST

Response

{
   "api_id":"bc842da0-bbc4-11ec-9f72-0242ac110002",
   "brand_id":"BXXXXXX",
   "message":"Request to create brand was received and is being processed."
}

1
2
3
4
5
6
7
8
9
10

let plivo = require('plivo');
 let fs = require('fs'); 
let client = new plivo.Client("<auth_id>", "<auth_token>"); 
var callback = {"url":"<URL>", "method":"POST"} client.brand.create("<brand_alias>","4364774f-095d-4bc8-a85f-cb53907951XX","STARTER",param = {"mobile_phone" : "+1122334455"},callback)
 .then(function (response) {
 console.log(JSON.stringify(response));
 }).catch(function (error) {
 console.log("err"); 
console.log(error);
 });

1
2
3
4
5
6
7
8
9

curl -i --user auth_id:auth_token \
-H "Content-Type: application/json" \
-d  '{
"brand_alias": "<brand_alias>",
"profile_uuid": "<profile_uuid>",
"brand_type": "STARTER",
"mobile_phone": "+1122334455"
}'\
https://api.plivo.com/v1/Account/<auth_id>/10dlc/Brand/