DELETE
/
invites
/
{inviteId}
curl --request DELETE \
--url 'https://YOURSITE.konstant.ly/openapi/v1/invites/1234' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
{
    "status": 404,
    "message": "Not found"
}

Cancel an existing invitation, invalidating its signup URL.

Request Headers

X-API-KEY
string
required

API Key. Go to your Konstantly site > Settings > API and copy the value from there.

URL Parameters

inviteId
integer
required

Invitation ID

Response

On success, returns HTTP 200 status code.

Error Responses

404
object

Not Found error response

Important Notes

  1. Effects of Cancellation:
  • The signup URL becomes immediately invalid
  • Cannot be undone - must create new invitation if needed
  • Does not affect users who have already accepted
  1. Use Cases:
  • Correcting mistakenly sent invitations
  • Revoking access before acceptance
  • Managing invitation expiry
  1. Security Considerations:
  • Consider canceling invitations for departed employees
  • Review pending invitations periodically
  • Track cancellations for audit purposes
curl --request DELETE \
--url 'https://YOURSITE.konstant.ly/openapi/v1/invites/1234' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'
{
    "status": 404,
    "message": "Not found"
}