Heyy

Heyy integration (Communication, Marketing). Imported from open-connector.

API key9 toolshttps://api.heyy.io/api/v2.0

GET

heyy_list_contacts

List Heyy contacts with optional pagination, sorting, and search.

/contacts

5 parameters

Param	Type	Required	Description
page	integer	optional	The Heyy contacts page number.
pageSize	integer	optional	The number of Heyy contacts to return.
sortBy	string	optional	The Heyy contact field to sort by.
order	string	optional	The Heyy contact sort order.
search	string	optional	Search text used to filter Heyy contacts.

GET

heyy_get_contact

Retrieve one Heyy contact by ID.

/contacts/{contactId}

1 parameter

Param	Type	Required	Description
contactId	string	required	The Heyy contact ID.

POST

heyy_create_contact

Create a Heyy contact with profile fields, labels, and custom attributes.

/contacts

6 parameters

Param	Type	Required	Description
firstName	string	optional	—
lastName	string	optional	—
email	string	optional	—
phoneNumber	string	optional	—
labels	array	optional	Labels to assign to the contact.
attributes	array	optional	Custom attribute values to assign to the contact.

PUT

heyy_update_contact

Update a Heyy contact's profile fields, labels, or custom attributes.

/contacts/{contactId}

5 parameters

Param	Type	Required	Description
contactId	string	required	The Heyy contact ID.
firstName	string	optional	—
lastName	string	optional	—
labels	array	optional	Labels to assign to the contact.
attributes	array	optional	Custom attribute values to assign to the contact.

GET

heyy_list_labels

List Heyy labels.

/labels

POST

heyy_create_label

Create a Heyy label.

/labels

1 parameter

Param	Type	Required	Description
name	string	required	The Heyy label name.

GET

heyy_list_attributes

List Heyy contact attribute definitions.

/attributes

POST

heyy_create_attribute

Create a Heyy contact attribute definition.

/attributes

6 parameters

Param	Type	Required	Description
name	string	required	The Heyy attribute name.
externalId	string	required	The Heyy attribute external ID.
description	string	optional	—
isVisibleQuickEdit	boolean	optional	Whether the attribute is visible in quick edit.
isVisibleContactsTable	boolean	optional	Whether the attribute is visible in the contacts table.
isVisibleContactCreate	boolean	optional	Whether the attribute is visible while creating contacts.

GET

heyy_list_channels

List Heyy communication channels.

/channels