Authentication
curl -X POST "https://app.journeybee.io/api/v1/partnerships" \
-H "Authorization: Bearer your-api-key-uuid" \
-H "Content-Type: application/json" \
-d '{"name": "Partner Company", "emails": [{"email": "contact@partner.com"}]}'
Request Body Schema
The name of the partner company
Array of contact email objects for the partner
Contact email address (must be valid business email)
Array of tag IDs to assign to this contact
Type of partnership. Options: referral
, reseller
ID of the tier to assign to this partner
ID of the category to assign to this partner
UUID of the stage to assign to this partner
Whether to create the partnership as inactive (won’t send invites)
ID of the partner’s country
Partner’s email domain (auto-detected from email if not provided)
For reseller partnerships, specify who is the reseller. Options: company
, partner
Array of user IDs to assign to this partnership
Array of tag IDs to assign to this partnership
Array of custom field values
Field type: text
, textarea
, number
, date
, boolean
, select
, multi_select
Field value object matching the field typeShow Value Object Examples
For date fields (ISO format)
For select fields (option ID)
For multi-select fields (array of option IDs)
Response Schema
The API returns a 201 Created
status code on success with no response body, but triggers the partnership creation and invitation flow.
Example Request
curl -X POST "https://app.journeybee.io/api/v1/companies/123/partnerships" \
-H "Authorization: Bearer jb_api_1234567890abcdef" \
-H "Content-Type: application/json" \
-d '{
"name": "TechCorp Solutions",
"emails": [
{
"email": "john@techcorp.com",
"firstName": "John",
"lastName": "Smith",
"tags": [1, 2]
}
],
"partnerType": "referral",
"tierId": 2,
"categoryId": 3,
"countryId": 1,
"assignedUsers": [456],
"tags": [10, 11],
"customFields": [
{
"customFieldId": 5,
"type": "number",
"value": {
"number": 100000
}
},
{
"customFieldId": 6,
"type": "select",
"value": {
"select": 2
}
}
]
}'
Example Response
{
"status": "created",
"message": "Partnership created successfully"
}
Error Responses
{
"error": "Invalid email format or missing required fields"
}
{
"error": "Invalid API key or insufficient permissions"
}
{
"error": "Write access required for this operation"
}
{
"error": "Invalid email domains or attempting to partner with self"
}
{
"error": "Partnership already exists with this company"
}
Notes
- Requires API key with
write_access
permission
- All emails must be from the same business domain
- Triggers email invitations unless
inactive: true
is specified