Create a charities selection

• name#stringrequired2 to 100 characters

  Name of the selection.

• charityIds#string[]UUID

  Ids of the selected charities.

• campaignId#stringUUID

  Optionally link it directly to an existing campaign.

• accountId#stringUUID

  Only required to link the created entity to a child account instead of the current one.

• 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.

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 to be linked to a campaign

  {
    "statusCode": 400,
    "message": "A selection must have at least one charity to be 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"
  }

• 403Account closed

  {
    "message": "Account closed",
    "code": "ACCOUNT_CLOSED"
  }