Skip to main content
POST
Send status

Authorizations

apikey
string
header
required

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Path Parameters

instance
string
required

The number's display name in the Pilot Status dashboard.

Body

application/json
type
string
required

One of text, image, audio, video.

Example:

"text"

content
string
required

Status text, or the public URL of the media.

Example:

"We are online!"

caption
string

Caption for media statuses.

backgroundColor
string

Background color for text statuses (e.g. #25D366).

Example:

"#25D366"

font
integer

Font index for text statuses (0–5).

Example:

2

statusJidList
string[]

Recipient JIDs (numeric strings) allowed to see the status.

allContacts
boolean

Publish to all contacts instead of a JID list.

Example:

true

Response

Success — provider-native response body.

Posted a status/story broadcast. Returns the persisted Baileys messageRaw envelope; remoteJid is 'status@broadcast'. The message content key depends on the status type (text/image/video/audio).

key
object
pushName
string
status
enum<string>
Available options:
ERROR,
PENDING,
SERVER_ACK,
DELIVERY_ACK,
READ,
PLAYED
message
object

Status content. For a text status an extendedTextMessage is present.

contextInfo
object | null
messageType
string
messageTimestamp
integer
instanceId
string
source
string