Pular para o conteúdo principal
POST
/
instances
/
{instanceId}
/
token
/
{token}
/
integrator
/
on-demand
/
subscription
Assinando uma instância
curl --request POST \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/integrator/on-demand/subscription \
  --header 'Client-Token: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "withCalls": true
}
'

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Método utilizado para assinar uma instância.
Para utilizar os endpoints de Partner, informe o Token de Parceiro no campo Authorization, no formato: Bearer <Partner-Token>Não é necessário enviar o Client-Token nessas requisições.

​
Atributos

​
Opcionais

​
withCalls
boolean
Define se a instância será criada com suporte a chamadas
O atributo withCalls é opcional. Caso não seja enviado, a requisição continuará funcionando normalmente com o comportamento padrão. Este recurso está disponível apenas para contas que possuem a funcionalidade de chamadas habilitada.

​
Request Body

{
  "withCalls": true
}

​
Response

​
201

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.