Zaply
HomeWebsite
HomeWebsite
  1. Instance Settings
  • Overview
  • Send Messages
    • Send Message via WhatsApp Instance
      POST
    • Send Media Message via WhatsApp Instance
      POST
    • Send Location Message via WhatsApp Instance
      POST
    • Send Contact Message via WhatsApp Instance
      POST
  • Instance Settings
    • Set Settings
      POST
    • Get Settings
      GET
  • Connection
    • Get QR Code for WhatsApp Connection
      GET
  • Manage Instance
    • Create Instance
      POST
    • Get Instance
      GET
    • Delete Instance
      DELETE
  1. Instance Settings

Get Settings

GET
https://api.zaply.dev/v1/instance/{{INSTANCE_ID}}/setting
This API endpoint allows you to retrieve the current webhook and custom params settings for a specified WhatsApp instance. This is useful for checking the configured webhook URL and ensuring that it is set up correctly.

Request Parameters#

Path Parameters
instance_id (string) - The unique identifier of the WhatsApp instance. Replace csbtlubmrh with your actual instance ID.

Headers#

Authorization (string, required) - Bearer token for authentication. Replace {{ZAPLY_AUTH_TOKEN}} with your API token.

Error Codes#

401 Unauthorized - Invalid or missing Authorization token.
404 Not Found - Instance ID does not exist.
500 Internal Server Error - Server encountered an unexpected condition.

Request

Header Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://api.zaply.dev/v1/instance/{{instance_id}}/setting' \
--header 'Authorization: Bearer {{ZAPLY_AUTH_TOKEN}}'

Responses

🟢200Success
application/json
Body

Example
{}
Modified at 2024-10-15 07:07:42
Previous
Set Settings
Next
Get QR Code for WhatsApp Connection
Built with