Skip to content
Renotify Docs

Overview

Renotify API 1.0.0

Section titled “Renotify API 1.0.0”

Send business events, manage contacts, segments and templates, and read delivery results. Every request needs an API key, sent as a Bearer token. Responses use JSON:API.

Information

  • OpenAPI version: 3.0.3

Operations

Section titled “Operations”
GET
/api/v1/events
POST
/api/v1/events
GET
/api/v1/channels
POST
/api/v1/channels/test
GET
/api/v1/channels/{id}
DELETE
/api/v1/channels/{id}
PATCH
/api/v1/channels/{id}
GET
/api/v1/tags
POST
/api/v1/tags
DELETE
/api/v1/tags/{tag_id}
PATCH
/api/v1/tags/{tag_id}
POST
/api/v1/tags/attach
POST
/api/v1/tags/detach
POST
/api/v1/tags/sync
GET
/api/v1/conversations
GET
/api/v1/conversations/{conversation_id}
POST
/api/v1/conversations/{conversation_id}/assign
POST
/api/v1/conversations/{conversation_id}/unassign
POST
/api/v1/conversations/{conversation_id}/close
POST
/api/v1/conversations/{conversation_id}/reopen
POST
/api/v1/conversations/{conversation_id}/return-to-bot
POST
/api/v1/conversations/{conversation_id}/reply
POST
/api/v1/conversations/{conversation_id}/react
GET
/api/v1/integrations
POST
/api/v1/integrations
GET
/api/v1/integrations/{integration_id}
PUT
/api/v1/integrations/{integration_id}
DELETE
/api/v1/integrations/{integration_id}
POST
/api/v1/integrations/{integration_id}/sync
POST
/api/v1/integrations/{integration_id}/test
POST
/api/v1/integrations/{integration_id}/preview
GET
/api/v1/notifications
POST
/api/v1/notifications
DELETE
/api/v1/notifications
GET
/api/v1/notifications/{notification_id}
DELETE
/api/v1/notifications/{notification_id}
PATCH
/api/v1/notifications/{notification_id}
POST
/api/v1/notifications/send
POST
/api/v1/notifications/batch-send
GET
/api/v1/notifications/batch/{batchId}
GET
/api/v1/bots
POST
/api/v1/bots
DELETE
/api/v1/bots
GET
/api/v1/bots/{bot_id}
DELETE
/api/v1/bots/{bot_id}
PATCH
/api/v1/bots/{bot_id}
POST
/api/v1/bots/{bot_id}/toggle
POST
/api/v1/bots/{bot_id}/duplicate
GET
/api/v1/contacts
POST
/api/v1/contacts
POST
/api/v1/contacts/upsert
POST
/api/v1/contacts/batch
GET
/api/v1/contacts/{contact_id}
PUT
/api/v1/contacts/{contact_id}
DELETE
/api/v1/contacts/{contact_id}
PUT
/api/v1/contacts/{contact_id}/channels/{channel}
DELETE
/api/v1/contacts/{contact_id}/channels/{channel}
POST
/api/v1/contacts/import/preview
POST
/api/v1/contacts/import
GET
/api/v1/notifications/logs
GET
/api/v1/notifications/logs/export
GET
/api/v1/notifications/logs/{log_id}
POST
/api/v1/notifications/logs/retry
GET
/api/v1/audience
POST
/api/v1/audience
GET
/api/v1/audience/templates
POST
/api/v1/audience/preview
POST
/api/v1/audience/overlap
GET
/api/v1/audience/{targetGroup_id}
DELETE
/api/v1/audience/{targetGroup_id}
PATCH
/api/v1/audience/{targetGroup_id}
POST
/api/v1/audience/{targetGroup_id}/clone
POST
/api/v1/audience-import/preview
POST
/api/v1/audience-import/process
GET
/api/v1/filter-conditions
GET
/api/v1/filter-conditions/for-field-type
GET
/api/v1/notifications/templates
GET
/api/v1/notifications/templates/{name}

Authentication

Section titled “Authentication”

default

Section titled “default”

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Security scheme type: http