Skip to main content
DELETE
/
api
/
v1
/
invitations
/
{invitationId}
Cancel an invitation
curl --request DELETE \
  --url https://apix.us.amity.co/api/v1/invitations/{invitationId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
invitationId
string
required

ID of the invitation (MongoDB ObjectId)

Required string length: 24

Response

Cancel invitation response

​
success
boolean

Whether the invitation was successfully canceled

Example:

true