Skip to main content
POST
/
v2
/
referral
/
partners
Create Partner For Referral
curl --request POST \
  --url https://api.trykintsugi.com/v2/referral/partners \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>"
}
'
{
  "partnerId": "<string>",
  "name": "<string>",
  "onboardingUrl": "<string>",
  "clients": [
    {
      "name": "<string>",
      "organizationId": "<string>",
      "description": ""
    }
  ]
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
name
string
required

Name for the new partner.

Required string length: 1 - 255
​
ownerEmail
string<email> | null

If provided, creates the partner owner immediately and emails them a temporary password. If omitted, returns an onboarding URL instead.

​
clients
ClientInputRequest · object[] | null

Optional list of client organizations to create under this partner. Each entry requires a name; additional fields prepopulate the organization profile. Names are deduplicated case-insensitively (first occurrence wins). Creation is best-effort: names that collide with existing organizations return an ERROR status, and individual failures do not affect the overall response.

Maximum array length: 20

Response

Successful Response

​
partnerId
string
required
​
name
string
required
​
onboardingUrl
string | null

URL to send to the partner for account setup. Null when owner was created via email.

​
clients
ClientOrgResultResponse · object[] | null

Per-client creation results. Null when no clients were requested.