Skip to main content
POST
Create an identity-bound recipient invitation

Authorizations

Authorization
string
header
required

Your personal access token where supported, or a scoped API key (hc_…) created inside HueChat at Account → Developer API. Send it as Authorization: Bearer <token>.

Path Parameters

accountId
integer
required
Required range: x >= 1
formId
string<uuid>
required

Body

application/json
contact_id
integer
required
Required range: x >= 1
expires_at
string<date-time>
single_use
boolean

Response

Success

invitation
object

Administrative metadata; no token or hash returned. sent_at requires provider acceptance, not invitation creation.

url
string<uri>