Numbers

Update number (privacy + settings)

PARTIAL update of a number: only what you send changes. There is no POST /v1/numbers/{id}/settings — this PATCH is the settings endpoint, and Evolution’s syncFullHistory has no equivalent here (use settings.historyImportEnabled).

piiMode controls conversation retention and requires piiRetentionDays (1–3650) when set to STORE_X_DAYS.

The settings block has two groups. historyImportEnabled, webhookHistoricalMessages and ignoreNewsletters apply to every provider — the last one drops WhatsApp Channel (@newsletter) posts on arrival, before the conversation, the stored message and the webhook. The other six are the Evolution GO advancedSettings and only apply to unofficial (QR-paired) numbers — on a Meta number they are accepted and stored but never applied, which the response reports as settings.appliesTo.advanced: "none". Sending null on a GO field resets it to the provider default; it does not mean false.

The GO fields are also pushed to the number’s connected instances; the outcome comes back in settingsSync. That push is best-effort: a disconnected instance does not fail the PATCH, and the persisted value is reapplied on its next provisioning.

A body with no recognised field is a 400 EMPTY_PATCH, not a silent no-op.

PATCH

numbers

{id}

Update number (privacy + settings)

curl --request PATCH \
  --url https://pilotstatus.com.br/v1/numbers/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data @- <<EOF
{
  "piiMode": "STORE_X_DAYS",
  "piiRetentionDays": 30,
  "settings": {
    "historyImportEnabled": false,
    "webhookHistoricalMessages": false,
    "ignoreNewsletters": false,
    "alwaysOnline": false,
    "rejectCall": true,
    "msgRejectCall": "I don't take calls here",
    "readMessages": false,
    "ignoreGroups": false,
    "ignoreStatus": false
  }
}
EOF

import requests

url = "https://pilotstatus.com.br/v1/numbers/{id}"

payload = {
    "piiMode": "STORE_X_DAYS",
    "piiRetentionDays": 30,
    "settings": {
        "historyImportEnabled": False,
        "webhookHistoricalMessages": False,
        "ignoreNewsletters": False,
        "alwaysOnline": False,
        "rejectCall": True,
        "msgRejectCall": "I don't take calls here",
        "readMessages": False,
        "ignoreGroups": False,
        "ignoreStatus": False
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    piiMode: 'STORE_X_DAYS',
    piiRetentionDays: 30,
    settings: {
      historyImportEnabled: false,
      webhookHistoricalMessages: false,
      ignoreNewsletters: false,
      alwaysOnline: false,
      rejectCall: true,
      msgRejectCall: 'I don\'t take calls here',
      readMessages: false,
      ignoreGroups: false,
      ignoreStatus: false
    }
  })
};

