> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifly.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# API overview

> Authenticate with the Notifly HTTP API, send your first request, and find endpoint schemas.

The Notifly HTTP API uses HTTPS. Most endpoints send and receive JSON. For CSV responses, see [Export message statistics as CSV](https://docs.notifly.tech/en/api-reference/get-campaign-statistics-csv.md).

## Connection details

| Setting | Value |
| - | - |
| Base URL | `https://api.notifly.tech` |
| Media type | `application/json` |
| Authentication | Get a token from `POST /authenticate` and pass it in the `Authorization: Bearer <auth-token>` header. |
| Character encoding | UTF-8 |
| Date and time format | ISO 8601, for example `2026-10-11T12:34:56Z` |

### Common headers

| Header | Value | When to use it |
| - | - | - |
| `Content-Type` | `application/json` | When the request has a JSON body |
| `Authorization` | `Bearer <auth-token>` | On endpoints that require an API token |

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

## Request and response format

```http theme={null}
POST /some-endpoint HTTP/1.1
Host: api.notifly.tech
Content-Type: application/json
Authorization: Bearer <auth-token>

{ "example": "payload" }
```

```json theme={null}
{
  "success": true,
  "data": { "example": "response" },
  "error": null
}
```

See [API errors and response formats](https://docs.notifly.tech/en/api-reference/error.md) for common error fields.

> [!NOTE]
>
> The Catalog API under `/v1/projects/{projectId}/catalogs` returns `{ "data": ..., "error": ... }`. See [Get started with the Catalog REST API](https://docs.notifly.tech/en/api-reference/catalogs/getting-started.md).

## Get a token and send an event

```js theme={null}
// Get a token
const authRes = await fetch("https://api.notifly.tech/authenticate", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    accessKey: "your-access-key",
    secretKey: "your-secret-key"
  })
});
const { data: authToken } = await authRes.json();

// Send an event
const res = await fetch("https://api.notifly.tech/track-event", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": `Bearer ${authToken}`
  },
  body: JSON.stringify({
    projectId: "your-project-id",
    eventName: "view_home",
    isGlobalEvent: false,
    userId: "alice",
    eventParams: { plan: "premium" }
  })
});
console.log(await res.json());
```

## Quick links

> [card] [Issue an API token](https://docs.notifly.tech/en/api-reference/authenticate.md)
>
> Get a token with `POST /authenticate`.

> [card] [API errors](https://docs.notifly.tech/en/api-reference/error.md)
>
> Look up status codes and response fields.

## Events and users

> [card] [Track an event](https://docs.notifly.tech/en/api-reference/track-event.md)
>
> Record a user event or a global event.

> [card] [Set user properties](https://docs.notifly.tech/en/api-reference/set-user-properties.md)
>
> Set or update properties for one or more users.

> [card] [Delete users](https://docs.notifly.tech/en/api-reference/delete-users.md)
>
> Delete one or more users.

## Campaigns and user journeys

> [card] [Trigger a campaign](https://docs.notifly.tech/en/api-reference/trigger-campaign.md)
>
> Send messages from an API-triggered campaign.

> [card] [Trigger a user journey](https://docs.notifly.tech/en/api-reference/trigger-user-journey.md)
>
> Trigger a user journey for the specified user.

## Messaging

> [card] [Send a text message](https://docs.notifly.tech/en/api-reference/send-text-message.md)
>
> Send SMS, LMS, or MMS.

> [card] [Send Kakao AlimTalk](https://docs.notifly.tech/en/api-reference/send-kakao-alimtalk.md)
>
> Send a message with an AlimTalk template.

> [card] [Kakao Friendtalk](https://docs.notifly.tech/en/api-reference/send-kakao-friendtalk.md)
>
> View the legacy Friendtalk endpoint.

> [card] [Send a templated Kakao Brand Message](https://docs.notifly.tech/en/api-reference/send-kakao-brand-message.md)
>
> Send a Brand Message using a template.

> [card] [Send a free-form Kakao Brand Message](https://docs.notifly.tech/en/api-reference/send-kakao-brand-message-freestyle.md)
>
> Send a free-form Brand Message.

## Messaging management

> [card] [Update an AlimTalk template](https://docs.notifly.tech/en/api-reference/update-kakao-alimtalk-template.md)
>
> Update an existing AlimTalk template.

> [card] [080 opt-out service](https://docs.notifly.tech/en/api-reference/list-080-block-recipients.md)
>
> List, register, or remove opt-out numbers.

## Exports and analytics

> [card] [Export campaign events](https://docs.notifly.tech/en/api-reference/create-campaign-event-export.md)
>
> Create an export of message events.

> [card] [Get campaign statistics](https://docs.notifly.tech/en/api-reference/get-campaign-statistics.md)
>
> Query message statistics by date.

> [card] [Get detailed campaign statistics](https://docs.notifly.tech/en/api-reference/get-campaign-statistics-retrieval.md)
>
> Get summary and daily statistics for a campaign.

> [card] [Get user message history](https://docs.notifly.tech/en/api-reference/get-user-message-history.md)
>
> Look up the messages sent to a user.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.