Sign in

v1

latestOpenAPI 3.0.02026-08-066425196.1 KB
Partner

Create a new partner.

Allows a moderator to create a new partner. The partner is initially created with a status of 'ACTIVE'.

post/partners/create

Request body

userIdstring uuid required

The Id of the partner.

statusstring required

The current status of the partner. Default is set to active.

fullNamestring required

The full name of the partner.

Example request

{
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa",
  "status": "ACTIVE",
  "fullName": "Demo Partner"
}

Response

The partner was created successfully. The response includes the created partner details.

partnerNameIdstring uuid

The unique identifier of the partner.

userIdstring uuid

The Id of the partner.

statusstring

The current status of the partner. Default is set to active.

fullNamestring

The full name of the partner.

Example response

{
  "partnerNameId": "0360214c-55b4-4819-8f28-206b24cca41a",
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa",
  "status": "ACTIVE",
  "fullName": "Demo Partner"
}