Skip to main content
PATCH
Update a partner

Authorizations

Authorization
string
header
required

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

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

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

Enable or disable the partner (portal access). Takes precedence over the deprecated status.

archived
boolean

Archive (true) or restore (false) the partner. Restoring clears archived_at and leaves enabled as it is. Takes precedence over the deprecated status for the archive state.

status
enum<string>
deprecated

Deprecated: use enabled. accepted and invited mean enabled, not-invited means disabled, archived archives the partner.

Available options:
accepted,
invited,
not-invited,
archived
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. Send null or a blank string to clear it.

description
string | null
stage_uuid
string | null
tier_uuid
string | null
category_uuid
string | null

Response

200 - 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