---
title: Vendor Lead
slug: docs/vendor-lead
createdAt: 2026-07-08T06:26:57.280Z
---

The **Vendor Leads** endpoint sends a Lead captured by a Vendor, linking a Person to a Vendor. Its endpoint is served at `/updates/api/{endpoint-uuid}/vendor-leads.`

## How it works

The template is the shape of the payload you want out. Each key is yours to name; the merge tag on the right supplies the value at send time. One key carries a JSON value rather than text, so its tag sits **without quotes**: tags. Everything else is plain text and stays quoted.

This record links a Person to a Vendor. The Vendor is identified by `vendor_id` and `vendor_organisation_uid`; the Person by `event_person_id` and `person_organisation_uid`.

## Sample mapping

:::BlockQuote
\{
&#x20;   "resource\_id": "\<\<RESOURCE\_ID>>",
&#x20;   "vendor\_id": "\<\<VENDOR\_ID>>",
&#x20;   "vendor\_organisation\_uid": "\<\<VENDOR\_ORGANISATION\_UID>>",
&#x20;   "event\_person\_id": "\<\<EVENT\_PERSON\_ID>>",
&#x20;   "person\_organisation\_uid": "\<\<PERSON\_ORGANISATION\_UID>>",
&#x20;   "notes": "\<\<NOTES>>",
&#x20;   "tags": \<\<TAGS\_LIST|format\:json>>,
&#x20;   "updated\_at": "\<\<UPDATED\_AT>>",
&#x20;   "created\_at": "\<\<CREATED\_AT>>"
}
:::

## Sample output

One rendered Lead from the array the endpoint returns:

:::BlockQuote
\{
&#x20; "resource\_id": "your-instance/lead/78",
&#x20; "vendor\_id": "your-instance/vendor/895",
&#x20; "vendor\_organisation\_uid": "a1s2d3f4g5h6j7k8",
&#x20; "event\_person\_id": "your-instance/event\_person/4676",
&#x20; "person\_organisation\_uid": "8297d773-016c-4423-8133-7f1edc158898",
&#x20; "notes": "Interested in the enterprise plan. Follow up next week.",
&#x20; "tags": \[
&#x20;   "hot-lead",
&#x20;   "enterprise"
&#x20; ],
&#x20; "updated\_at": "2026-04-11T07:53:41.000000Z",
&#x20; "created\_at": "2026-04-10T23:16:17.000000Z"
}
:::

## Field reference

| Key                       | Merge tag                       | Emits                                                    |
| ------------------------- | ------------------------------- | -------------------------------------------------------- |
| resource\_id              | \<\<RESOURCE\_ID>>              | Text. The Lead's resource ID.                            |
| vendor\_id                | \<\<VENDOR\_ID>>                | Text. The linked Vendor's resource ID.                   |
| vendor\_organisation\_uid | \<\<VENDOR\_ORGANISATION\_UID>> | Text. Your own identifier for the Vendor.                |
| event\_person\_id         | \<\<EVENT\_PERSON\_ID>>         | Text. The linked Person's resource ID.                   |
| person\_organisation\_uid | \<\<PERSON\_ORGANISATION\_UID>> | Text. Your own identifier for the Person.                |
| notes                     | \<\<NOTES>>                     | Text. Free-text notes captured against the Lead.         |
| tags                      | \<\<TAGS\_LIST\|format\:json>>  | JSON array of the Lead's Tags. Unquoted in the template. |
| updated\_at               | \<\<UPDATED\_AT>>               | Text. ISO 8601 timestamp.                                |
| created\_at               | \<\<CREATED\_AT>>               | Text. ISO 8601 timestamp.                                |

