Send an SMS to a contact by reference ID.

Required permissions: Send TXT Out

post

Path parameters

programmeIDstring · uuidRequired

mobileNumberstringRequired

Query parameters

referenceIDstring · uuidRequired

messagestringRequired

shortenLinksbooleanOptional

apiTokenstringRequired

API authentication token

Responses

200

OK

application/json

messageIDstringOptional

400

Missing Parameter Value

application/json

401

Incorrect Permissions or Invalid API Token

application/json

500

Engage Server Error. Unable to process response at this time.

application/json

post/txt/programmes/{programmeID}/sendtxt/{mobileNumber}

POST /txt/programmes/{programmeID}/sendtxt/{mobileNumber}?referenceID=123e4567-e89b-12d3-a456-426614174000&message=text&apiToken=text HTTP/1.1
Host: api.ubiquity.co.nz
Accept: */*

{
  "messageID": "text"
}