Postman Collection

Hellomateo API Documentation

Understand general concepts, response codes, and authentication strategies.

Introduction

To ensure reliabilty and performance, we have certain limits in place. Learn more about them here.

Limits

Using the GET method, you can retrieve rows.

Read Data

You can insert new data using the POST method

Insert Data

Using the PATCH method, you can update rows.

Update Data

Using either POST or PUT, you can upsert rows.

Upsert Data

Using the DELETE method, you can remove rows.

Delete Data

Learn how to paginate through large data sets.

Pagination

Our API supports including related resources in a single API call. This reduces the need for many API requests.

Resource Embedding

Automatically trigger HTTP callbacks on events in hellomateo to build custom integrations, notifications, and workflows.

Setting up Webhooks

Learn about the webhook events and HTTP responses sent by Hellomateo webhooks.

Webhook Events Reference

Send Message

Send a Broadcast message to a list of recipients and / or segments

Send Broadcast Message

List Channels

List Contacts

Create Contact

Delete Contact

Update Contact

Merge Contacts

List Contact Lists

Create Contact List

Delete Contact List

Update Contact List

List Contact Notes

Create Contact Note

Delete Contact Note

Update Contact Note

Retrieve a list of marketing subscriptions

List Marketing Subscriptions

Create Marketing Subscription

Delete an existing marketing subscription

Delete Marketing Subscription

Update an existing marketing subscription

Update Marketing Subscription

List Custom Fields

Create Custom Field

Delete Custom Field

Update Custom Field

List Contact Custom Fields

Create Contact Custom Field

Delete Contact Custom Field

Update Contact Custom Field

List Deals

Create Deal

Delete Deal

Update Deal

List Deal Custom Fields

Create Deal Custom Field

Delete Deal Custom Field

Update Deal Custom Field

List Appointments

Create Appointment

Delete Appointment

Update Appointment

Retrieve a list of appointment custom fields

List Appointment Custom Fields

Create Appointment Custom Field

Delete an existing appointment custom field

Delete Appointment Custom Field

Update an existing appointment custom field

Update Appointment Custom Field

List Marketing Channels

Retrieve a list of contact data with marketing channels and custom fields

List Contact Details

Create a new contact data with marketing channels and custom fields

Create Contact Details

Delete a contact with marketing channels and custom fields

Delete Contact Details

Update an existing contact data with marketing channels and custom fields

Update Contact Details

Retrieve a list of deal data with custom fields

List Deal Details

Create a new deal data with custom fields

Create Deal Details

Delete Deal Details

Update an existing deal data with custom fields

Update Deal Details

Retrieve a list of appointment data with custom fields

List Appointment Details

Create a new appointment data with custom fields

Create Appointment Details

Delete Appointment Details

Update an existing appointment data with custom fields

Update Appointment Details

List Conversations

Update Conversation

List Comments

Create Comment

List Messages

Delete Message

List Templates

Delete Template

Create a signed url for an object in a bucket. You can use this url to download the object

Create Signed Url

List Recipients

List Message Actions

List Events

List Conversation Tags

Create Conversation Tag

Delete Conversation Tag

Update Conversation Tag

List Employees

Create Employee

Update Employee

Format phone numbers to E.164 format with specified country codes

Format Phone Numbers

Parse any HTML or text into our multi-channel messaging schema

Generate Content

List Imports

Create Import

List Providers

Retrieve a list of provider template approvals

List Provider Template Approvals

List Webhooks

Create Webhook

Delete Webhook

Update Webhook

List Campaigns

A collection of recipes for common use cases.

Learn how to efficiently import contacts into Hellomateo.

Contact Import

Learn how to setup a (bi-directional) contact sync between Hellomateo and an external system.

Documentation

Working with the API

Webhooks

Resources

Postman Collection