Skip to main content
POST
/
v1
/
organizations
{
  "name": "<string>",
  "external_id": "<string>",
  "source": "PARTNER",
  "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
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
name
string
required
​
is_test
boolean
required

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