Skip to main content
PUT
/
api
/
star
Star or unstar a message
curl --request PUT \
  --url https://{host}/api/star \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "messageId": "[email protected]_AAAAAAAAAAAAAAAAAAAA",
  "chatId": "[email protected]",
  "star": true,
  "session": "my-session"
}
'
{
  "success": true
}

​
Description

⚠️ This endpoint is not yet implemented. This endpoint will allow marking or unmarking messages as favorites (star), adding them to the important messages list on WhatsApp. Note: This endpoint uses the HTTP PUT method, not POST.

​
Body

{
  "sessionId": "my-session",
  "jid": "[email protected]",
  "messageId": "3EB0XXXXXX",
  "star": true
}

​
Body Parameters

PropertyTypeRequiredDescription
sessionIdstring✅ YesAuthenticated session ID that will star the message
jidstring✅ YesChat identifier (WhatsApp JID). Format: [email protected] for contacts or [email protected] for groups
messageIdstring✅ YesMessage ID a ser favoritada
starboolean✅ Yestrue para favoritar, false para desfavoritar
{
  "success": true
}

​
Status Codes

  • 200 - Message favoritada/desfavoritada com sucesso
  • 400 - Invalid parameters
  • 401 - Unauthorized session
  • 404 - Session not found
  • 501 - Not implemented

​
Usage Example

curl -X PUT https://api.wappfy.com.br/api/star \
  -H "Content-Type: application/json" \
  -d '{
    "sessionId": "my-session",
    "jid": "[email protected]",
    "messageId": "3EB0XXXXXX",
    "star": true
  }'

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Body

application/json
​
messageId
string
required

Message ID to be starred

Example:

"[email protected]_AAAAAAAAAAAAAAAAAAAA"

​
chatId
string
required

Chat ID (WhatsApp JID)

Example:

"[email protected]"

​
star
boolean
required

true para favoritar, false para desfavoritar

​
session
string
required

Session name (instanceName)

Example:

"my-session"

Response

200 - undefined