Skip to content
Kirim Docs
API Reference

Overview

Kirim Public API 1.0.0

Section titled “Kirim Public API 1.0.0”

Self-service REST API for sending WhatsApp messages, subscribing to events, and managing your inbox programmatically. See docs.kirim.dev for guides and reference.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
GET
/health
GET
/me
GET
/messages
POST
/messages
GET
/messages/{id}
GET
/messages/{id}/media
GET
/templates
GET
/templates/{name}
GET
/conversations
GET
/conversations/{id}
PATCH
/conversations/{id}
POST
/conversations/{id}/labels
DELETE
/conversations/{id}/labels/{label_id}
GET
/contacts
POST
/contacts
GET
/contacts/{id}
DELETE
/contacts/{id}
PATCH
/contacts/{id}
POST
/contacts/{id}/labels
DELETE
/contacts/{id}/labels/{label_id}
POST
/contacts/bulk_label
GET
/labels
POST
/labels
GET
/labels/{id}
DELETE
/labels/{id}
PATCH
/labels/{id}
GET
/webhook_subscriptions
POST
/webhook_subscriptions
GET
/webhook_subscriptions/{id}
DELETE
/webhook_subscriptions/{id}
PATCH
/webhook_subscriptions/{id}
POST
/webhook_subscriptions/{id}/secrets
DELETE
/webhook_subscriptions/{id}/secrets/{secret_id}
GET
/webhook_deliveries
GET
/webhook_deliveries/{id}
POST
/webhook_deliveries/{id}/replay
POST
/webhook_deliveries/bulk_replay

Authentication

Section titled “ Authentication ”

bearerAuth

Section titled “bearerAuth ”

Kirim Public API key. Format: kdv_live_<24-char base64url>. Issue keys in Settings → API Keys.

Security scheme type: http

Bearer format: API Key