Skip to main content
POST
/
api
/
v1
/
invitations
/
sync-internal-invitation
Sync an internal invitation decision from an external system
curl --request POST \
  --url https://api.example.com/api/v1/invitations/sync-internal-invitation \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "creatorId": "user-12345",
  "targetValue": "user-67890",
  "action": "accepted",
  "componentId": "123e4567-e89b-12d3-a456-426614174000"
}
'
{
  "processed": 1,
  "invitationIds": [
    "invitation-12345"
  ]
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
creatorId
string
required

The ID of the user who created the invitation in your system

Example:

"user-12345"

​
targetValue
string
required

The ID of the user who received the invitation (the invitee) in your system

Example:

"user-67890"

​
action
enum<string>
required

The action to perform on the invitation

Available options:
accepted,
declined
Example:

"accepted"

​
componentId
string<uuid>
required

The ID of the component (widget) associated with the invitation

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Successfully processed the invitation sync

​
processed
number

Number of invitations processed

Example:

1

​
invitationIds
string[]

IDs of the processed invitations

Example:
["invitation-12345"]