SMS Invitation

Create a Mobile SMS collector before using these invitation endpoints. All requests require a bearer token and JSON content type.

Add SMS Invitation

• Method: POST
• URL: https://api.surveyol.com/v1/collector/{collectorId}/invitation/text

Parameters:

• recipients (array): objects with required phone and optional firstName and lastName
• message (string)
• invitationDate (datetime, optional)

curl --request POST \
--url https://api.surveyol.com/v1/collector/58d658d4-31b6-4c2f-8b49-e2f531c6d4e6/invitation/text \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
  "recipients": [
    {"firstName": "Alex", "lastName": "Miller", "phone": "+15551234567"},
    {"firstName": "Jamie", "lastName": "Ng", "phone": "+15557654321"}
  ],
  "message": "Please complete our survey.",
  "invitationDate": "2026-07-04 10:00:00"
}'

Response Example

{
  "id": "f9321322-dd80-4b14-ac63-e9f04bd1f80e",
  "subject": null,
  "message": "Please complete our survey.",
  "createdDate": "2026-07-03T20:20:12Z",
  "emailRecipients": [],
  "textRecipients": [
    {"id": "5a10d78a-a66e-4f6e-a6c4-d3b5a3b9cd95", "phone": "+15551234567", "responseId": null},
    {"id": "365d2abd-7648-4db3-8db2-db14aa1d912d", "phone": "+15557654321", "responseId": null}
  ]
}

List SMS Invitations

• Method: GET
• URL: https://api.surveyol.com/v1/collector/{collectorId}/invitation/texts

curl --request GET \
--url https://api.surveyol.com/v1/collector/58d658d4-31b6-4c2f-8b49-e2f531c6d4e6/invitation/texts \
--header 'Authorization: Bearer <token>'

The response is an array of recipients with id, phone, and responseId.

Response Example

[
  {"id": "5a10d78a-a66e-4f6e-a6c4-d3b5a3b9cd95", "phone": "+15551234567", "responseId": null},
  {"id": "365d2abd-7648-4db3-8db2-db14aa1d912d", "phone": "+15557654321", "responseId": null}
]