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

Name	Type	Description
Authorization: Basic	string	Value should be a base64 encoded string of "app_id:app_secret"

Request Body

Name	Type	Description
externalId	string	Should be the primary key of the user in your app, or a similar unique identifier
email	string	User's email address

201 User successfully created.

{
	"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

Name	Type	Description
Authorization: Basic	string	base64 encoded string of "app_id:app_secret"

Request Body

Name	Type	Description
externalId	string	Used to identify the user to be updated. Cannot be modified.
email	string
emailPreferences	string	Valid values are "ALL_EMAILS" or "NO_NOTIFICATIONS".

200 User successfully updated.

	{
	  "appId": "1",
	  "externalId": "1",
	  "email": "[e-mail]",
	  "emailPreferences": "NO_NOTIFICATIONS"
	}

400 Malformed or missing data.

"Invalid payload"

404 User not found.

"AppUser not found"