Prospects

Update a prospect

Partial update of a prospect. Accepts every field the in-app contact editor exposes except email (change the address in the app) and status (bounced / unsubscribed / do-not-contact cannot be lifted here). website, country, city, industry, tags and custom fields are included. linkedinUrl, instagramUsername and whatsappPhone may be set or cleared (null). A field name that is not on this list is refused and named in the error.

Required scope: prospects:write.

patch/prospects/{id}

Request

Base URL: https://warmysender.com/api/v1
URL: https://warmysender.com/api/v1/prospects/{id}
Auth: HTTP bearer

Path parameters

idstring required

Prospect id (UUID).

Request body

firstNamestring nullable

First name, or null to clear.

lastNamestring nullable

Last name, or null to clear.

companystring nullable

Company, or null to clear.

rolestring nullable

Role, or null to clear.

phonestring nullable

Phone, or null to clear.

linkedinUrlstring uri nullable

LinkedIn URL, or null to clear.

instagramUsernamestring nullable

Instagram handle (with or without the leading @, or a full instagram.com profile URL), or null to clear.

whatsappPhonestring nullable

WhatsApp number in any format, or null to clear. A number that cannot be read as a real phone number clears the field rather than being stored as typed.

websitestring nullable

Website.

countrystring nullable

Country.

citystring nullable

City.

industrystring nullable

Industry.

tagsstring[]

Tags (replaces the existing set). A comma-separated string is also accepted; null or an empty list clears all tags.

customFieldsobject nullable

Custom fields, merged per name. Names you omit are left unchanged. Set a name to null to remove that field. Send null for the whole object to remove every custom field. An empty object {} changes nothing.

Response

Success

Changes

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