PATCH
/
api
/
v1
/
partnerships
/
{partnershipId}
Update Partner
curl --request PATCH \
  --url https://app.journeybee.io/api/v1/partnerships/{partnershipId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tierId": 123,
  "categoryId": 123,
  "stageUuid": "<string>",
  "assignedUsers": [
    {}
  ],
  "tags": [
    {}
  ],
  "customFields": [
    {
      "customFieldId": 123,
      "type": "<string>",
      "value": {
        "text": "<string>",
        "number": 123,
        "date": "<string>",
        "boolean": true,
        "select": 123,
        "multi_select": [
          {}
        ]
      }
    }
  ],
  "fallbackData": {
    "name": "<string>",
    "logo_square_uuid": "<string>",
    "website_url": "<string>",
    "country_label": "<string>"
  }
}'
{
  "id": 789,
  "uuid": "partnership-uuid-789",
  "updated_at": "2024-01-15T14:30:00Z"
}

​
Authentication

curl -X PATCH "https://app.journeybee.io/api/v1/partnerships/{partnershipId}" \
  -H "Authorization: Bearer your-api-key-uuid" \
  -H "Content-Type: application/json" \
  -d '{"tierId": 3, "assignedUsers": [123, 456]}'

​
Path Parameters

​
partnershipId
number
required
The unique identifier of the company partnership to update

​
Request Body Schema

​
tierId
number
ID of the tier to assign to this partner (set to null to remove)
​
categoryId
number
ID of the category to assign to this partner (set to null to remove)
​
stageUuid
string
UUID of the stage to move this partner to
​
assignedUsers
array
Array of user IDs to assign to this partnership (replaces existing assignments)
​
tags
array
Array of tag IDs to assign to this partnership (replaces existing tags)
​
customFields
array
Array of custom field values to update
​
fallbackData
object
Fallback partner data for when partner company becomes inactive

​
Response Schema

​
id
number
The updated company partnership ID
​
uuid
string
The partnership UUID
​
updated_at
string
Timestamp of when the partnership was last updated

​
Example Request

curl -X PATCH "https://app.journeybee.io/api/v1/companies/123/partnerships/789" \
  -H "Authorization: Bearer jb_api_1234567890abcdef" \
  -H "Content-Type: application/json" \
  -d '{
    "tierId": 3,
    "categoryId": 2,
    "stageUuid": "stage-uuid-456",
    "assignedUsers": [123, 456],
    "tags": [10, 11, 12],
    "customFields": [
      {
        "customFieldId": 5,
        "type": "number",
        "value": {
          "number": 150000
        }
      },
      {
        "customFieldId": 6,
        "type": "text",
        "value": {
          "text": "Updated notes about this partnership"
        }
      }
    ],
    "fallbackData": {
      "name": "TechCorp Solutions",
      "website_url": "https://techcorp.com",
      "country_label": "United States"
    }
  }'

​
Example Response

{
  "id": 789,
  "uuid": "partnership-uuid-789",
  "updated_at": "2024-01-15T14:30:00Z"
}

​
Error Responses

{
  "error": "Invalid field values or stage UUID not found"
}

{
  "error": "Invalid API key or insufficient permissions"
}

{
  "error": "Write access required for this operation"
}

{
  "error": "Partnership not found or not accessible"
}

{
  "error": "Stage change not allowed due to business rules"
}

​
Notes

  • Requires API key with write_access permission
  • All changes trigger webhook events for external integrations