Sign in
latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Sender IDs

Apply for a new Sender ID

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Sender%20IDs/requestSenderId" target="_blank">Try in sandbox</a><br>> Sender IDs are shared among all of your sub-accounts.

post/api/v2/senderids

Request body

senderIdstring required

The Sender ID that you are applying for.

  • 11 characters maximum;
  • Only Latin based characters and digits are allowed;
  • Should contain at least 1 letter.
explanationstring required

Explanation of why you need this Sender ID.

Example request

{
  "senderId": "HotRod",
  "explanation": "Because it equals to my company name."
}

Response

Sender ID request has been created with success.

idinteger required

Resource ID.

hrefstring required

A link to this resource. If you want to fetch it, just GET this address.

Example response

{
  "id": 515,
  "href": "/api/v2/entity_name/1"
}