Subscribing to an instance
Method#
/subscription#
POST https://api.z-api.io/instances/{id}/token/{token}/integrator/on-demand/subscription
Concept#
Method used to subscribe to an instance
Attention
You will only be able to subscribe to instances created via API with this method
Attributes#
Required#
| Attributes | Type | Description |
|---|---|---|
Optionals#
| Attributes | Type | Description |
|---|---|---|
| withCalls | boolean | Defines whether the instance will be created with calls support |
Warning
The withCalls attribute is optional. If not provided, the request will continue to work with the default behavior. This feature is only available for accounts with calls functionality enabled.
Request Params#
Method
POST https://api.z-api.io/instances/SUA_INSTANCIA/token/{SEU_TOKEN}/integrator/on-demand/subscription
Request Body#
Response#
201#
OK
405#
In this case certify that you are sending the correct specification of the method. This means, verify if you sent a POST or GET as specified at the beginning of this topic.
415#
In case you receive 415 error, make sure to add the “Content-Type” of the object you are sending in the request headers, mostly “application/json”
Webhook Response#
Link to webhook response (on receipt)