Skip to main content
POST
Send Clarity Interview Invites

Authorizations

Authorization
string
header
required

API key authentication. Get your API key from the Duvo dashboard.

Path Parameters

id
string<uuid>
required

The Clarity process ID.

Body

application/json
invitees
object[]

People found through org-chart or landscape people tools. At most 25 unique recipients per call, counting includeProcessPeople.

Maximum array length: 25
includeProcessPeople
boolean

Also invite every active process person with an email address. Use this for people already assigned to the process.

message
string

Optional plain-text note added to each invitation email, at most 500 characters. Line breaks are collapsed and markup is shown as text.

Maximum string length: 500

Response

Default Response

invites
object[]
required

The result for each unique invitee.