Skip to main content
The Notifly HTTP API uses HTTPS. Most endpoints send and receive JSON. For CSV responses, see Export message statistics as CSV.

Connection details

Common headers

API tokens expire after one hour. If a token expires, request a new token from POST /authenticate and retry.

Request and response format

See API errors and response formats for common error fields.
The Catalog API under /v1/projects/{projectId}/catalogs returns { "data": ..., "error": ... }. See Get started with the Catalog REST API.

Get a token and send an event

Issue an API token

Get a token with POST /authenticate.

API errors

Look up status codes and response fields.

Events and users

Track an event

Record a user event or a global event.

Set user properties

Set or update properties for one or more users.

Delete users

Delete one or more users.

Campaigns and user journeys

Trigger a campaign

Send messages from an API-triggered campaign.

Trigger a user journey

Trigger a user journey for the specified user.

Messaging

Send a text message

Send SMS, LMS, or MMS.

Send Kakao AlimTalk

Send a message with an AlimTalk template.

Kakao Friendtalk

View the legacy Friendtalk endpoint.

Send a templated Kakao Brand Message

Send a Brand Message using a template.

Send a free-form Kakao Brand Message

Send a free-form Brand Message.

Messaging management

Update an AlimTalk template

Update an existing AlimTalk template.

080 opt-out service

List, register, or remove opt-out numbers.

Exports and analytics

Export campaign events

Create an export of message events.

Get campaign statistics

Query message statistics by date.

Get detailed campaign statistics

Get summary and daily statistics for a campaign.

Get user message history

Look up the messages sent to a user.