Complyt Docs

Upsert Client- Partnerships

POST

/v1/partnership/client

Adding or updating a partnership

Request

Header Params

Content-Type

string

optional

Example:

application/json

string

optional

Example:

application/json

Body Params application/json

tenantId

string

required

The tenantId of the client

name

string

required

The name of the client

Example

{
  "tenantId": "{{tenantId}}",
  "name": "{{name}}"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1/partnership/client' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tenantId": "{{tenantId}}",
    "name": "{{name}}"
}'

Responses

🟢200Success

application/json

Body

tenantId

string

required

The tenantId of the partner

partnerName

string

required

The name of the partner

supportedReferrals

array[object (Referral) {4}]

required

List of the supported partnership clients

tenantId

string

required

The tenantId of the client

name

string

required

The name of the client

partnershipStatus

string

required

Indicates whether the partnership is active or cancelled

timestamps

object (TimestampsDto)

required

Example

{
  "tenantId": "string",
  "partnerName": "string",
  "supportedReferrals": [
    {
      "tenantId": "string",
      "name": "string",
      "partnershipStatus": "string",
      "timestamps": {
        "createdDate": "string",
        "updatedDate": "string"
      }
    }
  ]
}

Modified at 2025-03-31 13:24:15

Get Partnerships

Delete Client- Partnerships