API reference · Charities Selections
Delete a charities selection
DELETE/v1/charities-selections/{charitiesSelectionId}
Delete a charities selection.
Requires a Bearer access token.
Parameters
This field has no description in the spec.
charitiesSelectionId#stringin pathrequired
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
400Cannot delete a charities selection with active campaigns
{ "statusCode": 400, "message": "Cannot delete a charities selection with active campaigns", "error": "Bad Request" }401Unauthorized
Missing, expired or invalid access token.
{ "statusCode": 401, "message": "Unauthorized" }403Only CUSTOM charities selections can be deleted
{ "statusCode": 403, "message": "Only CUSTOM charities selections can be deleted", "error": "Forbidden" }403Cannot delete a featured charities selection
{ "statusCode": 403, "message": "Cannot delete a featured charities selection", "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 DELETE https://api.sandbox.charitips.com/v1/charities-selections/<charitiesSelectionId> \ -H "Authorization: Bearer $CHARITIPS_TOKEN"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.