Heyy

Delete API webhook via DELETE /api_webhooks/{webhookId}. DESTRUCTIVE and not reversible through this API: Heyy's v3 contract publishes no undelete and no recycle bin, so the only recovery is re-creating the resource.

Delete attribute via DELETE /attributes/{attributeId}. DESTRUCTIVE and not reversible through this API: Heyy's v3 contract publishes no undelete and no recycle bin, so the only recovery is re-creating the resource.

Delete campaign via DELETE /campaigns/{campaignId}. DESTRUCTIVE and not reversible through this API: Heyy's v3 contract publishes no undelete and no recycle bin, so the only recovery is re-creating the resource.

Remove recipients via DELETE /campaigns/{campaignId}/recipients. Names the recipients to remove in a JSON BODY -- the campaign is in the path, the recipients are not -- so this is one of only two DELETEs on this surface that sends a body. A caller that sends none removes nothing while the call still succeeds. DESTRUCTIVE and not reversible through this API: Heyy's v3 contract publishes no undelete and no recycle bin, so the only recovery is re-creating the resource.

Delete chat via DELETE /chats/{chatId}. DESTRUCTIVE and not reversible through this API: Heyy's v3 contract publishes no undelete and no recycle bin, so the only recovery is re-creating the resource.

Delete contact via DELETE /contacts/{contactId}. DESTRUCTIVE and not reversible through this API: Heyy's v3 contract publishes no undelete and no recycle bin, so the only recovery is re-creating the resource.

Remove labels from contact via DELETE /contacts/{contactId}/labels. Names the labels to remove in a JSON BODY, not in the path, so this is the second of only two DELETEs on this surface that sends a body. It detaches labels from the contact and does not delete the labels themselves -- Delete label is what destroys a label for the whole workspace. DESTRUCTIVE and not reversible through this API: Heyy's v3 contract publishes no undelete and no recycle bin, so the only recovery is re-creating the resource.

Delete label via DELETE /labels/{labelId}. DESTRUCTIVE and not reversible through this API: Heyy's v3 contract publishes no undelete and no recycle bin, so the only recovery is re-creating the resource.

Delete message template via DELETE /message_templates/{messageTemplateId}. DESTRUCTIVE and not reversible through this API: Heyy's v3 contract publishes no undelete and no recycle bin, so the only recovery is re-creating the resource.

Delete team via DELETE /teams/{teamId}. DESTRUCTIVE and not reversible through this API: Heyy's v3 contract publishes no undelete and no recycle bin, so the only recovery is re-creating the resource.

Get attribute via GET /attributes/{attributeId}.

Get automation via GET /automations/{automationId}.

Get campaign via GET /campaigns/{campaignId}.

Get channel via GET /channels/{channelId}.

Get chat via GET /chats/{chatId}.

Get contact via GET /contacts/{contactId}.

Get file via GET /files/{fileId}. Reads a file record that already exists in the workspace. UPLOADING is not part of this integration: Heyy's `POST /files` is a multipart binary upload and is withheld, so a `fileId` referenced by the message, template and campaign tools has to be created in the Heyy app or by calling that endpoint outside Agentic Fabriq.

Get public file URL via GET /files/{fileId}/public_url. Returns a stable public URL for an uploaded file, creating one if it does not exist yet. Use this URL when referencing the file by URL (for example, in automation template media overrides). The URL does not expire.

Get journey via GET /journeys/{journeyId}.

Get label via GET /labels/{labelId}.

Get message template via GET /message_templates/{messageTemplateId}.

Get team via GET /teams/{teamId}.

Get users via GET /users. Returns the workspace's members. This is a plain GET rather than a `POST /users/search`, so it takes no filter, sort or page arguments at all -- the two listings that behave this way are users and workspace.

Get user via GET /users/{userId}.

Get workspace via GET /workspace. Returns the workspace associated with the API key. Takes no arguments and is the cheapest read on the surface, which is why it is also what Agentic Fabriq probes a pasted API key with: the key identifies its own workspace, so there is nothing to select.

Create API webhook via POST /api_webhooks. Registers a URL Heyy will POST workspace events to. The delivery target is the customer's own endpoint, so anything this webhook is pointed at receives Heyy's event payloads -- including message content -- until the webhook is deleted.

