Register a standard brand

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

    API Endpoint

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

    Arguments

    profile_uuidstringRequiredUnique identifier for the profile that you want to use for creating a brand. The profile should not have been used to create another brand in the past.
    brand_aliasstringRequiredA friendly name for the brand.
    brand_typestring

    Indicate type of registration. Allowed values: STANDARD & STARTER.

    STANDARD not allowed for profiles not containing an EIN. Defaults to STARTER.

    secondary_vettingboolean

    Allowed values: true & false. Only applicable for STANDARD registration. Defaults to true.

    Plivo strongly recommends opting for vetting to get highest throughput enabled for your brands & campaigns.

    urlstringSet this parameter to the fully qualified URL to which status update callbacks for the message should be sent.
    methodstring

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

    Allowed values: GET, POST

    Defaults to POST

    Returns

    api_id for the request, unique brand_id and success message

    Response

    HTTP Status Code: 200

    {
       "api_id": "43751b36-bbc4-11ec-9f72-0242ac110002",
       "brand_id": "BCDEF1G",
       "message": "Request to create brand was received and is being processed."
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    
    // Available in versions >= 4.30.0 (https://github.com/plivo/plivo-node/releases/tag/v4.30.0)
    
    let plivo = require('plivo');
    
    let client = new plivo.Client("<auth_id>", "<auth_token>");
    var callback = {"url":"https://foo.com/tendlc_status/", "method":"POST"}
    
    client.brand.create("govt", "<profile_uuid>", "STANDARD", true, 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
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    
    <?php
    
    # Available in versions >= 4.29.0 (https://github.com/plivo/plivo-php/releases/tag/v4.29.0)
    
    require '/etc/plivo-php/vendor/autoload.php';
    use Plivo\RestClient;
    $client = new RestClient("<auth_id>", "<auth_token>");
    $client
        ->client
        ->setTimeout(60);
    try
    {
        $callback = array("url"=>"https://foo.com/tendlc_status/", "method"=>"POST");
        $res = $client
            ->brand
            ->create("govt321", "<profile_uuid>", "STANDARD", true, $callback);
        print_r($res);
    }
    catch(PlivoRestException $ex)
    {
        print_r($ex);
    }
    ?>
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    
    // Available in versions >= 5.9.0 (https://github.com/plivo/plivo-dotnet/releases/tag/v5.9.0)
    
    using System;
    using System.Collections.Generic;
    using Plivo;
    using Plivo.Exception;
    
    namespace dotnet_project
    {
        class Ten_dlc
        {
            static void Main(string[] args)
            {
     
                    var api = new PlivoApi("<auth_id>","<auth_token>");
    
                    // Create Brand
                try
                {
                    var response = api.Brand.Create("brand_001", "201faedc-7df9-4840-9ab1-3997ce3f7cf4", "STANDARD", true, "https://foo.com/tendlc_status/", "POST");
                    Console.WriteLine(response);
                }
                catch (PlivoRestException e)
                {
                        Console.WriteLine("Exception: " + e.Message);
                }
    
                    
            }
        }
    }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    
    curl -i --user auth_id:auth_token \
        -H "Content-Type: application/json" \
        -d '{
                "brand_alias": "gov234t",
                "profile_uuid": "d61eaaaa-18b1-4473-8810-0b9d80573aa9",
                "brand_type":"STANDARD",
                "secondary_vetting":true,
                "url": "https://foo.com/tendlc_status/",
                "method": "POST"
            }' \
            https://api.plivo.com/v1/Account/{auth_id}/10dlc/Brand/