People

Update person profile

Updates profile fields on every active lead row for the given global lead id (or the newest row when the person isn't in any campaign). Use it to save fields from enrichPerson. Read the saved values back with getPerson (per membership).

PATCH/v1/people/{globalLeadId}

Authorization

bearerAuth
AuthorizationBearer <token>

Use an account API key in the Authorization header: Authorization: Bearer f_....

In: header

Path Parameters

globalLeadIdstring

Stable account-scoped person id (SHA-256 of normalized email).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string
first_name?string
last_name?string
company_name?string
website?string
linkedin_url?string
company_linkedin_url?string
phone_number?string

Company phone.

mobile_phone_number?string

The person's mobile phone.

title?string

Job title. Stored as custom_lead_data.title; other custom fields are kept.

curl -X PATCH "https://example.com/v1/people/string" \  -H "Content-Type: application/json" \  -d '{    "title": "VP Sales",    "mobile_phone_number": "+18015550199",    "linkedin_url": "https://www.linkedin.com/in/jane-doe"  }'
{  "data": {    "global_lead_id": "string",    "email": "string",    "display_name": "string",    "first_name": "string",    "last_name": "string",    "campaign_count": 0,    "company_list": "string",    "has_reply": true,    "latest_activity_at": "2019-08-24T14:15:22Z",    "newest_membership_created_at": "2019-08-24T14:15:22Z",    "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",    "native_campaign_count": 0,    "smartlead_campaign_count": 0,    "updated_at": "2019-08-24T14:15:22Z"  }}
{  "error": {    "type": "invalid_request_error",    "code": "invalid_flow",    "message": "Flow validation failed"  },  "details": [    {      "path": "nodes[1].data.variants[0].id",      "code": "invalid_variant_id",      "message": "Email variants must have a stable UUID id."    }  ]}
{  "error": {    "type": "authentication_error",    "code": "invalid_api_key",    "message": "A valid Furnace API key is required"  }}
{  "error": {    "type": "invalid_request_error",    "code": "campaign_not_found",    "message": "Campaign not found"  }}
{  "error": {    "type": "rate_limit_error",    "code": "rate_limit_exceeded",    "message": "Rate limit exceeded for this account"  }}
{  "error": {    "type": "api_error",    "code": "internal_error",    "message": "Internal server error"  }}