Updating the subscription
curl --request PUT \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/subscription/update \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"withCalls": true
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/subscription/update"
payload = { "withCalls": True }
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({withCalls: true})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/subscription/update', 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}/integrator/subscription/update",
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([
'withCalls' => true
]),
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}/integrator/subscription/update"
payload := strings.NewReader("{\n \"withCalls\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/subscription/update")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"withCalls\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/subscription/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"withCalls\": true\n}"
response = http.request(request)
puts response.read_bodyPartners
Updating the subscription
Updates an instance subscription to enable call support
PUT
/
instances
/
{instanceId}
/
token
/
{token}
/
integrator
/
subscription
/
update
Updating the subscription
curl --request PUT \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/subscription/update \
--header 'Client-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"withCalls": true
}
'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/subscription/update"
payload = { "withCalls": True }
headers = {
"Client-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Client-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({withCalls: true})
};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/subscription/update', 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}/integrator/subscription/update",
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([
'withCalls' => true
]),
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}/integrator/subscription/update"
payload := strings.NewReader("{\n \"withCalls\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/subscription/update")
.header("Client-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"withCalls\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/subscription/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Client-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"withCalls\": true\n}"
response = http.request(request)
puts response.read_bodyOverview
Method used to update an instance subscription to enable call support.The withCalls attribute is required and only accepts the value true. It is not possible to downgrade the subscription (remove calls). To do so, cancel the current subscription and contract a new one.
This feature is only available for accounts with call functionality enabled.
To use Partner endpoints, provide the Partner Token in the Authorization field using the following format:
Bearer <Partner-Token>It is not necessary to send the Client-Token in these requests.Attributes
Required
Must be sent as
true to enable callsRequest Body
{
"withCalls": true
}
Response
201
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