Skip to main content
POST
/
api
/
Messages
/
Sms
/
CreditCheck
SMS Message Credit Check.
curl --request POST \
  --url https://api.example.com/api/Messages/Sms/CreditCheck \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "subject": "<string>",
    "body": "<string>",
    "jobId": 123,
    "placementId": 123,
    "changeRequestId": 123,
    "recipientEntityId": 1,
    "recipientRecordId": 123
  }
]
'
{
  "creditBalance": 123,
  "creditsNeeded": 123,
  "statusMessage": "<string>"
}

Body

application/json
subject
string | null
body
string | null
jobId
integer<int32>
placementId
integer<int32>
changeRequestId
integer<int32>
recipientEntityId
enum<integer>
Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13,
14,
15,
16,
17,
18,
19,
20,
21,
22,
25,
26,
27,
28,
29,
30,
31,
1000,
1003,
1004,
1400,
-2
recipientRecordId
integer<int32>

Response

200 - application/json

OK

creditBalance
integer<int32>
creditsNeeded
integer<int32>
statusMessage
string | null