Set User to support an Organisation

PUT 
/v1/users/:id/organisation

For Donations created through the Create A Donation API, A User can be set to donate to a particular Organisation by default using this API. If a Donation is made with a userId, the Donation will be associated with the Organisation the User is supporting at the time of Donation. If the userId is omitted or the User has not been set to donate to an Organisation by default then the organisationId must be included in the body.

Request

Path Parameters

id stringrequired

Id of the User.

application/json

Body

organisationId stringrequired

Organisation id to support.

Responses

200

Successfully set User to support an Organisation

application/json

Schema

Schema

data

object

userId string

organisationId string

timestamp date-time

Example: 2020-10-13T17:46:54.000Z
object string
Example: UserOrganisation

Example (from schema)

{
  "data": {
    "userId": "string",
    "organisationId": "string",
    "timestamp": "2020-10-13T17:46:54.000Z"
  },
  "object": "UserOrganisation"
}

400

Bad request

application/json

Schema

Schema

error

object

code string

title string

message string

reasons string[]nullable

Example (from schema)

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

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

Loading...