---
title: "Create subscriber"
method: POST
path: "/v1/subscribers"
tags: ["Subscribers"]
---

# Create subscriber

`POST /v1/subscribers`

Creates a subscriber entity, in the Omni-Link platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and whatsapp number, could be later associated to this entity.

## Request body

- CreateSubscriberRequestDto
  - `subscriberId` string — The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems
  - `email` string
  - `firstName` string
  - `lastName` string
  - `phone` string
  - `whatsappNumber` string — An http url to the profile image of your subscriber
  - `locale` string
  - `data` object

## Response `201`

- object
  - `data` SubscriberResponseDto
    - `_id` string — The internal id omni-link generated for your subscriber, this is not the subscriberId matching your query. See `subscriberId` for that
    - `firstName` string
    - `lastName` string
    - `email` string
    - `phone` string
    - `whatsappNumber` string
    - `locale` string
    - `subscriberId` string, required — The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems
    - `isOnline` boolean
    - `lastOnlineAt` string
    - `_organizationId` string, required
    - `_environmentId` string, required
    - `deleted` boolean, required
    - `createdAt` string, required
    - `updatedAt` string, required
    - `__v` number

---

[API](https://skmtc.dev/cequens/apis/authentication.md) · [All operations](https://skmtc.dev/cequens/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cequens/authentication/revisions/deadb0661f19/schema)
