Send Message
Send Message
Send Message
Send Broadcast
Channel
Contact List
Contact Note
Marketing Subscription
Custom Field
Contact Custom Field
Deal Custom Field
Appointment Custom Field
Marketing Channel
Contact Details
Deal Details
Appointment Details
Conversation
Storage
Recipient
Message Action
Event
Conversation Tag
Format
Generate Content
Provider
Provider Template Approval
Campaign
Send Message
Send Message
Send a message
curl --request POST \
--url https://integration.getmateo.com/api/v1/send_message \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"from": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_status": "open",
"to": [
{
"handle": "<string>",
"full_name": "<string>"
}
],
"cc": [
{
"handle": "<string>",
"full_name": "<string>"
}
],
"bcc": [
{
"handle": "<string>",
"full_name": "<string>"
}
],
"subject": "<string>",
"html": "<string>",
"text": "<string>",
"content": {},
"send_after": "2023-11-07T05:31:56Z",
"placeholder_values": [
"<string>"
],
"reply_to_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attachments": [
"<string>"
],
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"review_channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"marketing_channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actions": [
{
"data": "<string>",
"text": "<string>",
"type": "quick_reply",
"subtype": "url"
}
]
}'
{
"conversation": {
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"organisation_id": "<string>",
"subject": "<string>",
"assignee_id": "<string>",
"unread": true,
"channel_id": "<string>",
"contact_id": "<string>",
"external_id": "<string>",
"is_spam": true,
"inbox_id": "<string>",
"latest_message_id": "<string>",
"latest_inbound_message_id": "<string>",
"latest_message_created_at": "<string>",
"latest_inbound_message_created_at": "<string>",
"tags": [
"<string>"
],
"files": [
{}
],
"channel_type": "email",
"status": "open"
},
"message": {
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"organisation_id": "<string>",
"conversation_id": "<string>",
"is_inbound": true,
"subject": "<string>",
"blurb": "<string>",
"author_id": "<string>",
"content": {},
"raw_content": "<string>",
"status": "sent",
"attachment_count": 123,
"reply_to_message_id": "<string>",
"external_files": {},
"external_id": "<string>",
"template_id": "<string>",
"review_channel_id": "<string>",
"author_type": "employee",
"forwarded": true,
"forwarded_message_text": "<string>",
"send_after": "<string>",
"footer": "<string>",
"sendout_id": "<string>",
"campaign_id": "<string>",
"sent_at": "<string>",
"timestamp": "<string>",
"location": {},
"location_metadata": {},
"contacts": {},
"files": {},
"header_media_filename": "<string>"
},
"recipients": [
{
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"organisation_id": "<string>",
"conversation_id": "<string>",
"message_id": "<string>",
"contact_id": "<string>",
"handle": "<string>",
"full_name": "<string>",
"is_organisation": true,
"role": "from",
"status": "sent"
}
],
"actions": [
{
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"organisation_id": "<string>",
"conversation_id": "<string>",
"message_id": "<string>",
"text": "<string>",
"data": "<string>",
"clicked": true,
"type": "quick_reply",
"subtype": "url"
}
]
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Response
200
application/vnd.pgrst.object+json
The message was sent successfully
The response is of type object
.
curl --request POST \
--url https://integration.getmateo.com/api/v1/send_message \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"from": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"conversation_status": "open",
"to": [
{
"handle": "<string>",
"full_name": "<string>"
}
],
"cc": [
{
"handle": "<string>",
"full_name": "<string>"
}
],
"bcc": [
{
"handle": "<string>",
"full_name": "<string>"
}
],
"subject": "<string>",
"html": "<string>",
"text": "<string>",
"content": {},
"send_after": "2023-11-07T05:31:56Z",
"placeholder_values": [
"<string>"
],
"reply_to_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"attachments": [
"<string>"
],
"template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"review_channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"marketing_channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"actions": [
{
"data": "<string>",
"text": "<string>",
"type": "quick_reply",
"subtype": "url"
}
]
}'
{
"conversation": {
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"organisation_id": "<string>",
"subject": "<string>",
"assignee_id": "<string>",
"unread": true,
"channel_id": "<string>",
"contact_id": "<string>",
"external_id": "<string>",
"is_spam": true,
"inbox_id": "<string>",
"latest_message_id": "<string>",
"latest_inbound_message_id": "<string>",
"latest_message_created_at": "<string>",
"latest_inbound_message_created_at": "<string>",
"tags": [
"<string>"
],
"files": [
{}
],
"channel_type": "email",
"status": "open"
},
"message": {
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"organisation_id": "<string>",
"conversation_id": "<string>",
"is_inbound": true,
"subject": "<string>",
"blurb": "<string>",
"author_id": "<string>",
"content": {},
"raw_content": "<string>",
"status": "sent",
"attachment_count": 123,
"reply_to_message_id": "<string>",
"external_files": {},
"external_id": "<string>",
"template_id": "<string>",
"review_channel_id": "<string>",
"author_type": "employee",
"forwarded": true,
"forwarded_message_text": "<string>",
"send_after": "<string>",
"footer": "<string>",
"sendout_id": "<string>",
"campaign_id": "<string>",
"sent_at": "<string>",
"timestamp": "<string>",
"location": {},
"location_metadata": {},
"contacts": {},
"files": {},
"header_media_filename": "<string>"
},
"recipients": [
{
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"organisation_id": "<string>",
"conversation_id": "<string>",
"message_id": "<string>",
"contact_id": "<string>",
"handle": "<string>",
"full_name": "<string>",
"is_organisation": true,
"role": "from",
"status": "sent"
}
],
"actions": [
{
"id": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"organisation_id": "<string>",
"conversation_id": "<string>",
"message_id": "<string>",
"text": "<string>",
"data": "<string>",
"clicked": true,
"type": "quick_reply",
"subtype": "url"
}
]
}