API Reference•v1 REST API
Pingstack REST API Reference
Complete catalog of all 22 official endpoints with request parameters, schemas, headers, and copy-paste code snippets.
Messages Reference
POST & GET endpoints for single message dispatch and conversation history.
POST/api/v1/messages
Send WhatsApp template or text messageGET/api/v1/messages
List workspace messages with paginationGET/api/v1/messages/{id}
Retrieve single message status and metadataContacts Reference
CRUD and batch endpoints for managing contact records and custom fields.
GET/api/v1/contacts
List contacts with search and tagsPOST/api/v1/contacts
Create or upsert a contactGET/api/v1/contacts/{id}
Get contact profilePATCH/api/v1/contacts/{id}
Update contact fieldsDELETE/api/v1/contacts/{id}
Delete contactPOST/api/v1/contacts/bulk
Bulk upsert up to 500 contactsDELETE/api/v1/contacts/bulk
Bulk delete contactsGroups Reference
Audience segment creation and contact membership association.
GET/api/v1/groups
List groups with live contact countsPOST/api/v1/groups
Create a new audience groupGET/api/v1/groups/{id}
Get group detailsPATCH/api/v1/groups/{id}
Update group name/descriptionDELETE/api/v1/groups/{id}
Delete groupGET/api/v1/groups/{id}/contacts
List group member contactsPOST/api/v1/groups/{id}/contacts
Add contact IDs to groupDELETE/api/v1/groups/{id}/contacts
Remove contact IDs from groupTemplates Reference
Query approved Meta WhatsApp templates, languages, and variable schemas.
GET/api/v1/templates
List approved templatesGET/api/v1/templates/{id}
Get template content and variable placeholdersCampaigns Reference
Broadcast lifecycle management and audience delivery execution.
GET/api/v1/campaigns
List broadcast campaigns and delivery statsPOST/api/v1/campaigns
Create campaign draft or scheduled broadcastGET/api/v1/campaigns/{id}
Get campaign detailsDELETE/api/v1/campaigns/{id}
Delete campaignPOST/api/v1/campaigns/{id}/launch
Launch broadcast (contacts, groups, direct recipients)GET/api/v1/campaigns/{id}/results
Get campaign delivery metrics and read ratesWebhooks Reference
Manage outbound webhook subscriptions and test ping dispatches.
GET/api/v1/webhooks
List registered webhook subscriptionsPOST/api/v1/webhooks
Register new webhook endpoint (secret generated)GET/api/v1/webhooks/{id}
Get webhook endpoint and delivery logsDELETE/api/v1/webhooks/{id}
Delete webhook subscriptionPOST/api/v1/webhooks/{id}/test
Trigger immediate test ping eventAPI Keys Reference
Programmatic API key provisioning and revocation.
GET/api/v1/keys
List active API keysPOST/api/v1/keys
Generate new API keyDELETE/api/v1/keys
Revoke API keyUsage & Telemetry Reference
Integration metrics, latency averages, and persistent operational request logs.
GET/api/v1/usage
Get request totals, success rate, and latency metricsGET/api/v1/logs
Query paginated operational request logs