Skip to content

Send SMS to the list of clients

Request

The object for creating SMS mailing has the following fields:

FieldTypeDescription
client_idsarray of numbersArray of client IDs
textstringSMS text message
Security
BearerPartnerUser
Path
location_idnumberrequired

location ID

Headers
Acceptstringrequired

e.g. application/vnd.api.v2+json

Example:application/vnd.api.v2+json
Content-Typestringrequired

application/json

Authorizationstringrequired

Bearer partner_token, User user_token

Bodyapplication/jsonrequired
client_idsArray of numbers

Array of client IDs

Example:
[
  1,
  2,
  3,
  4,
  5
]
textstring

SMS text message

Example:"Dear clients, we congratulate you on being our clients! You are very lucky!"
curl -i -X POST \
  'https://developer.alteg.io/_mock/en/b2b-v1/openapi/sms/clients/by_id/{location_id}' \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "client_ids": [
      1,
      2,
      3,
      4,
      5
    ],
    "text": "Dear clients, we congratulate you on being our clients! You are very lucky!"
  }'

Responses

Created

Bodyapplication/json
successboolean

Execution success status (true)

Example:true
datanull

Always null for this endpoint

metaobject

An object containing a 201 status code message

Example:
{
  "message": "Accepted"
}
Response
{
  "success": true,
  "meta": {
    "message": "Accepted"
  }
}