Inbox

Preview replace lead

Read-only preview of what replaceThreadLead would do for a candidate email on this thread. Call this before writing when you need to know whether the address will create a new contact or attach to an existing campaign lead, whether the address is on the block list, and whether the attach would be refused (same email as the current lead, or existing contact with no live enrollment). mode, allowed, and disallowed_reason use the same vocabulary as the write path errors.

GET/v1/threads/{id}/replace-lead/preview

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Path Parameters

idstring

Inbox thread id.

Formatuuid

Query Parameters

emailstring

Candidate replacement email to preview.

Formatemail

curl -X GET "https://example.com/v1/threads/497f6eca-6276-4993-bfeb-53cbbbba6f08/replace-lead/preview?email=user%40example.com"

{  "data": {    "email": "string",    "mode": "created",    "allowed": true,    "disallowed_reason": "same_as_current_lead",    "match_count": 0,    "matches_current_lead": true,    "blocked": true,    "block_reason": "string",    "existing_lead": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "email": "string",      "name": "string",      "first_name": "string",      "last_name": "string",      "phone_number": "string",      "mobile_phone_number": "string",      "company_name": "string",      "website": "string",      "linkedin_url": "string",      "company_linkedin_url": "string",      "custom_lead_data": {},      "enrollment_id": "cd8e6b59-f5cf-4894-8850-4dc2dc1aaf8e",      "enrollment_state": "active",      "has_been_contacted": true,      "last_activity_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"  }}