Send Status Message

Send WhatsApp Status updates (also known as Stories) to your contacts. Status messages can be text, images, videos, or audio, and disappear after 24 hours.

This endpoint is currently under review. The Status/Story functionality may have limitations depending on the WhatsApp client version and account type.

Endpoint

POST /message/sendStatus/:instanceName

Path Parameters

instanceName

string

required

The name of your WhatsApp instance that you created

Request Body

Status messages support text, image, video, and audio content. For media types, you can provide the content via URL, base64, or file upload using multipart/form-data.

type

string

required

The type of status content being sentOptions: text, image, video, audio

content

string

required

The content for the status message:

For text type: The text content to display
For media types (image, video, audio): URL or base64-encoded media

caption

string

Caption text for media status updates (image, video, audio)

backgroundColor

string

Background color for text status messages (hex color code)Example: #FF5733, #4CAF50

font

integer

Font style for text status messagesRange: 0 to 5 (different font styles available in WhatsApp)

statusJidList

array

Array of specific contact numbers (JIDs) who can view this statusEach item should be a numeric string. Example: ["5511999999999", "5511888888888"]

allContacts

boolean

Whether to share the status with all your contactsDefault: false - If true, ignores statusJidList

Response

key

object

Message key information

message

object

The sent status message object

messageTimestamp

string

Unix timestamp when the status was sent

status

string

Message status

Code Examples

curl -X POST https://your-api-url.com/message/sendStatus/my-instance \
  -H "Content-Type: application/json" \
  -H "apikey: YOUR_API_KEY" \
  -d '{
    "type": "text",
    "content": "Hello from Evolution API!",
    "backgroundColor": "#4CAF50",
    "font": 1,
    "allContacts": true
  }'

Advanced Examples

Send text status with custom styling

{
  "type": "text",
  "content": "🎉 Exciting news! We're launching something amazing today!",
  "backgroundColor": "#FF6B6B",
  "font": 3,
  "allContacts": true
}

Send image status to specific contacts

{
  "type": "image",
  "content": "https://example.com/announcement.jpg",
  "caption": "New product launch! Check it out 🚀",
  "statusJidList": ["5511999999999", "5511888888888", "5511777777777"],
  "allContacts": false
}

Send video status

{
  "type": "video",
  "content": "https://example.com/promo-video.mp4",
  "caption": "Watch our latest video!",
  "allContacts": true
}

Send audio status

{
  "type": "audio",
  "content": "https://example.com/announcement.mp3",
  "caption": "Listen to our message",
  "allContacts": true
}

Status Type Guidelines

Text Status

Content: Plain text message
Background Colors: Use hex color codes (e.g., #4CAF50, #FF5733)
Fonts: Values from 0 to 5 represent different WhatsApp font styles
Best for: Announcements, quotes, quick updates

Image Status

Formats: JPG, PNG, GIF, WEBP
Max size: 5MB (recommended)
Aspect ratio: 9:16 (portrait) or 16:9 (landscape) works best
Caption: Optional text overlay

Video Status

Formats: MP4, 3GP, MOV
Max size: 16MB (recommended)
Max duration: 30 seconds (WhatsApp limitation)
Caption: Optional text overlay

Audio Status

Formats: MP3, OGG, WAV, AAC
Max size: 16MB
Max duration: No hard limit, but shorter is better
Caption: Optional description

Status messages are automatically deleted after 24 hours, following WhatsApp’s standard Status/Story behavior.

Privacy Settings

Send to All Contacts

Set allContacts: true to share your status with all contacts who have your number saved.

Send to Specific Contacts

Provide a statusJidList array with specific phone numbers to limit who can view your status:

{
  "type": "text",
  "content": "Private announcement",
  "statusJidList": ["5511999999999", "5511888888888"],
  "allContacts": false
}

When allContacts is set to true, the statusJidList is ignored, and the status is shared with all your contacts.

Status Best Practices

Keep it brief: Status messages work best with concise content
Use quality media: High-resolution images and videos perform better
Timing matters: Post when your audience is most active
Add captions: Provide context with descriptive captions
Test first: Send to a small group before broadcasting to all contacts

Error Responses

status

number

HTTP status code

message

string

Error description

Common Errors

Status Code	Error Message	Solution
400	Bad Request - Invalid type	Use valid type: text, image, video, or audio
400	Invalid font value	Use font value between 0 and 5
400	Invalid backgroundColor	Use valid hex color code (e.g., #FF5733)
401	Unauthorized	Check your API key
404	Not Found	Verify instance exists and is connected
500	Internal Server Error	Check server logs or contact support

Status functionality may vary based on your WhatsApp account type and the recipient’s WhatsApp version. Test thoroughly before deploying to production.

Overview

Instance Management

Messaging

Chats

Groups

Contacts

Labels

Settings

Proxy

Send Status Message