Profile photo
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/privacy/photo-visualization \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"visualizationType": "<string>"
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/privacy/photo-visualization"
payload = { "visualizationType": "<string>" }
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({visualizationType: '<string>'})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/privacy/photo-visualization', 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://api.z-api.io/instances/{instanceId}/token/{token}/privacy/photo-visualization",
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([
'visualizationType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"Content-Type: application/json"
],
]);
$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://api.z-api.io/instances/{instanceId}/token/{token}/privacy/photo-visualization"
payload := strings.NewReader("{\n \"visualizationType\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Client-Token", "<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://api.z-api.io/instances/{instanceId}/token/{token}/privacy/photo-visualization")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"visualizationType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/privacy/photo-visualization")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"visualizationType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyPrivacy
Profile photo
Configure who can see your profile photo
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
privacy
/
photo-visualization
Profile photo
curl --request POST \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/privacy/photo-visualization \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"visualizationType": "<string>"
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/privacy/photo-visualization"
payload = { "visualizationType": "<string>" }
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({visualizationType: '<string>'})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/privacy/photo-visualization', 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://api.z-api.io/instances/{instanceId}/token/{token}/privacy/photo-visualization",
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([
'visualizationType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Client-Token: <api-key>",
"Content-Type: application/json"
],
]);
$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://api.z-api.io/instances/{instanceId}/token/{token}/privacy/photo-visualization"
payload := strings.NewReader("{\n \"visualizationType\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Client-Token", "<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://api.z-api.io/instances/{instanceId}/token/{token}/privacy/photo-visualization")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"visualizationType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/privacy/photo-visualization")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"visualizationType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyOverview
Through this method, you can configure who can see your profile photo.The blacklist (disallowed contacts list) is different for each privacy setting.
You don’t need to resend the
contactsBlacklist attribute with contacts already added. This parameter is only for blacklist changes.Attributes
Header
string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.
Required
string
required
Visualization type:
ALL (everyone), NONE (no one), CONTACTS (contacts only) or CONTACT_BLACKLIST (all contacts except blacklisted ones)Optional
array
Request Body
Visible to everyone:{
"visualizationType": "ALL"
}
{
"visualizationType": "CONTACT_BLACKLIST",
"contactsBlacklist": [
{ "action": "add", "phone": "554411111111" },
{ "action": "remove", "phone": "554422222222" }
]
}
Response
200
{
"success": true
}
405
Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.415
If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.⌘I