Export request field reference

JSON fields for export surveys (POST …/collectors/api/{collector_uuid}/export).

Field	Type	Mandatory	Description
recipients	array	Yes	List of contacts to export links for (1–5000 items)
recipients[].email	string	Yes	Valid email address (max 255 characters)
recipients[].phone	string	Yes	Valid phone number in international format (e.g. +966…), max 32 characters
recipients[].first_name	string	No	Optional given name (max 100 characters)
recipients[].last_name	string	No	Optional family name (max 100 characters)
recipients[].variables	object	No	Optional context variables (same rules as send surveys)

Request limits

• Maximum recipients per request: 5000 items in recipients.
• Required per recipient: both email and phone; entries missing either are rejected.
• No medium field -export only returns links; it does not dispatch SMS, email, or WhatsApp.

INFO

For sending invites through a delivery channel, use Send surveys via API instead (requires medium).

---

← Export surveys · Export responses →