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
status
enum<string>
default:not-invited
required
Available options:
invited,
not-invited,
accepted,
archived
email
string | null
phone_number
string | null
website_url
string | null
description
string | null
stage_uuid
string
tier_uuid
string
category_uuid
string
tag_uuids
string[]
assigned_user_uuids
string[]
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
status
enum<string>
required
Available options:
invited,
not-invited,
accepted,
archived
accepted_at
string | null
required
invited_at
string | null
required
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