Create Sender-ids

Create Sender-ids

Create sender-ids using post method under your account

API Endpoint




Name optional Descriptions
name No Enter the sender-id that you want to create
country_code No For which country this sender belongs to. 2 letters
service No The short code of the service name. ex: (MKT) full list
entity_id Mixed Input the entity id (required for india)
entity_name Mixed Company name whom this sender belongs to (required for india)

Example Request

var client = new RestClient("{endpoint}/api/v2/sms/senders");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer 7160f04c05870ee88812a435f65xxxxx");
var body = @"";
request.AddParameter("text/plain", body,  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer 7160f04c05870ee88812a435f65xxxxx");

var raw = "";

var requestOptions = { method: ‘GET’, headers: myHeaders, body: raw, redirect: ‘follow’ };

fetch("{endpoint}/api/v2/sms/senders", requestOptions) .then(response => response.text()) .then(result => console.log(result)) .catch(error => console.log(‘error’, error));

curl -X POST \
  '{endpoint}sms/senders' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer 5b02112fb7xxxxxxxxxxxxxxxx' \
  -H 'Content-Type: application/json' \
  -d '{
    "entity_id":"xxxxx" ,

Example Response

    "status": "OK",
    "code": 200,
    "message": "Sender Saved Successfully",
    "data": {
        "id": "ff467e28-7170-4a72-952e-c999cxxxxxx",
        "name": "SENDER",
        "service": {
            "id": 55,
            "display_name": "Global SMS",
            "name": "G"
        "entity_name": "SAMPLE COMPANY",
        "entity_id": "123233434355345555",
        "header_id": null,
        "iso": "IN",
        "message": null,
        "document": null,
        "is_open": 0,
        "purpose": 1,
        "status": 1,
        "created_at": "2022-11-16T06:53:26.000000Z",
        "updated_at": "2022-11-16T06:55:55.000000Z"