POST v3/subscribers/sms

https://api.questline.com/v3/subscribers/sms

Adds a subscriber to receive SMS messages.

Request Information

URI Parameters

None.

Body Parameters

The request body.

PostSubscriberToChannelRequestV3
Name Description Type Additional Info
SubscriberId The ID of the subscriber. globally unique identifier None.

Request Formats

application/json, text/json

Sample:

{
  "SubscriberId": "f2011318-2769-403f-9484-5ce68f97c4af"
}

Response Information

Resource Description

SuccessResponseV3
Name Description Type Additional Info
Success Flag that determines if the request was successful. boolean None.
Error The response error, if any. ResponseErrorV3 None.

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Error": {
    "ErrorId": 1,
    "ErrorMessage": "sample string 1"
  }
}

text/javascript, application/javascript, application/json-p

Sample:

/**/ typeof  === 'function' && ({"Success":true,"Error":{"ErrorId":1,"ErrorMessage":"sample string 1"}});