Send Multi

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

The survey id whose invitation you are sending

int32
required

The invitation id that you are sending

Body Params

Request object for sending an invitation using the API

contacts
array of objects
required

The list of contacts to send the invitation to

contacts*
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json