API reference · Authentication

Create a donor magic link

POST/v1/authentication/magic-links/donors/{donorId}

Generate a magic link for a donor to be used to login to the donor platform.

Requires a Bearer access token.

Parameters

This field has no description in the spec.

donorId#stringin pathrequired

Errors

401Unauthorized
Missing, expired or invalid access token.
```
{
  "statusCode": 401,
  "message": "Unauthorized"
}
```

403Donor platform is not enabled

{
  "statusCode": 403,
  "message": "Donor platform is not enabled",
  "error": "Forbidden"
}

403API authentication is not allowed for this donor platform

{
  "message": "API authentication is not allowed for this donor platform",
  "code": "API_AUTH_NOT_ALLOWED"
}

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"
}
```

404Donor not found

{
  "statusCode": 404,
  "message": "Donor not found",
  "error": "Not Found"
}

404Not Found
No resource with this id on your account: the API answers as if it did not exist.
```
{
  "statusCode": 404,
  "message": "Not Found"
}
```

POST /v1/authentication/magic-links/donors/<donorId>

1curl -X POST https://api.sandbox.charitips.com/v1/authentication/magic-links/donors/<donorId> \2  -H "Authorization: Bearer $CHARITIPS_TOKEN"

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.