GuidesAPI ReferenceZapier API
Leads

Update Lead

Update a new lead entry. The lead will be associated with the organization of the API key.

PUT
/v1/leads/{leadId}

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer token authentication for API access.

In: header

Path Parameters

leadId*string

The unique identifier of the lead

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/v1/leads/ld_abc123" \  -H "Content-Type: application/json" \  -d '{}'
{  "lead": {    "id": "ld_abc123",    "firstName": "John",    "lastName": "Doe",    "email": "john.doe@example.com",    "phone": "+1234567890",    "suburb": "Downtown",    "businessName": "Acme Corp",    "socials": {},    "status": "active",    "createdAt": "2023-01-01T00:00:00.000Z"  }}
{  "success": false,  "message": "Invalid or expired token",  "error": {    "status": 401,    "message": "Invalid or expired token"  }}
{  "success": false,  "message": "Conflict",  "error": {    "status": 409,    "message": "Conflict"  }}
{  "success": false,  "message": "Internal server error",  "error": {    "status": 500,    "message": "Internal server error"  }}

List Leads GET

Retrieve a paginated list of leads. Returns lead data including contact information, status, and inquiry statistics. Results are filtered by the organization associated with the API key.

List Members GET

Retrieve a paginated list of members. Results are filtered by the organization associated with the API key.