User

The user endpoint allows you to create and update application users.

The user object

appId string

The id of the application that the user belongs to.

externalId string

In combination with your application id this attribute uniquely identifies an application user. It is recommended to set this to be the primary key of the user in your app.

email string

The email for the user.

emailPreferences string enum

A string enum representing the email preferences of the user. Possible values are ALL_EMAILSor NO_NOTIFICATIONS.

Create user

POST https://app.noftifly.io/api/user

Allows creating a user.

Headers

Request Body

{
	"appId": "1",
	"externalId": "1",
	"email": null,
	"emailPreferences": "ALL_EMAILS"
}

Update a user

PATCH https://app.noftifly.io/api/user

Allows updating an existing user.

Headers

Request Body

	{
	  "appId": "1",
	  "externalId": "1",
	  "email": "joeblogs@notifly.io",
	  "emailPreferences": "NO_NOTIFICATIONS"
	}

Last updated