Skip to main content

API Reference

Integration Settings API

Manage per-tenant channel credentials — WhatsApp (Meta), Twilio, and bring-your-own Sarvam key — and verify connectivity.

note
These endpoints store the third-party credentials a tenant uses for channels and BYOK providers. Each provider has a verify action that does a live connectivity check before you save. Credentials are write-only — reads return masked values.
GET/api/v1/settings/whatsapp Auth

Get WhatsApp (Meta Graph) settings — token masked

PUT/api/v1/settings/whatsapp Auth

Save WhatsApp Business credentials

Request Body

phone_number_idstring
waba_idstring
access_tokenstring
verify_tokenstring
POST/api/v1/settings/whatsapp/verify Auth

Test Meta Graph connectivity with the stored credentials

GET/api/v1/settings/twilio Auth

Get Twilio settings — auth token masked

PUT/api/v1/settings/twilio Auth

Save Twilio credentials

Request Body

account_sidstring
auth_tokenstring
phone_numberstring (E.164)
POST/api/v1/settings/twilio/verify Auth

Test Twilio connectivity

GET/api/v1/settings/sarvam Auth

Get bring-your-own Sarvam key status

PUT/api/v1/settings/sarvam Auth

Save a BYOK Sarvam API key (used instead of platform credits for Sarvam calls)

Request Body

api_keystring
POST/api/v1/settings/sarvam/verify Auth

Test the stored Sarvam key

Was this page helpful?