API reference · UserInvitations
Update a user invitation
PATCH/v1/user-invitations/{userInvitationId}
Update an invitation.
Requires a Bearer access token.
Parameters
This field has no description in the spec.
userInvitationId#stringin pathrequired
Body
UpdateUserInvitationDtoNo field is described in the spec.
Response
200 · UserInvitationNo field is described in the spec.
userInvitationId#stringalways returnedfirstName#stringalways returnedlastName#stringalways returnedemail#stringalways returnedphone#stringslug#stringalways returnedstatus#UserInvitationStatusalways returnedPENDINGCLAIMEDCANCELEDrole#Rolealways returnedADMINMEMBERPAYROLL_MANAGERaccountId#stringalways returnedcreatedAt#string (date-time)always returnedupdatedAt#string (date-time)always returned
Errors
400Only members can be assigned campaigns
{ "statusCode": 400, "message": "Only members can be assigned campaigns", "error": "Bad Request" }400Invalid campaignIds
{ "statusCode": 400, "message": "Invalid campaignIds", "error": "Bad Request" }400A field is missing, has the wrong type, or is not part of the request schema.
Every request with a body or query is validated.
{ "statusCode": 400, "message": [ "amount must not be less than 1", "property foo should not exist" ], "error": "Bad Request" }401Unauthorized
Missing, expired or invalid access token.
{ "statusCode": 401, "message": "Unauthorized" }402Plan upgrade required
{ "statusCode": 402, "message": "Plan upgrade required" }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" }
curl -X PATCH https://api.sandbox.charitips.com/v1/user-invitations/<userInvitationId> \ -H "Authorization: Bearer $CHARITIPS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "email": "donor@example.com", "firstName": "<firstName>" }'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.