Skip to content
Aller au contenu
Charitips

API reference · UserInvitations

Delete a user invitation

DELETE/v1/user-invitations/{userInvitationId}

Delete a pending invitation

Requires a Bearer access token.

Parameters

This field has no description in the spec.

  • userInvitationId#stringin pathrequired

Response

200 · UserInvitation

No field is described in the spec.

  • userInvitationId#stringalways returned

  • firstName#stringalways returned

  • lastName#stringalways returned

  • email#stringalways returned

  • phone#string

  • slug#stringalways returned

  • status#UserInvitationStatusalways returned

    PENDINGCLAIMEDCANCELED

  • role#Rolealways returned

    ADMINMEMBERPAYROLL_MANAGER

  • accountId#stringalways returned

  • createdAt#string (date-time)always returned

  • updatedAt#string (date-time)always returned

Errors

  • 401Unauthorized

    Missing, expired or invalid access token.

    {
      "statusCode": 401,
      "message": "Unauthorized"
    }
  • 403Only pending invites can be deleted
    {
      "statusCode": 403,
      "message": "Only pending invites can be deleted",
      "error": "Forbidden"
    }
  • 403Account closed
    {
      "message": "Account closed",
      "code": "ACCOUNT_CLOSED"
    }
  • 403Forbidden

    Your credentials cannot perform this action on this resource. An id from another account answers 404 in the path, 400 in the body or the query.

    {
      "statusCode": 403,
      "message": "Forbidden"
    }
  • 404Not Found

    No resource with this id on your account: the API answers as if it did not exist.

    {
      "statusCode": 404,
      "message": "Not Found"
    }
DELETE /v1/user-invitations/<userInvitationId>
curl -X DELETE https://api.sandbox.charitips.com/v1/user-invitations/<userInvitationId> \  -H "Authorization: Bearer $CHARITIPS_TOKEN"
Built from the spec and the API code

Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.