Meta Cloud API
Update business profile
Update the number’s business-profile fields.
POST
/
{phoneNumberId}
/
whatsapp_business_profile
Update business profile
curl --request POST \
--url https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/whatsapp_business_profile \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"messaging_product": "whatsapp",
"about": "Loja Acme",
"address": "Rua Exemplo, 123",
"description": "Atendimento e vendas",
"email": "contato@acme.com",
"vertical": "RETAIL",
"websites": [
"https://acme.com"
],
"profile_picture_handle": "<string>"
}
'import requests
url = "https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/whatsapp_business_profile"
payload = {
"messaging_product": "whatsapp",
"about": "Loja Acme",
"address": "Rua Exemplo, 123",
"description": "Atendimento e vendas",
"email": "contato@acme.com",
"vertical": "RETAIL",
"websites": ["https://acme.com"],
"profile_picture_handle": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messaging_product: 'whatsapp',
about: 'Loja Acme',
address: 'Rua Exemplo, 123',
description: 'Atendimento e vendas',
email: 'contato@acme.com',
vertical: 'RETAIL',
websites: ['https://acme.com'],
profile_picture_handle: '<string>'
})
};
fetch('https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/whatsapp_business_profile', 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/api/layer/meta/{phoneNumberId}/whatsapp_business_profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'messaging_product' => 'whatsapp',
'about' => 'Loja Acme',
'address' => 'Rua Exemplo, 123',
'description' => 'Atendimento e vendas',
'email' => 'contato@acme.com',
'vertical' => 'RETAIL',
'websites' => [
'https://acme.com'
],
'profile_picture_handle' => '<string>'
]),
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/api/layer/meta/{phoneNumberId}/whatsapp_business_profile"
payload := strings.NewReader("{\n \"messaging_product\": \"whatsapp\",\n \"about\": \"Loja Acme\",\n \"address\": \"Rua Exemplo, 123\",\n \"description\": \"Atendimento e vendas\",\n \"email\": \"contato@acme.com\",\n \"vertical\": \"RETAIL\",\n \"websites\": [\n \"https://acme.com\"\n ],\n \"profile_picture_handle\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/whatsapp_business_profile")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"messaging_product\": \"whatsapp\",\n \"about\": \"Loja Acme\",\n \"address\": \"Rua Exemplo, 123\",\n \"description\": \"Atendimento e vendas\",\n \"email\": \"contato@acme.com\",\n \"vertical\": \"RETAIL\",\n \"websites\": [\n \"https://acme.com\"\n ],\n \"profile_picture_handle\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/whatsapp_business_profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messaging_product\": \"whatsapp\",\n \"about\": \"Loja Acme\",\n \"address\": \"Rua Exemplo, 123\",\n \"description\": \"Atendimento e vendas\",\n \"email\": \"contato@acme.com\",\n \"vertical\": \"RETAIL\",\n \"websites\": [\n \"https://acme.com\"\n ],\n \"profile_picture_handle\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"error": {
"message": "(#131030) Recipient phone number not in allowed list",
"type": "OAuthException",
"code": 131030,
"fbtrace_id": "A..."
}
}Authorizations
Your Pilot Status API key (ps_...). You may also send Authorization: Bearer ps_... or ?access_token=ps_....
Path Parameters
Meta phone-number id of the number linked to your API key.
Body
application/json
Always whatsapp.
Available options:
whatsapp Example:
"whatsapp"
Profile about text.
Example:
"Loja Acme"
Example:
"Rua Exemplo, 123"
Example:
"Atendimento e vendas"
Example:
"contato@acme.com"
Business category (e.g. RETAIL).
Example:
"RETAIL"
Up to 2 URLs.
Example:
["https://acme.com"]
Handle from a resumable upload.
Response
Meta Graph API response.
Whether the operation succeeded.
Was this page helpful?
⌘I
Update business profile
curl --request POST \
--url https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/whatsapp_business_profile \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"messaging_product": "whatsapp",
"about": "Loja Acme",
"address": "Rua Exemplo, 123",
"description": "Atendimento e vendas",
"email": "contato@acme.com",
"vertical": "RETAIL",
"websites": [
"https://acme.com"
],
"profile_picture_handle": "<string>"
}
'import requests
url = "https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/whatsapp_business_profile"
payload = {
"messaging_product": "whatsapp",
"about": "Loja Acme",
"address": "Rua Exemplo, 123",
"description": "Atendimento e vendas",
"email": "contato@acme.com",
"vertical": "RETAIL",
"websites": ["https://acme.com"],
"profile_picture_handle": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
messaging_product: 'whatsapp',
about: 'Loja Acme',
address: 'Rua Exemplo, 123',
description: 'Atendimento e vendas',
email: 'contato@acme.com',
vertical: 'RETAIL',
websites: ['https://acme.com'],
profile_picture_handle: '<string>'
})
};
fetch('https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/whatsapp_business_profile', 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/api/layer/meta/{phoneNumberId}/whatsapp_business_profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'messaging_product' => 'whatsapp',
'about' => 'Loja Acme',
'address' => 'Rua Exemplo, 123',
'description' => 'Atendimento e vendas',
'email' => 'contato@acme.com',
'vertical' => 'RETAIL',
'websites' => [
'https://acme.com'
],
'profile_picture_handle' => '<string>'
]),
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/api/layer/meta/{phoneNumberId}/whatsapp_business_profile"
payload := strings.NewReader("{\n \"messaging_product\": \"whatsapp\",\n \"about\": \"Loja Acme\",\n \"address\": \"Rua Exemplo, 123\",\n \"description\": \"Atendimento e vendas\",\n \"email\": \"contato@acme.com\",\n \"vertical\": \"RETAIL\",\n \"websites\": [\n \"https://acme.com\"\n ],\n \"profile_picture_handle\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/whatsapp_business_profile")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"messaging_product\": \"whatsapp\",\n \"about\": \"Loja Acme\",\n \"address\": \"Rua Exemplo, 123\",\n \"description\": \"Atendimento e vendas\",\n \"email\": \"contato@acme.com\",\n \"vertical\": \"RETAIL\",\n \"websites\": [\n \"https://acme.com\"\n ],\n \"profile_picture_handle\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/api/layer/meta/{phoneNumberId}/whatsapp_business_profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"messaging_product\": \"whatsapp\",\n \"about\": \"Loja Acme\",\n \"address\": \"Rua Exemplo, 123\",\n \"description\": \"Atendimento e vendas\",\n \"email\": \"contato@acme.com\",\n \"vertical\": \"RETAIL\",\n \"websites\": [\n \"https://acme.com\"\n ],\n \"profile_picture_handle\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true
}{
"error": {
"message": "(#131030) Recipient phone number not in allowed list",
"type": "OAuthException",
"code": 131030,
"fbtrace_id": "A..."
}
}