Lead API: set CRM ID

Overview

This API endpoint allows you to update an already exported lead record by adding your custom CRM object ID and description.

Prerequisites

• You must be familiar with the Teamfluence API (link to getting started guide).

Endpoint

PATCH /{profile_id}/leads/{lead_id}

Parameters:

• <profile_id> – Your unique profile identifier, found in the Profile Settings.
• <lead_id> – The lead record ID, which appears in the webhook payload.

Note: All API calls using a given <profile_id> apply only to the corresponding teamspace.

Request Body

{
    "crm_id": "Aa890435348",
    "crm_meta": "Last interaction with [email protected] 9d ago"
}

Fields:

• crm_id (required) – A reference to your CRM object ID.
• crm_meta (optional) – A text field for additional metadata, such as interaction history or notes.

Usage Notes

• Updating a lead with your CRM object ID enables tracking of its status changes via webhooks using your internal reference.