Skip to main content
POST
/
v2
/
partner
/
organizations
Create Organization
curl --request POST \
  --url https://api.trykintsugi.com/v2/partner/organizations \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>"
}
'
{
  "name": "<string>",
  "external_id": "<string>",
  "promo": "<string>",
  "id": "<string>",
  "status": "ACTIVE",
  "is_test": true,
  "billing_plan": "FREE",
  "disable_emails": false,
  "customer_id": "<string>",
  "subscription_id": "<string>",
  "scheduled_deletion": "2023-12-25",
  "email_group": "<string>",
  "internal_use": false,
  "archival_reason": "<string>",
  "archival_reason_notes": "<string>",
  "archival_by": "<string>",
  "archival_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
x-partner-id
string | null

Target partner. Required for referral partner API keys (selects the owned sub-partner; omitting it returns 400 PARTNER_ID_REQUIRED). For multi-partner bearer users, selects the active partner.

Maximum string length: 100

Body

application/json

Request body for creating a new client organization from the partner dashboard.

​
name
string
required
Required string length: 1 - 255
​
isTest
boolean
default:false
​
billingMode
enum<string> | null
Available options:
PARTNER_MANAGED,
CLIENT_MANAGED

Response

Successful Response

​
name
string | null
required
​
external_id
string
required
​
source
enum<string> | null
required
Available options:
PARTNER,
SEARCH,
LINKEDIN,
LINKEDIN_AD,
GOOGLE_AD,
REFERRAL,
UNKNOWN
​
promo
string | null
required
​
id
string
required
​
status
enum<string>
default:ACTIVE
Available options:
ACTIVE,
ARCHIVED
​
is_test
boolean
default:true
​
billing_plan
enum<string>
default:FREE
Available options:
FREE,
GROWTH,
PREMIUM
​
disable_emails
boolean
default:false
​
customer_id
string | null
​
subscription_id
string | null
​
scheduled_deletion
string<date> | null
​
email_group
string | null
​
internal_use
boolean | null
default:false

This organization is used for internal testing purposes only

​
archival_reason
string | null
​
archival_reason_notes
string | null
​
archival_by
string | null
​
archival_at
string<date-time> | null