Skip to content
Aller au contenu
Charitips

API reference · Accounts

Enable donor platform

POST/v1/accounts/{accountId}/donor-platform

Enable the donor platform for a given child account. Restricted to platform accounts

Requires a Bearer access token.

Parameters

This field has no description in the spec.

  • accountId#stringin pathrequired

Body

EnableDonorPlatformDto
  • authSchemes#string

    Authentication schemes allowed for the donor platform.

    GOOGLEEMAILAPI

Errors

  • 400 Bad Request
  • Budget is required for FIXED_AMOUNT campaigns
    {
      "statusCode": 400,
      "message": "Budget is required for FIXED_AMOUNT campaigns",
      "error": "Bad Request"
    }
  • INCLUDED fee type not supported
    {
      "statusCode": 400,
      "message": "INCLUDED fee type not supported",
      "error": "Bad Request"
    }
  • Public campaigns must be both FIXED_AMOUNT and DISTRIBUTION campaigns
    {
      "statusCode": 400,
      "message": "Public campaigns must be both FIXED_AMOUNT and DISTRIBUTION campaigns",
      "error": "Bad Request"
    }
  • DISTRIBUTION campaigns must also be FIXED_AMOUNT campaigns
    {
      "statusCode": 400,
      "message": "DISTRIBUTION campaigns must also be FIXED_AMOUNT campaigns",
      "error": "Bad Request"
    }
  • givingTarget is only supported for fundraising campaigns
    {
      "statusCode": 400,
      "message": "givingTarget is only supported for fundraising campaigns",
      "error": "Bad Request"
    }
  • Only one of <givingType> campaigns is supported
    {
      "statusCode": 400,
      "message": "Only one of <givingType> campaigns is supported",
      "error": "Bad Request"
    }
  • A 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"
    }
  • 401 Unauthorized
  • Unauthorized

    Missing, expired or invalid access token.

    {
      "statusCode": 401,
      "message": "Unauthorized"
    }
  • 402 Payment Required
  • Plan upgrade required
    {
      "statusCode": 402,
      "message": "Plan upgrade required"
    }
  • 403 Forbidden
  • Forbidden
    {
      "statusCode": 403,
      "message": "Forbidden"
    }
  • Account closed
    {
      "message": "Account closed",
      "code": "ACCOUNT_CLOSED"
    }
  • 404 Not Found
  • Not Found

    No resource with this id on your account: the API answers as if it did not exist.

    {
      "statusCode": 404,
      "message": "Not Found"
    }
  • 409 Conflict
  • Slug already used
    {
      "message": "Slug already used",
      "code": "slug_already_used"
    }
POST /v1/accounts/<accountId>/donor-platform
curl -X POST https://api.sandbox.charitips.com/v1/accounts/<accountId>/donor-platform \  -H "Authorization: Bearer $CHARITIPS_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "authSchemes": [      "EMAIL",      "API"    ]  }'
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.