Skip to main content
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
        ]
      }
    }
  ]
}
'
{
  "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

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
required
tier
object
required
category
object
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