v1

latestOpenAPI 3.0.02026-08-066425196.1 KB

Partner

Update partner name.

Allows a moderator to update partner's full name and status.

patch/partners/update

Request body

partnerNameIdstring uuid required

Id of the partner to be updated.

statusstring

Current status of the partner to be updated.

userIdstring uuid required

Id of the account to do the update.

fullNamestring

Name of the partner to be updated.

Example request

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

Response

The partner was updated successfully. The response includes the updated partner name.

partnerNameIdstring uuid

The unique identifier of the partner.

userIdstring uuid

The unique identifier of the user making the changes.

fullNamestring string

The new name of the partner.

statusstring string

The status of the partner.

Example response

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