Send an invitation to one or more recipients. Note that this is a premium endpoint and is not available on all plans.
If you are using the Organisation Hierarchy feature, to assign a recipient to an entity within the hierarchy, supply either entity_id or entity_unique_id on that contact (not both); the entity must be active and belong to your organisation.
If entity auto-insert is enabled for your organisation and this contact list's custom columns are mapped to entity fields, the mapped custom_columns values are also written to an entity that entity_unique_id creates.
On an SMS invitation, mobile numbers that have opted out of SMS messages from this sender are not sent to, stored or charged; each comes back in failed_contacts with status_code``OPTOUT, and only the remaining contacts count against your balance. A request in which every number has opted out returns 200 and charges nothing.
When none of the remaining contacts could be sent, the 500 response carries failed_contacts, including any opted-out numbers, so you can tell which contacts to retry.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||