fetch('https://pilotstatus.com.br/v1/numbers/{id}', 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://pilotstatus.com.br/v1/numbers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'piiMode' => 'STORE_X_DAYS',
    'piiRetentionDays' => 30,
    'settings' => [
        'historyImportEnabled' => false,
        'webhookHistoricalMessages' => false,
        'ignoreNewsletters' => false,
        'alwaysOnline' => false,
        'rejectCall' => true,
        'msgRejectCall' => 'I don\'t take calls here',
        'readMessages' => false,
        'ignoreGroups' => false,
        'ignoreStatus' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <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://pilotstatus.com.br/v1/numbers/{id}"

	payload := strings.NewReader("{\n  \"piiMode\": \"STORE_X_DAYS\",\n  \"piiRetentionDays\": 30,\n  \"settings\": {\n    \"historyImportEnabled\": false,\n    \"webhookHistoricalMessages\": false,\n    \"ignoreNewsletters\": false,\n    \"alwaysOnline\": false,\n    \"rejectCall\": true,\n    \"msgRejectCall\": \"I don't take calls here\",\n    \"readMessages\": false,\n    \"ignoreGroups\": false,\n    \"ignoreStatus\": false\n  }\n}")

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

	req.Header.Add("x-api-key", "<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.patch("https://pilotstatus.com.br/v1/numbers/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"piiMode\": \"STORE_X_DAYS\",\n  \"piiRetentionDays\": 30,\n  \"settings\": {\n    \"historyImportEnabled\": false,\n    \"webhookHistoricalMessages\": false,\n    \"ignoreNewsletters\": false,\n    \"alwaysOnline\": false,\n    \"rejectCall\": true,\n    \"msgRejectCall\": \"I don't take calls here\",\n    \"readMessages\": false,\n    \"ignoreGroups\": false,\n    \"ignoreStatus\": false\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/numbers/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"piiMode\": \"STORE_X_DAYS\",\n  \"piiRetentionDays\": 30,\n  \"settings\": {\n    \"historyImportEnabled\": false,\n    \"webhookHistoricalMessages\": false,\n    \"ignoreNewsletters\": false,\n    \"alwaysOnline\": false,\n    \"rejectCall\": true,\n    \"msgRejectCall\": \"I don't take calls here\",\n    \"readMessages\": false,\n    \"ignoreGroups\": false,\n    \"ignoreStatus\": false\n  }\n}"

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

{
  "id": "num_01HZX...",
  "number": "+5511999999999",
  "name": "Atendimento",
  "provider": "WEB",
  "state": "OPEN",
  "isFullyConnected": true,
  "piiMode": "STORE_X_DAYS",
  "piiRetentionDays": 30,
  "settings": {
    "historyImportEnabled": false,
    "webhookHistoricalMessages": false,
    "ignoreNewsletters": false,
    "alwaysOnline": null,
    "rejectCall": true,
    "msgRejectCall": "I don't take calls here",
    "readMessages": null,
    "ignoreGroups": null,
    "ignoreStatus": null,
    "appliesTo": {
      "history": "all",
      "advanced": "evolution-go"
    }
  },
  "settingsSync": {
    "applied": 1,
    "failed": 0,
    "skipped": 0
  },
  "health": {
    "qualityRating": null,
    "messagingLimitTier": null,
    "metaStatus": null,
    "code": null,
    "reason": null,
    "sendable": true
  },
  "meta": null
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Path Parameters

string

required

WhatsApp number id.

Body

application/json

piiMode

enum<string>

Conversation retention policy. Optional — omit it to change only settings.

Available options:

STORE_INDEFINITE,

STORE_X_DAYS,

RELAY_ONLY

Example:

"STORE_X_DAYS"

piiRetentionDays

integer | null

Required (1–3650) when piiMode is STORE_X_DAYS; forced to null otherwise.

Required range: 1 <= x <= 3650

Example:

30

settings

object

Per-number settings. Partial: only the keys you send change.

Show child attributes

Response

Updated number

Update number (privacy + settings)

curl --request PATCH \
  --url https://pilotstatus.com.br/v1/numbers/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data @- <<EOF
{
  "piiMode": "STORE_X_DAYS",
  "piiRetentionDays": 30,
  "settings": {
    "historyImportEnabled": false,
    "webhookHistoricalMessages": false,
    "ignoreNewsletters": false,
    "alwaysOnline": false,
    "rejectCall": true,
    "msgRejectCall": "I don't take calls here",
    "readMessages": false,
    "ignoreGroups": false,
    "ignoreStatus": false
  }
}
EOF

import requests

url = "https://pilotstatus.com.br/v1/numbers/{id}"

payload = {
    "piiMode": "STORE_X_DAYS",
    "piiRetentionDays": 30,
    "settings": {
        "historyImportEnabled": False,
        "webhookHistoricalMessages": False,
        "ignoreNewsletters": False,
        "alwaysOnline": False,
        "rejectCall": True,
        "msgRejectCall": "I don't take calls here",
        "readMessages": False,
        "ignoreGroups": False,
        "ignoreStatus": False
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    piiMode: 'STORE_X_DAYS',
    piiRetentionDays: 30,
    settings: {
      historyImportEnabled: false,
      webhookHistoricalMessages: false,
      ignoreNewsletters: false,
      alwaysOnline: false,
      rejectCall: true,
      msgRejectCall: 'I don\'t take calls here',
      readMessages: false,
      ignoreGroups: false,
      ignoreStatus: false
    }
  })
};

fetch('https://pilotstatus.com.br/v1/numbers/{id}', 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://pilotstatus.com.br/v1/numbers/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'piiMode' => 'STORE_X_DAYS',
    'piiRetentionDays' => 30,
    'settings' => [
        'historyImportEnabled' => false,
        'webhookHistoricalMessages' => false,
        'ignoreNewsletters' => false,
        'alwaysOnline' => false,
        'rejectCall' => true,
        'msgRejectCall' => 'I don\'t take calls here',
        'readMessages' => false,
        'ignoreGroups' => false,
        'ignoreStatus' => false
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <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://pilotstatus.com.br/v1/numbers/{id}"

	payload := strings.NewReader("{\n  \"piiMode\": \"STORE_X_DAYS\",\n  \"piiRetentionDays\": 30,\n  \"settings\": {\n    \"historyImportEnabled\": false,\n    \"webhookHistoricalMessages\": false,\n    \"ignoreNewsletters\": false,\n    \"alwaysOnline\": false,\n    \"rejectCall\": true,\n    \"msgRejectCall\": \"I don't take calls here\",\n    \"readMessages\": false,\n    \"ignoreGroups\": false,\n    \"ignoreStatus\": false\n  }\n}")

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

	req.Header.Add("x-api-key", "<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.patch("https://pilotstatus.com.br/v1/numbers/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"piiMode\": \"STORE_X_DAYS\",\n  \"piiRetentionDays\": 30,\n  \"settings\": {\n    \"historyImportEnabled\": false,\n    \"webhookHistoricalMessages\": false,\n    \"ignoreNewsletters\": false,\n    \"alwaysOnline\": false,\n    \"rejectCall\": true,\n    \"msgRejectCall\": \"I don't take calls here\",\n    \"readMessages\": false,\n    \"ignoreGroups\": false,\n    \"ignoreStatus\": false\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/numbers/{id}")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"piiMode\": \"STORE_X_DAYS\",\n  \"piiRetentionDays\": 30,\n  \"settings\": {\n    \"historyImportEnabled\": false,\n    \"webhookHistoricalMessages\": false,\n    \"ignoreNewsletters\": false,\n    \"alwaysOnline\": false,\n    \"rejectCall\": true,\n    \"msgRejectCall\": \"I don't take calls here\",\n    \"readMessages\": false,\n    \"ignoreGroups\": false,\n    \"ignoreStatus\": false\n  }\n}"

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

{
  "id": "num_01HZX...",
  "number": "+5511999999999",
  "name": "Atendimento",
  "provider": "WEB",
  "state": "OPEN",
  "isFullyConnected": true,
  "piiMode": "STORE_X_DAYS",
  "piiRetentionDays": 30,
  "settings": {
    "historyImportEnabled": false,
    "webhookHistoricalMessages": false,
    "ignoreNewsletters": false,
    "alwaysOnline": null,
    "rejectCall": true,
    "msgRejectCall": "I don't take calls here",
    "readMessages": null,
    "ignoreGroups": null,
    "ignoreStatus": null,
    "appliesTo": {
      "history": "all",
      "advanced": "evolution-go"
    }
  },
  "settingsSync": {
    "applied": 1,
    "failed": 0,
    "skipped": 0
  },
  "health": {
    "qualityRating": null,
    "messagingLimitTier": null,
    "metaStatus": null,
    "code": null,
    "reason": null,
    "sendable": true
  },
  "meta": null
}

Endpoints

Workspace

Update number (privacy + settings)

Authorizations

Path Parameters

Body

Response