Documentation

Green-API-compatible mode

Switch an existing Green API integration by changing the base URL, id and token.

Many tools already speak Green API. Sendjade accepts the same URL style, https://api.sendjade.com/waInstance{idInstance}/{method}/{apiTokenInstance}, so existing automations (Make, n8n, Zapier modules, spreadsheets, bots, "Send via WhatsApp" buttons) can point at Sendjade by changing three things: the base URL, the idInstance and the apiTokenInstance. Method names are case-insensitive; request and response field names follow Green API.

Migrating
# before
https://api.green-api.com/waInstance1101000000/sendMessage/<old token>

# after: same path, same body
https://api.sendjade.com/waInstance7083920886/sendMessage/<your Sendjade token>

Methods that workLive, phone check

GroupMethods
Accountqr, getSettings, setSettings (incl. webhookUrl), getStateInstance, getStateInstanceHistory, reboot, logout, getAuthorizationCode, setProfilePicture, getWaSettings
SendingsendMessage (extension: mentions[]), sendFileByUrl, sendFileByUpload, sendLocation, sendContact, sendPoll, forwardMessages, sendReaction
ReceivingreceiveNotification, deleteNotification, downloadFile (returns the bytes as base64 inline, not a temporary URL)
JournalsgetChatHistory, getMessage, lastIncomingMessages, lastOutgoingMessages
QueueshowMessagesQueue, getMessagesCount, clearMessagesQueue, getWebhooksCount, clearWebhooksQueue
GroupscreateGroup, getGroupData, updateGroupName, updateGroupSettings, addGroupParticipant, removeGroupParticipant, setGroupAdmin, removeAdmin, setGroupPicture, leaveGroup
StatusessendTextStatus, sendMediaStatus, sendVoiceStatus, getOutgoingStatuses, getIncomingStatuses, deleteStatus
Read mark and messagesreadChat, sendTyping, editMessage, deleteMessage
ServicecheckWhatsapp, getAvatar, getContactInfo, getContacts, getChats, getAllowedReactions

Not implementedNot implemented

These return 501 not_implemented with the reason: uploadFile (we do not host files: use sendFileByUpload or sendFileByUrl), sendInteractiveButtons and sendInteractiveButtonsReply (unreliable on unofficial connections: use polls or numbered replies), lastIncomingCalls and lastOutgoingCalls, archiveChat, unarchiveChat, setDisappearingChat, addContact, editContact, deleteContact, getStatusStatistic. Catalog methods are available on the native API only, and the Partner methods (getInstances, createInstance, deleteInstanceAccount) are not built yet. To create instances from your own code today, use the native API with a workspace API key.

Differences worth knowingLive

  • idMessage is the WhatsApp message id assigned when the message is queued; it stays the same in later status webhooks.
  • For an API message the "sent" notification is one polling item. Webhooks created with "format": "green" deliver both outgoingAPIMessageReceived and outgoingMessageStatus.
  • Errors look like { "message", "code" }. A wrong id or token returns the same 401 as an unknown id.
  • Sending needs a connected instance and respects your daily cap and opt-out list, which Green API does not have.