Cancel an invitation

Cancels an existing invitation.

DELETE /api/v1/invitations/{invitationId}

Cancel an invitation

cURL

curl --request DELETE \
  --url https://apix.us.amity.co/api/v1/invitations/{invitationId} \
  --header 'Authorization: Bearer <token>'

200

{
  "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

Pattern: ^[a-f0-9]{24}$

Response

200

application/json

Cancel invitation response

success · boolean

Whether the invitation was successfully canceled

Example:

true