Create a partner
curl --request POST \
--url https://api.journeybee.io/v1/partners/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"status": "not-invited",
"email": "<string>",
"phone_number": "<string>",
"website_url": "<string>",
"description": "<string>",
"stage_uuid": "<string>",
"tier_uuid": "<string>",
"category_uuid": "<string>",
"tag_uuids": [
"<string>"
],
"assigned_user_uuids": [
"<string>"
],
"domains": [
{
"domain": "<string>",
"is_primary": false
}
],
"custom_fields": [
{
"custom_field_uuid": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
}
}
]
}
'import requests
url = "https://api.journeybee.io/v1/partners/"
payload = {
"name": "<string>",
"status": "not-invited",
"email": "<string>",
"phone_number": "<string>",
"website_url": "<string>",
"description": "<string>",
"stage_uuid": "<string>",
"tier_uuid": "<string>",
"category_uuid": "<string>",
"tag_uuids": ["<string>"],
"assigned_user_uuids": ["<string>"],
"domains": [
{
"domain": "<string>",
"is_primary": False
}
],
"custom_fields": [
{
"custom_field_uuid": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": True,
"select": 123,
"multi_select": [123]
}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
status: 'not-invited',
email: '<string>',
phone_number: '<string>',
website_url: '<string>',
description: '<string>',
stage_uuid: '<string>',
tier_uuid: '<string>',
category_uuid: '<string>',
tag_uuids: ['<string>'],
assigned_user_uuids: ['<string>'],
domains: [{domain: '<string>', is_primary: false}],
custom_fields: [
{
custom_field_uuid: '<string>',
value: {
text: '<string>',
number: 123,
date: '<string>',
boolean: true,
select: 123,
multi_select: [123]
}
}
]
})
};
fetch('https://api.journeybee.io/v1/partners/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.journeybee.io/v1/partners/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'status' => 'not-invited',
'email' => '<string>',
'phone_number' => '<string>',
'website_url' => '<string>',
'description' => '<string>',
'stage_uuid' => '<string>',
'tier_uuid' => '<string>',
'category_uuid' => '<string>',
'tag_uuids' => [
'<string>'
],
'assigned_user_uuids' => [
'<string>'
],
'domains' => [
[
'domain' => '<string>',
'is_primary' => false
]
],
'custom_fields' => [
[
'custom_field_uuid' => '<string>',
'value' => [
'text' => '<string>',
'number' => 123,
'date' => '<string>',
'boolean' => true,
'select' => 123,
'multi_select' => [
123
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.journeybee.io/v1/partners/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"status\": \"not-invited\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"website_url\": \"<string>\",\n \"description\": \"<string>\",\n \"stage_uuid\": \"<string>\",\n \"tier_uuid\": \"<string>\",\n \"category_uuid\": \"<string>\",\n \"tag_uuids\": [\n \"<string>\"\n ],\n \"assigned_user_uuids\": [\n \"<string>\"\n ],\n \"domains\": [\n {\n \"domain\": \"<string>\",\n \"is_primary\": false\n }\n ],\n \"custom_fields\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.journeybee.io/v1/partners/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"status\": \"not-invited\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"website_url\": \"<string>\",\n \"description\": \"<string>\",\n \"stage_uuid\": \"<string>\",\n \"tier_uuid\": \"<string>\",\n \"category_uuid\": \"<string>\",\n \"tag_uuids\": [\n \"<string>\"\n ],\n \"assigned_user_uuids\": [\n \"<string>\"\n ],\n \"domains\": [\n {\n \"domain\": \"<string>\",\n \"is_primary\": false\n }\n ],\n \"custom_fields\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/partners/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"status\": \"not-invited\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"website_url\": \"<string>\",\n \"description\": \"<string>\",\n \"stage_uuid\": \"<string>\",\n \"tier_uuid\": \"<string>\",\n \"category_uuid\": \"<string>\",\n \"tag_uuids\": [\n \"<string>\"\n ],\n \"assigned_user_uuids\": [\n \"<string>\"\n ],\n \"domains\": [\n {\n \"domain\": \"<string>\",\n \"is_primary\": false\n }\n ],\n \"custom_fields\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"website_url": "<string>",
"description": "<string>",
"accepted_at": "<string>",
"invited_at": "<string>",
"stage": {
"uuid": "<string>",
"label": "<string>"
},
"tier": {
"uuid": "<string>",
"label": "<string>"
},
"category": {
"uuid": "<string>",
"label": "<string>"
},
"partner_logo_uuid": "<string>",
"partner_logo_square_uuid": "<string>",
"partner_logo_white_uuid": "<string>",
"partner_logo_square_white_uuid": "<string>",
"tags": [
{
"uuid": "<string>",
"label": "<string>"
}
],
"assigned_users": [
{
"uuid": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>"
}
],
"custom_fields": [
{
"uuid": "<string>",
"label": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"options": [
{
"id": 123,
"label": "<string>"
}
]
}
],
"domains": [
{
"uuid": "<string>",
"domain": "<string>",
"is_primary": true
}
],
"created_at": "<string>",
"updated_at": "<string>"
}Partners
Create a partner
Custom fields may be required or rule-controlled (visibility, locking, auto-population) — validation errors return per-field details with a machine-readable reason. See the Custom Field Validation section of the Error Handling guide.
POST
/
partners
/
Create a partner
curl --request POST \
--url https://api.journeybee.io/v1/partners/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"status": "not-invited",
"email": "<string>",
"phone_number": "<string>",
"website_url": "<string>",
"description": "<string>",
"stage_uuid": "<string>",
"tier_uuid": "<string>",
"category_uuid": "<string>",
"tag_uuids": [
"<string>"
],
"assigned_user_uuids": [
"<string>"
],
"domains": [
{
"domain": "<string>",
"is_primary": false
}
],
"custom_fields": [
{
"custom_field_uuid": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
}
}
]
}
'import requests
url = "https://api.journeybee.io/v1/partners/"
payload = {
"name": "<string>",
"status": "not-invited",
"email": "<string>",
"phone_number": "<string>",
"website_url": "<string>",
"description": "<string>",
"stage_uuid": "<string>",
"tier_uuid": "<string>",
"category_uuid": "<string>",
"tag_uuids": ["<string>"],
"assigned_user_uuids": ["<string>"],
"domains": [
{
"domain": "<string>",
"is_primary": False
}
],
"custom_fields": [
{
"custom_field_uuid": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": True,
"select": 123,
"multi_select": [123]
}
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
status: 'not-invited',
email: '<string>',
phone_number: '<string>',
website_url: '<string>',
description: '<string>',
stage_uuid: '<string>',
tier_uuid: '<string>',
category_uuid: '<string>',
tag_uuids: ['<string>'],
assigned_user_uuids: ['<string>'],
domains: [{domain: '<string>', is_primary: false}],
custom_fields: [
{
custom_field_uuid: '<string>',
value: {
text: '<string>',
number: 123,
date: '<string>',
boolean: true,
select: 123,
multi_select: [123]
}
}
]
})
};
fetch('https://api.journeybee.io/v1/partners/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.journeybee.io/v1/partners/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'status' => 'not-invited',
'email' => '<string>',
'phone_number' => '<string>',
'website_url' => '<string>',
'description' => '<string>',
'stage_uuid' => '<string>',
'tier_uuid' => '<string>',
'category_uuid' => '<string>',
'tag_uuids' => [
'<string>'
],
'assigned_user_uuids' => [
'<string>'
],
'domains' => [
[
'domain' => '<string>',
'is_primary' => false
]
],
'custom_fields' => [
[
'custom_field_uuid' => '<string>',
'value' => [
'text' => '<string>',
'number' => 123,
'date' => '<string>',
'boolean' => true,
'select' => 123,
'multi_select' => [
123
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.journeybee.io/v1/partners/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"status\": \"not-invited\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"website_url\": \"<string>\",\n \"description\": \"<string>\",\n \"stage_uuid\": \"<string>\",\n \"tier_uuid\": \"<string>\",\n \"category_uuid\": \"<string>\",\n \"tag_uuids\": [\n \"<string>\"\n ],\n \"assigned_user_uuids\": [\n \"<string>\"\n ],\n \"domains\": [\n {\n \"domain\": \"<string>\",\n \"is_primary\": false\n }\n ],\n \"custom_fields\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.journeybee.io/v1/partners/")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"status\": \"not-invited\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"website_url\": \"<string>\",\n \"description\": \"<string>\",\n \"stage_uuid\": \"<string>\",\n \"tier_uuid\": \"<string>\",\n \"category_uuid\": \"<string>\",\n \"tag_uuids\": [\n \"<string>\"\n ],\n \"assigned_user_uuids\": [\n \"<string>\"\n ],\n \"domains\": [\n {\n \"domain\": \"<string>\",\n \"is_primary\": false\n }\n ],\n \"custom_fields\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.journeybee.io/v1/partners/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"status\": \"not-invited\",\n \"email\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"website_url\": \"<string>\",\n \"description\": \"<string>\",\n \"stage_uuid\": \"<string>\",\n \"tier_uuid\": \"<string>\",\n \"category_uuid\": \"<string>\",\n \"tag_uuids\": [\n \"<string>\"\n ],\n \"assigned_user_uuids\": [\n \"<string>\"\n ],\n \"domains\": [\n {\n \"domain\": \"<string>\",\n \"is_primary\": false\n }\n ],\n \"custom_fields\": [\n {\n \"custom_field_uuid\": \"<string>\",\n \"value\": {\n \"text\": \"<string>\",\n \"number\": 123,\n \"date\": \"<string>\",\n \"boolean\": true,\n \"select\": 123,\n \"multi_select\": [\n 123\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"uuid": "<string>",
"name": "<string>",
"email": "<string>",
"phone_number": "<string>",
"website_url": "<string>",
"description": "<string>",
"accepted_at": "<string>",
"invited_at": "<string>",
"stage": {
"uuid": "<string>",
"label": "<string>"
},
"tier": {
"uuid": "<string>",
"label": "<string>"
},
"category": {
"uuid": "<string>",
"label": "<string>"
},
"partner_logo_uuid": "<string>",
"partner_logo_square_uuid": "<string>",
"partner_logo_white_uuid": "<string>",
"partner_logo_square_white_uuid": "<string>",
"tags": [
{
"uuid": "<string>",
"label": "<string>"
}
],
"assigned_users": [
{
"uuid": "<string>",
"email": "<string>",
"first_name": "<string>",
"last_name": "<string>"
}
],
"custom_fields": [
{
"uuid": "<string>",
"label": "<string>",
"value": {
"text": "<string>",
"number": 123,
"date": "<string>",
"boolean": true,
"select": 123,
"multi_select": [
123
]
},
"options": [
{
"id": 123,
"label": "<string>"
}
]
}
],
"domains": [
{
"uuid": "<string>",
"domain": "<string>",
"is_primary": true
}
],
"created_at": "<string>",
"updated_at": "<string>"
}Authorizations
API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".
Body
application/json
Available options:
referral, reseller, distributor Available options:
invited, not-invited, accepted, archived Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
201 - application/json
Default Response
Available options:
referral, reseller, distributor Available options:
invited, not-invited, accepted, archived Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I