Create New Message

curl --request POST \
  --url https://app.yampi.ai/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "content": "Hello, how can I help you?"
}
'

const options = {
  method: 'POST',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({content: 'Hello, how can I help you?'})
};

fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.yampi.ai/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages"

payload = { "content": "Hello, how can I help you?" }
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": 123,
  "content": "<string>",
  "account_id": 123,
  "inbox_id": 123,
  "conversation_id": 123,
  "message_type": 0,
  "created_at": 123,
  "updated_at": 123,
  "private": true,
  "status": "sent",
  "source_id": "<string>",
  "content_type": "text",
  "content_attributes": {},
  "sender_type": "contact",
  "sender_id": 123,
  "external_source_ids": {},
  "additional_attributes": {},
  "processed_message_content": "<string>",
  "sentiment": {},
  "conversation": {},
  "attachment": {},
  "sender": {}
}

{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Messages

Create New Message

Create a new message in the conversation.

Use application/json for text messages and multipart/form-data when the message includes file attachments.

Multipart attachment request

Send files with the attachments[] form field. curl -F sets the multipart/form-data content type and boundary automatically.

curl -X POST "https://app.yampi.ai/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages" \
  -H "api_access_token: <your-api-token>" \
  -F "content=Here is the screenshot" \
  -F "message_type=outgoing" \
  -F "private=false" \
  -F "attachments[]=@/path/to/screenshot.png"

WhatsApp Template Messages

For WhatsApp channels, you can send structured template messages using the template_params field. Templates must be pre-approved in WhatsApp Business Manager.

Example Templates

Text with Image Header:

{
  "content": "Hi your order 121212 is confirmed. Please wait for further updates",
  "template_params": {
    "name": "order_confirmation",
    "category": "MARKETING",
    "language": "en",
    "processed_params": {
      "body": {
        "1": "121212"
      },
      "header": {
        "media_url": "https://picsum.photos/200/300",
        "media_type": "image"
      }
    }
  }
}

Text with Copy Code Button:

{
  "content": "Special offer! Get 30% off your next purchase. Use the code below",
  "template_params": {
    "name": "discount_coupon",
    "category": "MARKETING",
    "language": "en",
    "processed_params": {
      "body": {
        "discount_percentage": "30"
      },
      "buttons": [{
        "type": "copy_code",
        "parameter": "SAVE20"
      }]
    }
  }
}

POST

api

accounts

{account_id}

conversations

{conversation_id}

messages

Create New Message

curl --request POST \
  --url https://app.yampi.ai/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "content": "Hello, how can I help you?"
}
'

const options = {
  method: 'POST',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({content: 'Hello, how can I help you?'})
};

fetch('https://app.yampi.ai/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://app.yampi.ai/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages"

payload = { "content": "Hello, how can I help you?" }
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": 123,
  "content": "<string>",
  "account_id": 123,
  "inbox_id": 123,
  "conversation_id": 123,
  "message_type": 0,
  "created_at": 123,
  "updated_at": 123,
  "private": true,
  "status": "sent",
  "source_id": "<string>",
  "content_type": "text",
  "content_attributes": {},
  "sender_type": "contact",
  "sender_id": 123,
  "external_source_ids": {},
  "additional_attributes": {},
  "processed_message_content": "<string>",
  "sentiment": {},
  "conversation": {},
  "attachment": {},
  "sender": {}
}

{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Authorizations

api_access_token

string

header

required

Token de usuario. Envía el valor en el header api_access_token. Lo obtienes en el perfil (GET /api/v1/profile) o al regenerarlo.

Path Parameters

account_id

integer

required

The numeric ID of the account

conversation_id

integer

required

The numeric ID of the conversation

Body

content

string

required

The content of the message

Example:

"Hello, how can I help you?"

message_type

enum<string>

The type of the message

Available options:

outgoing,

incoming

Example:

"outgoing"

private

boolean

Flag to identify if it is a private note

Example:

false

content_type

enum<string>

Content type of the message

Available options:

text,

input_email,

cards,

input_select,

form,

article

Example:

"text"

content_attributes

object

Attributes based on the content type

Example:

{}

campaign_id

integer

The campaign id to which the message belongs

Example:

1

template_params

object

WhatsApp template parameters for sending structured messages

Show child attributes

Response

Success

number

The ID of the message

content

string

The text content of the message

account_id

number

The ID of the account

inbox_id

number

The ID of the inbox

conversation_id

number

The ID of the conversation

message_type

enum<integer>

The type of the message

Available options:

0,

1,

2

created_at

integer

The time at which message was created

updated_at

integer

The time at which message was updated

private

boolean

The flags which shows whether the message is private or not

status

enum<string>

The status of the message

Available options:

sent,

delivered,

read,

failed

source_id

string

The source ID of the message

content_type

enum<string>

The type of the template message

Available options:

text,

input_select,

cards,

form

content_attributes

object

The content attributes for each content_type

sender_type

enum<string>

The type of the sender

Available options:

contact,

agent,

agent_bot

sender_id

number

The ID of the sender

external_source_ids

object

The external source IDs of the message

additional_attributes

object

The additional attributes of the message

processed_message_content

string

The processed message content

sentiment

object

The sentiment of the message

conversation

object

The conversation object

attachment

object

The file object attached to the image

sender

object

User/Agent/AgentBot object