Skip to main content
POST
set-user-properties
Before sending a custom user property that needs protection, such as a name or address, open User Management > User List > Property management in the console. Register the property with the same key you will send and enable encryption.See Manage user properties for setup and limitations.
To update multiple users at once, send an array of user objects with the same structure. Each request accepts up to 1,000 users.

Authorizations

Authorization
string
header
required

Pass the token issued by POST /authenticate as a bearer token.

Body

application/json
projectId
string
required

The project ID assigned by Notifly. Find it under Settings > Product & Project > Project Info.

userProperties
object
required

User properties as key-value pairs. Reserved keys include $email for email, $phone_number for phone number, and $line_user_id for LINE user ID.

userId
string
required

User identifier.

Response

The user properties were updated.

data
integer

Number of rows updated.