Leads

Update a lead by ID

Updates one lead, whether or not it is in a campaign. Only the fields you send are changed. A field you leave out, or send as null, is left as it is. Send an empty string to clear a field. customVariables, when sent, replaces the whole set, so an empty object clears it; leave it out to keep the set. A new email changes this lead's address; if another lead in the workspace already has that address the call fails with 409 and nothing is changed. Emails not sent yet are written from the lead as it is when they go out, so a change shows up in them. An email already scheduled still goes to the address the lead had when it was scheduled. The response holds only the lead's id, email, firstName, lastName and customVariables. Read the full lead with GET /leads/{id}.

put/leads/{id}

Request

  • Base URL: https://api.emailchaser.com/r
  • URL: https://api.emailchaser.com/r/leads/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Lead ID

Request body

companystring
customVariablesobject

CustomVariables replaces the lead's whole custom variable map when provided. Omit it to leave the existing variables untouched.

emailstring

Changes this lead's address. Refused with 409 if another lead in the workspace already has it.

firstNamestring
lastNamestring
linkedinstring
middleNamestring
phonestring
titlestring
websitestring

Response

Lead updated successfully

messagestring

Example response

{
  "lead": {
    "email": "john.doe@example.com",
    "firstName": "John",
    "id": 123,
    "lastName": "Doe"
  },
  "message": "lead updated successfully"
}

Changes

No recorded changes to this operation across all 1 revision of this API.