Skip to main content

Lead Metadata API

Update profile metadata for a specific lead. Metadata includes demographic and firmographic attributes such as name, company, title, and custom fields.

PATCH /lead/{leadID}/metadata

Update metadata fields on a lead. This performs a partial update -- only the fields you include in the request body are changed.

Request

ParameterTypeRequiredDescription
leadIDstringYesLead identifier (path parameter)

Request Body

Provide a JSON object with the metadata fields to update. Fields not included in the request remain unchanged.

{
"first_name": "Alex",
"last_name": "Johnson",
"company": "Acme Corp",
"title": "VP Marketing",
"industry": "Technology"
}

Response

200 OK

Returns the updated lead with all current metadata.

Example

curl -X PATCH "https://api.leadvibe.com/lead/ld_123/metadata" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"company": "Acme Corp",
"title": "VP Marketing"
}'

Common Errors

StatusMeaningSolution
400Bad RequestInvalid JSON or field values
401UnauthorizedCheck authentication token
404Not FoundLead does not exist or not accessible

Notes

  • Metadata updates use partial merge -- existing fields not in the request are preserved
  • Setting a field to null removes it from the lead's metadata
  • Profile scoring rules may recalculate after metadata changes if mapped fields are updated
  • Metadata is OU-scoped to the active Organizational Unit