Create a GiftAid Declaration

POST 
/v1/gift-aid

Create a GiftAid Declaration

Request

application/json

Body

required

userIdstring
titlestringrequired

Possible values: <= 255 characters

firstNamestring

Possible values: <= 255 characters

lastNamestringrequired

Possible values: <= 255 characters

buildingNameNumberstringrequired

Possible values: <= 255 characters

roadNamestringrequired

Possible values: <= 255 characters

citystringrequired

Possible values: <= 255 characters

countrystringrequired

Possible values: <= 255 characters

postcodestringrequired

Possible values: <= 255 characters

Responses

200

Successfully created a GiftAid declaration

application/json

Schema

Schema

data

object

idstring

Example: giftaid_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

userIdstringnullable

titlestring

firstNamestring

lastNamestring

buildingNameNumberstring

roadNamestring

citystring

countrystring

postcodestring

createdAtdate-time

deletedAtdate-timenullable
objectstring
Example: gift_aid

Example (from schema)

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

400

Bad request

application/json

Schema

Schema

error

object

codestring

titlestring

messagestring

reasonsstring[]nullable

Example (from schema)

{
  "error": {
    "code": "string",
    "title": "string",
    "message": "string",
    "reasons": [
      "string"
    ]
  }
}

UserNotFound

GiftAid - User not found

{
  "error": {
    "code": "gift_aid/user_not_found",
    "title": "Bad request",
    "message": "User not found"
  }
}

BadRequest

400 Bad Request

{
  "error": {
    "code": "bad_request",
    "title": "Bad request",
    "message": "Something is wrong with your request, please check any parameters and try again"
  }
}

IncorrectParams

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

401

Unauthorized