Create a GiftAid Declaration
POST/v1/gift-aid
Create a GiftAid Declaration
Request​
- application/json
Body
required
userId string
title stringrequired
Possible values: <= 255 characters
firstName string
Possible values: <= 255 characters
lastName stringrequired
Possible values: <= 255 characters
buildingNameNumber stringrequired
Possible values: <= 255 characters
roadName stringrequired
Possible values: <= 255 characters
city stringrequired
Possible values: <= 255 characters
country stringrequired
Possible values: <= 255 characters
postcode stringrequired
Possible values: <= 255 characters
Responses​
- 200
- 400
- 401
Successfully created a GiftAid declaration
- application/json
- Schema
- Example (from schema)
Schema
data
object
id string
Example:
giftaid_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxuserId stringnullable
title string
firstName string
lastName string
buildingNameNumber string
roadName string
city string
country string
postcode string
createdAt date-time
deletedAt date-timenullable
object string
Example:
gift_aid{
"data": {
"id": "giftaid_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"userId": "string",
"title": "string",
"firstName": "string",
"lastName": "string",
"buildingNameNumber": "string",
"roadName": "string",
"city": "string",
"country": "string",
"postcode": "string",
"createdAt": "2024-07-29T15:51:28.071Z",
"deletedAt": "2024-07-29T15:51:28.071Z"
},
"object": "gift_aid"
}
Bad request
- application/json
- Schema
- Example (from schema)
- UserNotFound
- BadRequest
- IncorrectParams
Schema
error
object
code string
title string
message string
reasons string[]nullable
{
"error": {
"code": "string",
"title": "string",
"message": "string",
"reasons": [
"string"
]
}
}
GiftAid - User not found
{
"error": {
"code": "gift_aid/user_not_found",
"title": "Bad request",
"message": "User not found"
}
}
400 Bad Request
{
"error": {
"code": "bad_request",
"title": "Bad request",
"message": "Something is wrong with your request, please check any parameters and try again"
}
}
400 Incorrect Parameters
{
"error": {
"code": "bad_request",
"title": "Bad request",
"message": "One or more of the inputs were invalid",
"reasons": [
"pageSize must be greater than or equal to 0"
]
}
}
Unauthorized
Loading...