Skip to content
Aller au contenu
Charitips

API reference · Charities Selections

Update a charities selection

PATCH/v1/charities-selections/{charitiesSelectionId}

No description in the spec yet.

Requires a Bearer access token.

Parameters

This field has no description in the spec.

  • charitiesSelectionId#stringin pathrequired

Body

UpdateCharitiesSelectionDto
  • name#string2 to 100 characters

    Name of the selection.

  • charityIds#string[]UUID

    Ids of the selected charities.

  • featuredCharitiesIds#string[]UUID

    Ids of the featured charities. These charities will be displayed first in the list of charities. Warning: The featured charities must be part of the selected charities.

Response

200 · CharitiesSelection

No field is described in the spec.

  • charitiesSelectionId#stringalways returned

  • name#stringalways returned

  • type#CharitiesSelectionTypealways returned

    GENERICCUSTOM

  • featuredCharitiesIds#string[]always returned

  • isFeatured#booleanalways returned

  • accountId#string

  • authorId#string

  • createdAt#string (date-time)always returned

  • updatedAt#string (date-time)always returned

  • charities#OnlyCharityId[]always returned

    1 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"
    }
  • 400Featured charities must be part of the selected charities: <join(', ')>
    {
      "statusCode": 400,
      "message": "Featured charities must be part of the selected charities: <join(', ')>",
      "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"
    }
PATCH /v1/charities-selections/<charitiesSelectionId>
curl -X PATCH https://api.sandbox.charitips.com/v1/charities-selections/<charitiesSelectionId> \  -H "Authorization: Bearer $CHARITIPS_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "charityIds": [      "<charityId>"    ]  }'
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.