Beta — endpoints, schemas, limits and examples may change before general availability.
Hellomateo API Documentation
Contacts

Update Contact Channel State

PATCH
/v1/contacts/{id}/channels/{channel_type}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string
Formatuuid
channel_type*"email" | "facebook" | "instagram" | "postal" | "sms" | "whatsapp"
Value in"email" | "facebook" | "instagram" | "postal" | "sms" | "whatsapp"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

health?"healthy" | "unhealthy" | "unknown"
Value in"healthy" | "unhealthy" | "unknown"
transactional_opt_in?|null
marketing_subscription_status?|null
marketing_messages_this_month?integer
Range0 <= value <= 32767
messages_this_month?integer
Range0 <= value <= 32767

Response Body

application/json

curl -X PATCH "https://api.getmateo.com/v1/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/channels/email" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "organisation_id": "9ec26450-a51e-40b1-a49f-e04045480fd5",  "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598",  "channel_type": "email",  "health": "healthy",  "transactional_opt_in": "consent_granted",  "marketing_subscription_status": "requested",  "marketing_messages_this_month": 9007199254740991,  "messages_this_month": 9007199254740991,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}