Partners
Admin

Create a new partner

Changed on

Create a new partner

post/api/v1/admin/partners

Request

Request body

namestring required

The name of the partner

emailstring email required

The email of the partner

websitestring nullable

The website URL of the partner (protocol optional, will be normalized)

Example request

{
  "name": "Barclaycard",
  "email": "argo@barclaycard.com",
  "website": "barclaycard.com"
}

Response

Created

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "name": "Barclaycard",
    "email": "argo@barclaycard.com",
    "client_id": "partner_123",
    "client_secret": "secret_abc123"
  }
}

Changes

    • breaking

      the / response's property type changed from string to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added subschema #1 subschema #2 to the / response property allOf list for the response status

    • info

      added the required property / to the response with the status

    • info

      endpoint added