curl --request POST \
--url https://api.example.com/api/v1/invitations/accept \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"invitationIds": [
"invitation-12345",
"invitation-67890"
],
"target": {
"type": "email",
"value": "[email protected]"
},
"user": {
"name": "John Doe",
"email": "[email protected]",
"phone": "8675309"
}
}
'{
"invitations": [
{
"id": "invitation-12345",
"accountId": "account-12345",
"attributes": {},
"clickThroughs": 5,
"configurationAttributes": {},
"createdAt": "2023-10-01T12:00:00Z",
"deactivated": false,
"deliveryCount": 3,
"deliveryTypes": [
"email",
"phone"
],
"foreignCreatorId": "creator-12345",
"invitationType": "single_use",
"modifiedAt": "2023-10-01T12:00:00Z",
"status": "queued",
"target": [
{
"type": "email",
"value": "[email protected]"
}
],
"views": 10,
"widgetConfigurationId": "widget-12345",
"deploymentId": "deployment-12345",
"projectId": "project-67890",
"groups": [
{
"type": "workspace",
"id": "workspace-12345",
"name": "Development Team"
}
],
"accepts": [
{
"id": "accept-12345",
"status": "accepted"
}
],
"scope": "6b366c56-c0a9-4689-b763-20c890481bc8",
"scopeType": "project",
"expired": false,
"source": "email",
"expires": "2023-11-01T12:00:00Z",
"metadata": {
"customerId": "12345",
"source": "web"
},
"passThrough": "eyJhbGciOiJBMjU2R0NNIiwiZW5jIjoiQTI1NkdDTSJ9..."
}
]
}This endpoint is used to accept a pending invitation using the invitation ID. The body must contain user information. You can provide either:
user object containing email or phone (and optionally name)target object with type and valueIf the invitation is valid and not already accepted or expired, it will be marked as accepted.
curl --request POST \
--url https://api.example.com/api/v1/invitations/accept \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"invitationIds": [
"invitation-12345",
"invitation-67890"
],
"target": {
"type": "email",
"value": "[email protected]"
},
"user": {
"name": "John Doe",
"email": "[email protected]",
"phone": "8675309"
}
}
'{
"invitations": [
{
"id": "invitation-12345",
"accountId": "account-12345",
"attributes": {},
"clickThroughs": 5,
"configurationAttributes": {},
"createdAt": "2023-10-01T12:00:00Z",
"deactivated": false,
"deliveryCount": 3,
"deliveryTypes": [
"email",
"phone"
],
"foreignCreatorId": "creator-12345",
"invitationType": "single_use",
"modifiedAt": "2023-10-01T12:00:00Z",
"status": "queued",
"target": [
{
"type": "email",
"value": "[email protected]"
}
],
"views": 10,
"widgetConfigurationId": "widget-12345",
"deploymentId": "deployment-12345",
"projectId": "project-67890",
"groups": [
{
"type": "workspace",
"id": "workspace-12345",
"name": "Development Team"
}
],
"accepts": [
{
"id": "accept-12345",
"status": "accepted"
}
],
"scope": "6b366c56-c0a9-4689-b763-20c890481bc8",
"scopeType": "project",
"expired": false,
"source": "email",
"expires": "2023-11-01T12:00:00Z",
"metadata": {
"customerId": "12345",
"source": "web"
},
"passThrough": "eyJhbGciOiJBMjU2R0NNIiwiZW5jIjoiQTI1NkdDTSJ9..."
}
]
}List of invitation IDs to accept
["invitation-12345", "invitation-67890"](Deprecated) The target for the invitation acceptance, such as an email address or phone number. Use the user object instead.
Show child attributes
User information for accepting the invitation. Either email or phone must be provided. This is the preferred format.
Show child attributes
Successfully accepted the invitation
An array of invitations
Show child attributes