v1

latestOpenAPI 3.1.02026-08-0416027.2 KB

Create Sender ID

API to register Sender ID for sending SMS

post/sms/create-sender-id

Request body

namestring required

Represents the sender of the message

samplestring required

This should contain your sample message

use_casestring required

You should pass either of the following: Transactional, Marketing, or Transactional & Marketing

Response

200

codeinteger

{"stackTrail":"paths:/sms/create-sender-id:post:responses:200:content:application/json:schema:properties:errors","oasType":"schema","type":"unknown"}

messagestring

statusstring

Example response

{
  "code": 200,
  "data": {
    "id": 5213,
    "uid": "8d20ae29-8f46-4d39-818f-a73c04483b82",
    "name": "salespoint",
    "business_id": 408,
    "use_case": "transactional",
    "sample": "Hi, your otp",
    "status": "pending",
    "business": {
      "id": 408,
      "uid": "00000000-0000-0000-0000-000000000000"
    },
    "created_at": "2023-01-21T15:07:38Z",
    "updated_at": "2023-01-21T15:07:38Z"
  },
  "message": "sms sender created",
  "status": "success"
}