Send WhatsApp Note Message (Deprecated)

Send a note message

curl --request POST \
  --url https://api.vambe.me/api/public/whatsapp/message/note/send \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "to_phone": "<string>",
  "from_phone": "<string>",
  "note": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({to_phone: '<string>', from_phone: '<string>', note: '<string>'})
};

fetch('https://api.vambe.me/api/public/whatsapp/message/note/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vambe.me/api/public/whatsapp/message/note/send"

payload = {
    "to_phone": "<string>",
    "from_phone": "<string>",
    "note": "<string>"
}
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

POST

api

public

message

note

send

Send a note message

curl --request POST \
  --url https://api.vambe.me/api/public/whatsapp/message/note/send \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "to_phone": "<string>",
  "from_phone": "<string>",
  "note": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({to_phone: '<string>', from_phone: '<string>', note: '<string>'})
};

fetch('https://api.vambe.me/api/public/whatsapp/message/note/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vambe.me/api/public/whatsapp/message/note/send"

payload = {
    "to_phone": "<string>",
    "from_phone": "<string>",
    "note": "<string>"
}
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

🚨 DEPRECATED ENDPOINT - DO NOT USE FOR NEW INTEGRATIONSThis endpoint is deprecated and will be removed in 12 months. Please migrate to the recommended alternatives below immediately.

Deprecation Notice

This endpoint is no longer recommended for use and will be phased out. Instead, please use one of the following modern alternatives:

Recommended Alternatives

1. ✨ Best Option: Upsert Customer with AI Processing (Recommended)

Create or update customers with intelligent AI-powered data processing:

POST /api/public/customer/upsert/info

View Documentation Why use this: Automatically structures unstructured data, handles upserts, and processes metadata with AI.

2. For WhatsApp API - Create Ticket Without Message

Use the ticket creation endpoint which provides better tracking and metadata support:

POST /api/public/ticket/open/whatsapp/{phoneId}

Note: Documentation for this endpoint coming soon. Use the web-whatsapp version below or the upsert customer endpoint above.

3. For WhatsApp Web (QR) - Create Ticket Without Message

For WhatsApp Web connections:

POST /api/public/ticket/open/web-whatsapp/{phoneId}

View Documentation Simply omit the message field in the request body to create a contact/ticket without sending a message.

Migration Example

Old (Deprecated):

// Don't use this anymore
await fetch('https://api.vambe.me/api/public/whatsapp/message/note/send', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'your_api_key_here',
  },
  body: JSON.stringify({
    to_phone: '+56912345678',
    from_phone: 'your_phone_id',
    note: 'Internal note about this contact',
    contact_name: 'John Doe',
    meta_data: { source: 'website' },
    stage_id: 'stage-uuid',
  }),
});

New (Recommended - Best Option):

// Use the AI-powered upsert endpoint
await fetch('https://api.vambe.me/api/public/customer/upsert/info', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'your_api_key_here',
  },
  body: JSON.stringify({
    channel_phone_number: 'your_phone_id',
    channel: 'whatsapp',
    contact_phone_number: '+56912345678',
    contact_name: 'John Doe',
    contact_email: 'john@example.com',
    stageId: 'stage-uuid',
    meta_data: {
      source: 'website',
      internal_note: 'Internal note about this contact',
      // AI automatically processes and structures any data you add here
    },
  }),
});

Alternative - Create Ticket:

// Or use ticket creation if you need ticket tracking
await fetch(
  'https://api.vambe.me/api/public/ticket/open/web-whatsapp/your_phone_id',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'x-api-key': 'your_api_key_here',
    },
    body: JSON.stringify({
      to_phone_number: '+56912345678',
      stage_id: 'stage-uuid',
      contact_name: 'John Doe',
      contact_metadata: {
        source: 'website',
      },
      ticket_metadata: {
        internal_note: 'Internal note about this contact',
      },
      // No message field = no message sent to end user
    }),
  },
);

Why Migrate?

The new endpoints provide significant improvements:

Upsert Customer Endpoint Benefits:

✅ AI-Powered Processing: Automatically structures unstructured data
✅ Smart Upsert: Creates or updates based on phone number
✅ Flexible Data: Send any metadata structure, AI figures it out
✅ All-in-One: Contact creation + metadata + stage + agent assignment
✅ No Message Sent: Creates contact without bothering the user

Ticket Creation Endpoint Benefits:

✅ Better Structure: Clear separation between contact and ticket metadata
✅ Enhanced Features: Support for integration data, custom fields
✅ Improved Tracking: Built-in ticket management and history
✅ Consistent API: Follows modern API design patterns

General Benefits:

✅ Active Support: Actively maintained with new features
✅ Better Documentation: Comprehensive guides and examples
✅ Future-Proof: Won’t be deprecated

Additional Resources

For updating contact information and metadata after creation, use: Update Contact Metadata:

POST /api/public/contact/{aiContactId}/update-metadata

View Documentation This endpoint allows you to add or update any custom fields for a contact using AI-powered data processing.

Migration Timeline

Now: Endpoint marked as deprecated
6 months: Warning messages added to API responses
12 months: Endpoint will be removed

Please migrate to the new ticket creation endpoints as soon as possible to avoid service disruption.

Support

If you need help migrating your integration, please:

Review the new ticket creation documentation
Contact our support team for migration assistance
Join our developer community for guidance

⚠️ ACTION REQUIREDUpdate your integrations to use the new endpoints before this endpoint is removed in 12 months. Failure to migrate will result in service disruption.

Headers

x-api-key

string

required

API key needed to authorize the request

Body

application/json

The payload to send with the template message

to_phone

string

required

from_phone

string

required

note

string

required

contact_name

string

meta_data

object

stage_id

string

agent_id

string

Response

Message sent successfully.

⌘I

Channels Management

Pipeline & Stages

Templates & Campaigns

WhatsApp Messages

WhatsApp QR Messages

WhatsApp Flows

Tickets

Email Messages

Email Channels & Campaigns

Instagram Comment Automations

Send WhatsApp Note Message (Deprecated)

Deprecation Notice

Recommended Alternatives

1. ✨ Best Option: Upsert Customer with AI Processing (Recommended)

2. For WhatsApp API - Create Ticket Without Message

3. For WhatsApp Web (QR) - Create Ticket Without Message

Migration Example

Why Migrate?

Upsert Customer Endpoint Benefits:

Ticket Creation Endpoint Benefits:

General Benefits:

Additional Resources

Migration Timeline

Support

Headers

Body

Response

​Deprecation Notice

​Recommended Alternatives

​1. ✨ Best Option: Upsert Customer with AI Processing (Recommended)

​2. For WhatsApp API - Create Ticket Without Message

​3. For WhatsApp Web (QR) - Create Ticket Without Message

​Migration Example

​Why Migrate?

​Upsert Customer Endpoint Benefits:

​Ticket Creation Endpoint Benefits:

​General Benefits:

​Additional Resources

​Migration Timeline

​Support

Headers

Body

Response

Deprecation Notice

Recommended Alternatives

1. ✨ Best Option: Upsert Customer with AI Processing (Recommended)

2. For WhatsApp API - Create Ticket Without Message

3. For WhatsApp Web (QR) - Create Ticket Without Message

Migration Example

Why Migrate?

Upsert Customer Endpoint Benefits:

Ticket Creation Endpoint Benefits:

General Benefits:

Additional Resources

Migration Timeline

Support