POST
/
contacts
/
v1
/
secondary-email
/
{vid}
Create a new contact
curl --request POST \
  --url https://api.hubapi.com/contacts/v1/secondary-email/{vid}
"\nExample PATCH URL:\nhttps://api.hubapi.com/contacts/v1/secondary-email/21316\n\nExample PATCH Body:\n{\n  \"targetSecondaryEmail\": \"oldAddress@hubspot.com\",\n  \"updatedSecondaryEmail\": \"updatedAddress@hubspot.com\"\n}\n\nExample response:\n{\n    \"portalId\": 589323,\n    \"vid\": 21316,\n    \"secondaryEmails\": [\n        \"updatedAddress@hubspot.com\"\n    ]\n}"

Query Parameters

​
q
string
required

The search term for what you're searching for. You can use all of a word or just parts of a word as well. For example, if you we're searching for contacts with "hubspot" in their name or email, searching for "hub" would also return contacts with "hubspot" in their email address.

​
count
string

This parameter lets you specify the amount of contacts to return in your API call. The default for this parameter (if it isn't specified) is 20 contacts. The maximum amount of contacts you can have returned to you via this parameter is 100.

​
offset
string

If you include the "property" parameter, then the properties in the "contact" object in the returned data will only include the property or properties that you request.

​
sort
string

This parameter takes in an internal property name (e.g. vid) and sorts contact search results by that field.

​
order
string

This parameter accepts DESC or ASC as values (defaults to DESC) to order results by the property specified in "sort" parameter. As such, this parameter will only work when used in conjunction with "sort".

Response

200 - application/json

Successful response - This endpoint is used to get contacts by email address, first and last name, phone number, or company

The response is of type object.