API reference · Charities Selections
Remove a charity
POST/v1/charities-selections/{charitiesSelectionId}/remove-charity
No description in the spec yet.
Requires a Bearer access token.
Parameters
This field has no description in the spec.
charitiesSelectionId#stringin pathrequired
Body
RemoveCharityDtocharityId#stringrequiredUUIDThe id of the charity to remove from the selection.
Response
200 · CharitiesSelectionNo field is described in the spec.
charitiesSelectionId#stringalways returnedname#stringalways returnedtype#CharitiesSelectionTypealways returnedGENERICCUSTOMfeaturedCharitiesIds#string[]always returnedisFeatured#booleanalways returnedaccountId#stringcreatedAt#string (date-time)always returnedupdatedAt#string (date-time)always returnedcharities#OnlyCharityId[]always returned1 child field
charityIdstringalways returned
Errors
400A selection must have at least one charity when linked to a campaign
{ "statusCode": 400, "message": "A selection must have at least one charity when linked to a campaign", "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" }403This selection can't be customized
{ "statusCode": 403, "message": "This selection can't be customized", "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" }
curl -X POST https://api.sandbox.charitips.com/v1/charities-selections/<charitiesSelectionId>/remove-charity \ -H "Authorization: Bearer $CHARITIPS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "charityId": "<charityId>" }'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.