# Hellomateo API Documentation ## Docs - [Delete Appointment Custom Field](https://docs.getmateo.com/api-reference/appointment-custom-field/delete-appointment_custom_field.md): Delete an existing appointment custom field - [List Appointment Custom Fields](https://docs.getmateo.com/api-reference/appointment-custom-field/get-appointment_custom_field.md): Retrieve a list of appointment custom fields - [Update Appointment Custom Field](https://docs.getmateo.com/api-reference/appointment-custom-field/patch-appointment_custom_field.md): Update an existing appointment custom field - [Create Appointment Custom Field](https://docs.getmateo.com/api-reference/appointment-custom-field/post-appointment_custom_field.md): Create a new appointment custom field - [Delete Appointment Details](https://docs.getmateo.com/api-reference/appointment-details/delete-appointment_details.md): Delete an appointment with custom fields - [List Appointment Details](https://docs.getmateo.com/api-reference/appointment-details/get-appointment_details.md): Retrieve a list of appointment data with custom fields - [Update Appointment Details](https://docs.getmateo.com/api-reference/appointment-details/patch-appointment_details.md): Update an existing appointment data with custom fields - [Create Appointment Details](https://docs.getmateo.com/api-reference/appointment-details/post-appointment_details.md): Create a new appointment data with custom fields - [Delete Appointment](https://docs.getmateo.com/api-reference/appointment/delete-appointment.md): Delete an existing appointment - [List Appointments](https://docs.getmateo.com/api-reference/appointment/get-appointment.md): Retrieve a list of appointments - [Update Appointment](https://docs.getmateo.com/api-reference/appointment/patch-appointment.md): Update an existing appointment - [Create Appointment](https://docs.getmateo.com/api-reference/appointment/post-appointment.md): Create a new appointment - [List Campaigns](https://docs.getmateo.com/api-reference/campaign/get-campaign.md): Retrieve a list of campaigns - [List Channels](https://docs.getmateo.com/api-reference/channel/get-channel.md): Retrieve a list of channels - [List Comments](https://docs.getmateo.com/api-reference/comment/get-comment.md): Retrieve a list of comments - [Create Comment](https://docs.getmateo.com/api-reference/comment/post-comment.md): Create a new comment - [Delete Contact Custom Field](https://docs.getmateo.com/api-reference/contact-custom-field/delete-contact_custom_field.md): Delete an existing contact custom field - [List Contact Custom Fields](https://docs.getmateo.com/api-reference/contact-custom-field/get-contact_custom_field.md): Retrieve a list of contact custom fields - [Update Contact Custom Field](https://docs.getmateo.com/api-reference/contact-custom-field/patch-contact_custom_field.md): Update an existing contact custom field - [Create Contact Custom Field](https://docs.getmateo.com/api-reference/contact-custom-field/post-contact_custom_field.md): Create a new contact custom field - [Delete Contact Details](https://docs.getmateo.com/api-reference/contact-details/delete-contact_details.md): Delete a contact with marketing channels and custom fields - [List Contact Details](https://docs.getmateo.com/api-reference/contact-details/get-contact_details.md): Retrieve a list of contact data with marketing channels and custom fields - [Update Contact Details](https://docs.getmateo.com/api-reference/contact-details/patch-contact_details.md): Update an existing contact data with marketing channels and custom fields - [Create Contact Details](https://docs.getmateo.com/api-reference/contact-details/post-contact_details.md): Create a new contact data with marketing channels and custom fields - [Delete Contact List Contact](https://docs.getmateo.com/api-reference/contact-list-contact/delete-contact_list_contact.md): Delete an existing contact list contact - [List Contact List Contacts](https://docs.getmateo.com/api-reference/contact-list-contact/get-contact_list_contact.md): Retrieve a list of contact list contacts - [Create Contact List Contact](https://docs.getmateo.com/api-reference/contact-list-contact/post-contact_list_contact.md): Create a new contact list contact - [Delete Contact List](https://docs.getmateo.com/api-reference/contact-list/delete-contact_list.md): Delete an existing contact list - [List Contact Lists](https://docs.getmateo.com/api-reference/contact-list/get-contact_list.md): Retrieve a list of contact lists - [Update Contact List](https://docs.getmateo.com/api-reference/contact-list/patch-contact_list.md): Update an existing contact list - [Create Contact List](https://docs.getmateo.com/api-reference/contact-list/post-contact_list.md): Create a new contact list - [Clear Contact List](https://docs.getmateo.com/api-reference/contact-list/post-contact_list-clear.md): Clear all members from a contact list - [Delete Contact Note](https://docs.getmateo.com/api-reference/contact-note/delete-contact_note.md): Delete an existing contact note - [List Contact Notes](https://docs.getmateo.com/api-reference/contact-note/get-contact_note.md): Retrieve a list of contact notes - [Update Contact Note](https://docs.getmateo.com/api-reference/contact-note/patch-contact_note.md): Update an existing contact note - [Create Contact Note](https://docs.getmateo.com/api-reference/contact-note/post-contact_note.md): Create a new contact note - [Delete Contact](https://docs.getmateo.com/api-reference/contact/delete-contact.md): Delete an existing contact - [List Contacts](https://docs.getmateo.com/api-reference/contact/get-contact.md): Retrieve a list of contacts - [Update Contact](https://docs.getmateo.com/api-reference/contact/patch-contact.md): Update an existing contact - [Create Contact](https://docs.getmateo.com/api-reference/contact/post-contact.md): Create a new contact - [Merge Contacts](https://docs.getmateo.com/api-reference/contact/post-contactmerge.md): Merge two contacts into a new one - [Delete Conversation Tag](https://docs.getmateo.com/api-reference/conversation-tag/delete-conversation_tag.md): Delete an existing conversation tag - [List Conversation Tags](https://docs.getmateo.com/api-reference/conversation-tag/get-conversation_tag.md): Retrieve a list of conversation tags - [Update Conversation Tag](https://docs.getmateo.com/api-reference/conversation-tag/patch-conversation_tag.md): Update an existing conversation tag - [Create Conversation Tag](https://docs.getmateo.com/api-reference/conversation-tag/post-conversation_tag.md): Create a new conversation tag - [List Conversations](https://docs.getmateo.com/api-reference/conversation/get-conversation.md): Retrieve a list of conversations - [Update Conversation](https://docs.getmateo.com/api-reference/conversation/patch-conversation.md): Update an existing conversation - [Create Custom Entity Definition](https://docs.getmateo.com/api-reference/custom-entity-definition/create-custom-entity-definition.md): Create a new custom entity definition - [Delete Custom Entity Definition](https://docs.getmateo.com/api-reference/custom-entity-definition/delete-custom-entity-definition.md): Delete an existing custom entity definition - [List Custom Entity Definitions](https://docs.getmateo.com/api-reference/custom-entity-definition/list-custom-entity-definitions.md): Retrieve a list of custom entity definitions - [Update Custom Entity Definition](https://docs.getmateo.com/api-reference/custom-entity-definition/update-custom-entity-definition.md): Update an existing custom entity definition - [Create Custom Entity](https://docs.getmateo.com/api-reference/custom-entity/create-custom-entity.md): Create a new custom entity - [Delete Custom Entity](https://docs.getmateo.com/api-reference/custom-entity/delete-custom-entity.md): Delete an existing custom entity - [List Custom Entitys](https://docs.getmateo.com/api-reference/custom-entity/list-custom-entitys.md): Retrieve a list of custom entitys - [Update Custom Entity](https://docs.getmateo.com/api-reference/custom-entity/update-custom-entity.md): Update an existing custom entity - [Delete Custom Field](https://docs.getmateo.com/api-reference/custom-field/delete-custom_field.md): Delete an existing custom field - [List Custom Fields](https://docs.getmateo.com/api-reference/custom-field/get-custom_field.md): Retrieve a list of custom fields - [Update Custom Field](https://docs.getmateo.com/api-reference/custom-field/patch-custom_field.md): Update an existing custom field - [Create Custom Field](https://docs.getmateo.com/api-reference/custom-field/post-custom_field.md): Create a new custom field - [Delete Deal Custom Field](https://docs.getmateo.com/api-reference/deal-custom-field/delete-deal_custom_field.md): Delete an existing deal custom field - [List Deal Custom Fields](https://docs.getmateo.com/api-reference/deal-custom-field/get-deal_custom_field.md): Retrieve a list of deal custom fields - [Update Deal Custom Field](https://docs.getmateo.com/api-reference/deal-custom-field/patch-deal_custom_field.md): Update an existing deal custom field - [Create Deal Custom Field](https://docs.getmateo.com/api-reference/deal-custom-field/post-deal_custom_field.md): Create a new deal custom field - [Delete Deal Details](https://docs.getmateo.com/api-reference/deal-details/delete-deal_details.md): Delete a deal with custom fields - [List Deal Details](https://docs.getmateo.com/api-reference/deal-details/get-deal_details.md): Retrieve a list of deal data with custom fields - [Update Deal Details](https://docs.getmateo.com/api-reference/deal-details/patch-deal_details.md): Update an existing deal data with custom fields - [Create Deal Details](https://docs.getmateo.com/api-reference/deal-details/post-deal_details.md): Create a new deal data with custom fields - [Delete Deal](https://docs.getmateo.com/api-reference/deal/delete-deal.md): Delete an existing deal - [List Deals](https://docs.getmateo.com/api-reference/deal/get-deal.md): Retrieve a list of deals - [Update Deal](https://docs.getmateo.com/api-reference/deal/patch-deal.md): Update an existing deal - [Create Deal](https://docs.getmateo.com/api-reference/deal/post-deal.md): Create a new deal - [List Employees](https://docs.getmateo.com/api-reference/employee/get-employee.md): Retrieve a list of employees - [Update Employee](https://docs.getmateo.com/api-reference/employee/patch-employee.md): Update an existing employee - [Create Employee](https://docs.getmateo.com/api-reference/employee/post-employee.md): Create a new employee - [List Events](https://docs.getmateo.com/api-reference/event/get-event.md): Retrieve a list of events - [Format Phone Numbers](https://docs.getmateo.com/api-reference/format/format-phone-number.md): Format phone numbers to E.164 format with specified country codes - [Generate Content](https://docs.getmateo.com/api-reference/generate-content/generate-content.md): Parse any HTML or text into our multi-channel messaging schema - [List Imports](https://docs.getmateo.com/api-reference/import/get-import.md): Retrieve a list of imports - [Create Import](https://docs.getmateo.com/api-reference/import/post-import.md): Create a new import - [Get journey execution](https://docs.getmateo.com/api-reference/journey-execution/get-journey_execution.md) - [Start a journey execution](https://docs.getmateo.com/api-reference/journey-execution/post-journey_execution.md): Trigger a journey execution for a contact via HTTP webhook - [Start batch journey executions](https://docs.getmateo.com/api-reference/journey-execution/post-journey_execution-batch.md): Queue multiple journey executions for a single journey. Each contact is processed independently. - [List Journey Nodes](https://docs.getmateo.com/api-reference/journey-node/get-journey_node.md): Retrieve a list of journey nodes - [List Journey Versions](https://docs.getmateo.com/api-reference/journey-version/get-journey_version.md): Retrieve a list of journey versions - [List Journeys](https://docs.getmateo.com/api-reference/journey/get-journey.md): Retrieve a list of journeys - [List Marketing Channels](https://docs.getmateo.com/api-reference/marketing-channel/get-marketing_channel.md): Retrieve a list of marketing channels - [Delete Marketing Subscription](https://docs.getmateo.com/api-reference/marketing-subscription/delete-marketing_subscription.md): Delete an existing marketing subscription - [List Marketing Subscriptions](https://docs.getmateo.com/api-reference/marketing-subscription/get-marketing_subscription.md): Retrieve a list of marketing subscriptions - [Update Marketing Subscription](https://docs.getmateo.com/api-reference/marketing-subscription/patch-marketing_subscription.md): Update an existing marketing subscription - [Create Marketing Subscription](https://docs.getmateo.com/api-reference/marketing-subscription/post-marketing_subscription.md): Create a new marketing subscription - [List Message Actions](https://docs.getmateo.com/api-reference/message-action/get-message_action.md): Retrieve a list of message actions - [Delete Message](https://docs.getmateo.com/api-reference/message/delete-message.md): Delete an existing message - [List Messages](https://docs.getmateo.com/api-reference/message/get-message.md): Retrieve a list of messages - [List Provider Template Approvals](https://docs.getmateo.com/api-reference/provider-template-approval/get-provider_template_approval.md): Retrieve a list of provider template approvals - [List Providers](https://docs.getmateo.com/api-reference/provider/get-provider.md): Retrieve a list of providers - [List Recipients](https://docs.getmateo.com/api-reference/recipient/get-recipient.md): Retrieve a list of recipients - [Send Broadcast Message](https://docs.getmateo.com/api-reference/send-broadcast/send-a-broadcast-message.md): Send a Broadcast message to a list of recipients and / or segments - [Send Message](https://docs.getmateo.com/api-reference/send-message/send-a-message.md): Send a message - [Create Signed Url](https://docs.getmateo.com/api-reference/storage/create-a-signed-url.md): Create a signed url for an object in a bucket. You can use this url to download the object - [Delete Template](https://docs.getmateo.com/api-reference/template/delete-template.md): Delete an existing template - [List Templates](https://docs.getmateo.com/api-reference/template/get-template.md): Retrieve a list of templates - [Receive Webhook from SAP Emarsys](https://docs.getmateo.com/api-reference/webhook-receivers/post-sapemarsys-send-message.md): Receive a webhook from SAP Emarsys to send a message - [Delete Webhook](https://docs.getmateo.com/api-reference/webhook/delete-webhook.md): Delete an existing webhook - [List Webhooks](https://docs.getmateo.com/api-reference/webhook/get-webhook.md): Retrieve a list of webhooks - [Update Webhook](https://docs.getmateo.com/api-reference/webhook/patch-webhook.md): Update an existing webhook - [Create Webhook](https://docs.getmateo.com/api-reference/webhook/post-webhook.md): Create a new webhook - [Delete Data](https://docs.getmateo.com/concepts/delete.md): Using the DELETE method, you can remove rows. - [Insert Data](https://docs.getmateo.com/concepts/insert.md): You can insert new data using the POST method - [Pagination](https://docs.getmateo.com/concepts/pagination.md): Learn how to paginate through large data sets. - [Read Data](https://docs.getmateo.com/concepts/read.md): Using the GET method, you can retrieve rows. - [Resource Embedding](https://docs.getmateo.com/concepts/resource-embedding.md): Our API supports including related resources in a single API call. This reduces the need for many API requests. - [Update Data](https://docs.getmateo.com/concepts/update.md): Using the PATCH method, you can update rows. - [Upsert Data](https://docs.getmateo.com/concepts/upsert.md): Using either POST or PUT, you can upsert rows. - [Introduction](https://docs.getmateo.com/introduction.md): Understand general concepts, response codes, and authentication strategies. - [Limits](https://docs.getmateo.com/limits.md): To ensure reliabilty and performance, we have certain limits in place. Learn more about them here. - [Contact Import](https://docs.getmateo.com/recipes/contact-import.md): Learn how to efficiently import contacts into Hellomateo. - [Contact Sync](https://docs.getmateo.com/recipes/contact-sync.md): Learn how to setup a (bi-directional) contact sync between Hellomateo and an external system. - [Custom Entity Journeys](https://docs.getmateo.com/recipes/custom-entity-journeys.md): Learn how to use custom entities to sync external data and trigger journey automations. - [Embed Inbox](https://docs.getmateo.com/recipes/embed-inbox.md): Learn how to embed your customer chats directly into your own systems like ERP, CRM, or internal dashboard. - [Introduction](https://docs.getmateo.com/recipes/introduction.md): A collection of recipes for common use cases. - [Message Log](https://docs.getmateo.com/recipes/message-log.md): Learn how to retrieve a log of messages sent and received within Hellomateo. - [Sending Attachments](https://docs.getmateo.com/recipes/sending-attachments.md): Learn how to send attachments - [Postman Collection](https://docs.getmateo.com/resources/postman-collection.md): The Postman Collection for the API. - [Setting up Webhooks](https://docs.getmateo.com/webhooks/setting-up-webhooks.md): Automatically trigger HTTP callbacks on events in hellomateo to build custom integrations, notifications, and workflows. - [Webhook Events Reference](https://docs.getmateo.com/webhooks/webhook-events-reference.md): Learn about the webhook events and HTTP responses sent by Hellomateo webhooks. ## OpenAPI Specs - [openapi](https://docs.getmateo.com/openapi.json) - [package](https://docs.getmateo.com/package.json) ## Optional - [Mateo Academy](https://akademie.hellomateo.de) - [Blog](https://hellomateo.de/blog)