Omni Link

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.

Authorization

bearerAuth
AuthorizationBearer <token>

JWT access token returned by Signing In (POST /auth/v1/tokens/).

In: header

Request Body

application/json

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?

Response Body

application/json

curl -X POST "https://example.com/v1/subscribers" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "_id": "string",    "firstName": "string",    "lastName": "string",    "email": "string",    "phone": "string",    "whatsappNumber": "string",    "locale": "string",    "subscriberId": "string",    "isOnline": true,    "lastOnlineAt": "string",    "_organizationId": "string",    "_environmentId": "string",    "deleted": true,    "createdAt": "string",    "updatedAt": "string",    "__v": 0  }}