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.

post
Create user

https://app.noftifly.io/api/user
Allows creating a user.
Request
Response
Request
Headers
Authorization: Basic
required
string
Value should be a base64 encoded string of "app_id:app_secret"
Body Parameters
externalId
required
string
Should be the primary key of the user in your app, or a similar unique identifier
email
optional
string
User's email address
Response
201: Created
User successfully created.
{
"appId": "1",
"externalId": "1",
"email": null,
"emailPreferences": "ALL_EMAILS"
}

patch
Update a user

https://app.noftifly.io/api/user
Allows updating an existing user.
Request
Response
Request
Headers
Authorization: Basic
required
string
base64 encoded string of "app_id:app_secret"
Body Parameters
externalId
required
string
Used to identify the user to be updated. Cannot be modified.
email
optional
string
‚Äč
emailPreferences
optional
string
Valid values are "ALL_EMAILS" or "NO_NOTIFICATIONS".
Response
200: OK
User successfully updated.
{
"appId": "1",
"externalId": "1",
"email": "[email protected]",
"emailPreferences": "NO_NOTIFICATIONS"
}
400: Bad Request
Malformed or missing data.
"Invalid payload"
404: Not Found
User not found.
"AppUser not found"