v1

latestSwagger 2.0Apache 2.02026-07-13123128517.6 KB
texts

Add recipients to a text broadcast

Use this API to add recipients to a text broadcast which is already created. Post a list of Recipient objects to be immediately added to the text broadcast campaign. These contacts will not go through validation process, and will be acted upon as they are added. Recipients may be added as a list of contact ids, or list of numbers

post/texts/broadcasts/{id}/recipients

Path parameters

idinteger required

An id of a text broadcast

Query parameters

fieldsstring

Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at partial response page.

strictValidationboolean

Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation

sendImmediatelyboolean

~

Request body

phoneNumberstring

Phone number in E.164 format (11-digit) or short code. Example: 12132000384, 67076

fromNumberstring

~

contactIdinteger

An id of existing contact in account

attributesobject

A map of string attributes associated with a recipient

messagestring

A text message

extractedSingleRecipientboolean

~

metaobject

~

Response

successful operation