Send One

post

https://{host}/v2/surveys/{surveyId}/invitations/{invitationId}/sendone

Send an invitation to a single recipient. 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 (not both); the entity must be active and belong to your organisation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

surveyId

int32

required

The survey id whose invitation you are sending

invitationId

int32

required

The invitation id that you are sending

Body Params

An individual contact to send an invitation to

name

string

required

length ≥ 1

The name of the contact to send the invitation to

string | null

The email address of the target for this invitation (if an email invitation).
Unicode NFKC normalization and whitespace trimming are applied during deserialization
so that compatibility characters (e.g. ligatures) are converted to ASCII equivalents
before validation runs.

mobile

string | null

The mobile/cell number for the target for this invitation (if an SMS invitation)

custom_columns

array of objects | null

Custom column values for this recipient, if needed

custom_columns

entity_id

int32 | null

The numeric id of the entity to assign to this contact. Supply either this or
entity_unique_id, not both. The entity must be active and belong to your organisation.

entity_unique_id

string | null

The customer-facing unique code of the entity to assign to this contact. Supply either this or
entity_id, not both. The entity must be active and belong to your organisation.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200Success

400Request validation errors

402Insufficient email balance to send the invitation

403Forbidden

404Survey, Contact List or Invitation not found

500Internal server error with detailed message