Hyros icon

Hyros

Interact with Hyros API - Complete coverage of all endpoints

Actions60

Lead → Update

AI-generated

Summary

Update an existing lead in Hyros by searching for the lead using email, ID, or phone number and applying specified changes.

Inputs

  • Search By (required) — Choose the parameter to search the lead by (email, ID, or phone).
  • Search Value (required) — The value corresponding to the chosen search parameter to identify the lead to update.
  • Additional Fields — Optional fields to update for the lead, including: new email, first name, last name, phone numbers, ad optimization consent status, lead IP addresses, tags (to add or remove), tag assignment date, lead stage details (to add or remove stages).

Output shape

a single object representing the updated lead or an error response if updating fails.

The API requires at least one valid identifier in search parameters and fields must not be empty strings; date fields must be in proper ISO 8601 without fractional seconds. Removing unknown lead stages causes a 400 error; stages not held by the lead are ignored. Lists like phone numbers and tags must be passed as comma-separated strings and are processed as arrays by the API.

Examples

Example 1: Update a lead's first name and add tags by searching with email.

Set 'Search By' to 'Email', provide the lead's email as 'Search Value', then specify 'First Name' and 'Tags' under Additional Fields.

Links

Discussion