Sign in
Partners
Admin

Create a new partner

Create a new partner

post/api/v1/admin/partners

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

Changed in 3 of the 8 revisions of this API.215

  • b372e7d5563d114See the full diff
    • ▲

      the error/code response's property type/format changed from string/ to / for status 400

      response-property-type-changed

    • ●

      removed the optional property error/errors from the response with the 400 status

      response-optional-property-removed

    • ○

      added the new optional request property website

      new-optional-request-property

    • ○

      added the optional property error/metadata to the response with the 400 status

      response-optional-property-added

    • ○

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

      response-property-all-of-added

    • ○

      added the required property data/website to the response with the 201 status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6637b341d86d1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 919eb7a392aa1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 367 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog