Star Message - Wappfy API

Star or unstar a message

curl --request PUT \
  --url https://{host}/api/star \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "messageId": "false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA",
  "chatId": "5511999999999@c.us",
  "star": true,
  "session": "my-session"
}
'

import requests

url = "https://{host}/api/star"

payload = {
    "messageId": "false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA",
    "chatId": "5511999999999@c.us",
    "star": True,
    "session": "my-session"
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messageId: 'false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA',
    chatId: '5511999999999@c.us',
    star: true,
    session: 'my-session'
  })
};

fetch('https://{host}/api/star', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/star",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'messageId' => 'false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA',
    'chatId' => '5511999999999@c.us',
    'star' => true,
    'session' => 'my-session'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/star"

	payload := strings.NewReader("{\n  \"messageId\": \"false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA\",\n  \"chatId\": \"5511999999999@c.us\",\n  \"star\": true,\n  \"session\": \"my-session\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{host}/api/star")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messageId\": \"false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA\",\n  \"chatId\": \"5511999999999@c.us\",\n  \"star\": true,\n  \"session\": \"my-session\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/star")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"messageId\": \"false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA\",\n  \"chatId\": \"5511999999999@c.us\",\n  \"star\": true,\n  \"session\": \"my-session\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true
}

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": "false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA",
  "chatId": "5511999999999@c.us",
  "star": true,
  "session": "my-session"
}
'

import requests

url = "https://{host}/api/star"

payload = {
    "messageId": "false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA",
    "chatId": "5511999999999@c.us",
    "star": True,
    "session": "my-session"
}
headers = {
    "apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {apikey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messageId: 'false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA',
    chatId: '5511999999999@c.us',
    star: true,
    session: 'my-session'
  })
};

fetch('https://{host}/api/star', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/api/star",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'messageId' => 'false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA',
    'chatId' => '5511999999999@c.us',
    'star' => true,
    'session' => 'my-session'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "apikey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/api/star"

	payload := strings.NewReader("{\n  \"messageId\": \"false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA\",\n  \"chatId\": \"5511999999999@c.us\",\n  \"star\": true,\n  \"session\": \"my-session\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("apikey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{host}/api/star")
  .header("apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"messageId\": \"false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA\",\n  \"chatId\": \"5511999999999@c.us\",\n  \"star\": true,\n  \"session\": \"my-session\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/star")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["apikey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"messageId\": \"false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA\",\n  \"chatId\": \"5511999999999@c.us\",\n  \"star\": true,\n  \"session\": \"my-session\"\n}"

response = http.request(request)
puts response.read_body

{
  "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": "5511999999999@s.whatsapp.net",
  "messageId": "3EB0XXXXXX",
  "star": true
}

Body Parameters

Property	Type	Required	Description
`sessionId`	`string`	✅ Yes	Authenticated session ID that will star the message
`jid`	`string`	✅ Yes	Chat identifier (WhatsApp JID). Format: `5511999999999@s.whatsapp.net` for contacts or `120363XXXXX@g.us` for groups
`messageId`	`string`	✅ Yes	Message ID a ser favoritada
`star`	`boolean`	✅ Yes	`true` 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": "5511999999999@s.whatsapp.net",
    "messageId": "3EB0XXXXXX",
    "star": true
  }'

// Star message
const response = await fetch('https://api.wappfy.com.br/api/star', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    sessionId: 'my-session',
    jid: '5511999999999@s.whatsapp.net',
    messageId: '3EB0XXXXXX',
    star: true
  })
});
const data = await response.json();
console.log(data);

// Desfavoritar message
const unstarResponse = await fetch('https://api.wappfy.com.br/api/star', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    sessionId: 'my-session',
    jid: '5511999999999@s.whatsapp.net',
    messageId: '3EB0XXXXXX',
    star: false
  })
});

import requests

# Star message
response = requests.put(
    'https://api.wappfy.com.br/api/star',
    json={
        'sessionId': 'my-session',
        'jid': '5511999999999@s.whatsapp.net',
        'messageId': '3EB0XXXXXX',
        'star': True
    }
)
data = response.json()
print(data)

# Desfavoritar message
unstar_response = requests.put(
    'https://api.wappfy.com.br/api/star',
    json={
        'sessionId': 'my-session',
        'jid': '5511999999999@s.whatsapp.net',
        'messageId': '3EB0XXXXXX',
        'star': False
    }
)

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:

"false_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAA"

chatId

string

required

Chat ID (WhatsApp JID)

Example:

"5511999999999@c.us"

star

boolean

required

true para favoritar, false para desfavoritar

session

string

required

Session name (instanceName)

Example:

"my-session"

Response

200 - undefined

Stop Typing Overview

​Description

​Body

​Body Parameters

​Status Codes

​Usage Example

Authorizations

Body

Response

Description

Body

Body Parameters

Status Codes

Usage Example