Send invite

Creates and sends invites to new recipients. It needs a valid campaign (email/sms) to queue the invites. If sendtime is not provided it will send asap.

Path Parameters

projectId string required
surveyId string required

application/*+json

application/json

application/json-patch+json

text/json

Request Body

campaignId string nullable

The campaign to be used for getting information for invite

recipients object[] nullable
A List of recipients, mandatory variables are "email" for email campaign and "phone" for sms campaign
Array [
variables object nullable
These variables will be stored on the recipient in the corresponding recipientlist, variables are used when merging values in the invitation.
property name* string
]
sendTimeUtc date-time nullable

If a send time is specified the invites will be sent at that time, a scheduled invite can not be canceled. No sendtime = send asap

Request Body

campaignId string nullable

The campaign to be used for getting information for invite

recipients object[] nullable
A List of recipients, mandatory variables are "email" for email campaign and "phone" for sms campaign
Array [
variables object nullable
These variables will be stored on the recipient in the corresponding recipientlist, variables are used when merging values in the invitation.
property name* string
]
sendTimeUtc date-time nullable

If a send time is specified the invites will be sent at that time, a scheduled invite can not be canceled. No sendtime = send asap

Request Body

campaignId string nullable

The campaign to be used for getting information for invite

recipients object[] nullable
A List of recipients, mandatory variables are "email" for email campaign and "phone" for sms campaign
Array [
variables object nullable
These variables will be stored on the recipient in the corresponding recipientlist, variables are used when merging values in the invitation.
property name* string
]
sendTimeUtc date-time nullable

If a send time is specified the invites will be sent at that time, a scheduled invite can not be canceled. No sendtime = send asap

Request Body

campaignId string nullable

The campaign to be used for getting information for invite

recipients object[] nullable
A List of recipients, mandatory variables are "email" for email campaign and "phone" for sms campaign
Array [
variables object nullable
These variables will be stored on the recipient in the corresponding recipientlist, variables are used when merging values in the invitation.
property name* string
]
sendTimeUtc date-time nullable

If a send time is specified the invites will be sent at that time, a scheduled invite can not be canceled. No sendtime = send asap

Responses

• 202
• 401
• 403
• 404

---

Accepted

Unauthorized

application/json

text/json

text/plain

Schema

Example (from schema)

---

Schema

error string nullable
statusCode int32

{
  "error": "string",
  "statusCode": 0
}

Schema

Example (from schema)

---

Schema

error string nullable
statusCode int32

{
  "error": "string",
  "statusCode": 0
}

Schema

Example (from schema)

---

Schema

error string nullable
statusCode int32

{
  "error": "string",
  "statusCode": 0
}

Forbidden

application/json

text/json

text/plain

Schema

Example (from schema)

---

Schema

error string nullable
statusCode int32

{
  "error": "string",
  "statusCode": 0
}

Schema

Example (from schema)

---

Schema

error string nullable
statusCode int32

{
  "error": "string",
  "statusCode": 0
}

Schema

Example (from schema)

---

Schema

error string nullable
statusCode int32

{
  "error": "string",
  "statusCode": 0
}

Not Found

application/json

text/json

text/plain

Schema

Example (from schema)

---

Schema

error string nullable
statusCode int32

{
  "error": "string",
  "statusCode": 0
}

Schema

Example (from schema)

---

Schema

error string nullable
statusCode int32

{
  "error": "string",
  "statusCode": 0
}

Schema

Example (from schema)

---

Schema

error string nullable
statusCode int32

{
  "error": "string",
  "statusCode": 0
}

Loading...