Search API webhooks via POST /api_webhooks/search. This is a LIST endpoint even though it is a POST: filtering (`query`), ordering (`sortBy`), free-text matching (`search`) and paging (`pagination`, zero-based `page` with a `limit` of 1-100, default 10) all travel in the request body, and the response wraps the rows in `data` with a `pagination.total`. Send an empty body to get the first page unfiltered.

Create attribute via POST /attributes.

Search attributes via POST /attributes/search. This is a LIST endpoint even though it is a POST: filtering (`query`), ordering (`sortBy`), free-text matching (`search`) and paging (`pagination`, zero-based `page` with a `limit` of 1-100, default 10) all travel in the request body, and the response wraps the rows in `data` with a `pagination.total`. Send an empty body to get the first page unfiltered.

Pause automation via POST /automations/{automationId}/pause.

Trigger automation via POST /automations/{automationId}/trigger. Starts an automation for a contact, with input parameters. Heyy names this as the SAFER way to reach a contact than sending directly: an automation can carry a subscription condition, while the message tools check nothing. What the automation then does -- including sending -- is configured in Heyy, not here, so the effect of this call is whatever that automation is built to do.

Unpause automation via POST /automations/{automationId}/unpause.

Search automations via POST /automations/search. This is a LIST endpoint even though it is a POST: filtering (`query`), ordering (`sortBy`), free-text matching (`search`) and paging (`pagination`, zero-based `page` with a `limit` of 1-100, default 10) all travel in the request body, and the response wraps the rows in `data` with a `pagination.total`. Send an empty body to get the first page unfiltered.

Create campaign via POST /campaigns.

Add recipients via POST /campaigns/{campaignId}/recipients.

Start campaign via POST /campaigns/{campaignId}/start. Starts the campaign SENDING. This is the point of no return for a broadcast: every recipient currently on the campaign is messaged, the sends are billed as message credits, and nothing in this API unsends them. Read the campaign and its recipients back before calling it.

Search campaigns via POST /campaigns/search. This is a LIST endpoint even though it is a POST: filtering (`query`), ordering (`sortBy`), free-text matching (`search`) and paging (`pagination`, zero-based `page` with a `limit` of 1-100, default 10) all travel in the request body, and the response wraps the rows in `data` with a `pagination.total`. Send an empty body to get the first page unfiltered.

Search channels via POST /channels/search. This is a LIST endpoint even though it is a POST: filtering (`query`), ordering (`sortBy`), free-text matching (`search`) and paging (`pagination`, zero-based `page` with a `limit` of 1-100, default 10) all travel in the request body, and the response wraps the rows in `data` with a `pagination.total`. Send an empty body to get the first page unfiltered.

Assign chat to team via POST /chats/{chatId}/assign_team.

Assign chat to user via POST /chats/{chatId}/assign_user.

Mark chat as not sensitive via POST /chats/{chatId}/mark_as_not_sensitive. Clears the sensitive flag, which WIDENS who on the team can read the conversation. It is the reverse of Mark chat as sensitive and is not classified destructive, but it does expose a chat that somebody deliberately restricted.

Mark chat as read via POST /chats/{chatId}/mark_as_read.

Mark chat as sensitive via POST /chats/{chatId}/mark_as_sensitive. Flags the conversation as containing sensitive information, which is a visibility control inside Heyy rather than a note: it restricts who on the team can read the chat.

Mark chat as unread via POST /chats/{chatId}/mark_as_unread.

Change chat status via POST /chats/{chatId}/status.

Search chats via POST /chats/search. This is a LIST endpoint even though it is a POST: filtering (`query`), ordering (`sortBy`), free-text matching (`search`) and paging (`pagination`, zero-based `page` with a `limit` of 1-100, default 10) all travel in the request body, and the response wraps the rows in `data` with a `pagination.total`. Send an empty body to get the first page unfiltered.

Create contact via POST /contacts.

Bulk upsert contacts via POST /contacts/bulk. Upserts many contacts in one call, with the same match-by-identifier behaviour as Upsert contact. A partial failure is reported by Heyy in the response rather than raised here, so read the result instead of treating a 200 as "all rows landed".

Add labels to contact via POST /contacts/{contactId}/labels. Attaches existing labels to the contact. It does not create a label -- Create label does that -- and labels are what the campaign and search tools filter audiences on, so adding one can change who a scheduled campaign reaches.

Subscribe contact via POST /contacts/{contactId}/subscribe.

