Skip to main content
POST
Create a partner

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Body

application/json
name
string
required
partner_type
enum<string>
required
Available options:
referral,
reseller,
distributor
enabled
boolean

Whether the partner is enabled (has portal access). Defaults to false. Takes precedence over the deprecated status.

status
enum<string>
deprecated

Deprecated: use enabled. accepted and invited mean enabled, not-invited means disabled. archived is rejected: a partner can't be created archived.

Available options:
accepted,
invited,
not-invited
email
string | null
phone_number
string | null
website_url
string | null

Valid HTTP(S) website URL up to 500 characters. Bare domains are accepted and normalized to HTTPS.

description
string | null
stage_uuid
string
tier_uuid
string
category_uuid
string
tag_uuids
string[]
assigned_user_uuids
string[]

Team members to assign to the partner. If omitted and the request is made by a person (owner login, OAuth/MCP, or the AI assistant), the caller is assigned. Send an empty list to assign nobody. API-key requests never assign the caller.

domains
object[]
custom_fields
object[]

Response

201 - application/json

Default Response

uuid
string
required
name
string | null
required
email
string | null
required
phone_number
string | null
required
website_url
string | null
required
description
string | null
required
partner_type
enum<string>
required
Available options:
referral,
reseller,
distributor
enabled
boolean
required

Whether the partner is enabled (has portal access).

enabled_at
string | null
required

When the partner was first enabled; null if never enabled.

archived_at
string | null
required

When the partner was archived; null if it is not archived.

stage
object | null
required
tier
object | null
required
category
object | null
required
partner_logo_uuid
string | null
required
partner_logo_square_uuid
string | null
required
partner_logo_white_uuid
string | null
required
partner_logo_square_white_uuid
string | null
required
tags
object[]
required
assigned_users
object[]
required
custom_fields
object[]
required
domains
object[]
required
created_at
string
required
updated_at
string
required