Skip to main content
PUT
/
api
/
star
Destacar ou remover destaque de uma mensagem
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
}

​
Descrição

⚠️ Este endpoint ainda não está implementado. Este endpoint permitirá marcar ou desmarcar mensagens como favoritas (estrela), adicionando-as à lista de mensagens importantes no WhatsApp. Nota: Este endpoint usa o método HTTP PUT, não POST.

​
Body

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

​
Parâmetros do Body

PropriedadeTipoObrigatórioDescrição
sessionIdstring✅ SimID da sessão autenticada que favoritará a mensagem
jidstring✅ SimIdentificador do chat (JID do WhatsApp). Formato: [email protected] para contatos ou [email protected] para grupos
messageIdstring✅ SimID da mensagem a ser favoritada
starboolean✅ Simtrue para favoritar, false para desfavoritar
{
  "success": true
}

​
Códigos de Status

  • 200 - Mensagem favoritada/desfavoritada com sucesso
  • 400 - Parâmetros inválidos
  • 401 - Sessão não autorizada
  • 404 - Sessão não encontrada
  • 501 - Não implementado

​
Exemplo de Uso

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

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Body

application/json
​
messageId
string
required

ID da mensagem a ser favoritada

Example:

"[email protected]_AAAAAAAAAAAAAAAAAAAA"

​
chatId
string
required

Identificador do chat (JID do WhatsApp)

Example:

"[email protected]"

​
star
boolean
required

true para favoritar, false para desfavoritar

​
session
string
required

Nome da sessão (instanceName)

Example:

"my-session"