Unsubscribe contact via POST /contacts/{contactId}/unsubscribe. Records that the contact has opted out. It does not by itself stop the message tools: Send message and Send template message deliver to an unsubscribed contact, because Heyy makes the consent check the caller's responsibility.

Search contacts via POST /contacts/search. This is a LIST endpoint even though it is a POST: filtering (`query`), ordering (`sortBy`), free-text matching (`search`) and paging (`pagination`, zero-based `page` with a `limit` of 1-100, default 10) all travel in the request body, and the response wraps the rows in `data` with a `pagination.total`. Send an empty body to get the first page unfiltered.

Upsert contact via POST /contacts/upsert. Creates the contact or MATCHES an existing one by identifier (phone number or email) and updates it. This is the tool to use when the identifier may already exist -- Create contact fails on a duplicate, and Update contact cannot change a phone number or an email at all.

Subscribe contacts to journey via POST /journeys/{journeyId}/subscribe. Adds contacts to a journey, which may begin messaging them immediately depending on how the journey is built in Heyy.

Unsubscribe contacts from journey via POST /journeys/{journeyId}/unsubscribe.

Search journeys via POST /journeys/search. This is a LIST endpoint even though it is a POST: filtering (`query`), ordering (`sortBy`), free-text matching (`search`) and paging (`pagination`, zero-based `page` with a `limit` of 1-100, default 10) all travel in the request body, and the response wraps the rows in `data` with a `pagination.total`. Send an empty body to get the first page unfiltered.

Create label via POST /labels.

Search labels via POST /labels/search. This is a LIST endpoint even though it is a POST: filtering (`query`), ordering (`sortBy`), free-text matching (`search`) and paging (`pagination`, zero-based `page` with a `limit` of 1-100, default 10) all travel in the request body, and the response wraps the rows in `data` with a `pagination.total`. Send an empty body to get the first page unfiltered.

Create message template via POST /message_templates.

Search message templates via POST /message_templates/search. This is a LIST endpoint even though it is a POST: filtering (`query`), ordering (`sortBy`), free-text matching (`search`) and paging (`pagination`, zero-based `page` with a `limit` of 1-100, default 10) all travel in the request body, and the response wraps the rows in `data` with a `pagination.total`. Send an empty body to get the first page unfiltered.

Send message via POST /messages/send. Sends a free-form message on a channel the workspace has already connected. TWO THINGS THIS SPENDS THAT NO OTHER TOOL DOES. It contacts a real person, and on WhatsApp it consumes message credits, which Heyy bills on top of the plan -- there is no dry run. And consent is the CALLER's job: Heyy's own reference states that for a MARKETING message "you are responsible for confirming the contact is subscribed before you call it. The message will be sent even if the contact is unsubscribed." Check `isSubscribed` with Get contact first, or use Trigger automation, which Heyy names as the path where a subscription condition can gate the send. Free-form replies also stop working once the channel's conversation window has closed; that is when a template message is the only form that will deliver.

Send template message via POST /messages/send_template. Sends a pre-approved template message, which is what reaches a contact AFTER the channel's free-form conversation window has closed. The same consent rule applies verbatim: for a MARKETING message "you are responsible for confirming the contact is subscribed before you call it. The message will be sent even if the contact is unsubscribed." WhatsApp templates are approved by Meta rather than by Heyy, so a template that is not approved for the channel fails at Heyy's end rather than here, and the same message credits are spent.

Create team via POST /teams.

Search teams via POST /teams/search. This is a LIST endpoint even though it is a POST: filtering (`query`), ordering (`sortBy`), free-text matching (`search`) and paging (`pagination`, zero-based `page` with a `limit` of 1-100, default 10) all travel in the request body, and the response wraps the rows in `data` with a `pagination.total`. Send an empty body to get the first page unfiltered.

Update API webhook via PUT /api_webhooks/{webhookId}.

Update attribute via PUT /attributes/{attributeId}.

Update campaign via PUT /campaigns/{campaignId}.

Update contact via PUT /contacts/{contactId}. Updates contact profile fields (first name, last name, and custom attributes). Phone number and email cannot be changed here — use upsert to create or match by identifier.

Update label via PUT /labels/{labelId}.

Update message template via PUT /message_templates/{messageTemplateId}.

Update team via PUT /teams/{teamId}.