Users 9 endpoints

PATCH /users/{userId}/status

Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user’s ID reserved.

operationId: Users_updateStatus

Parameters

Name In Required Type Description
userId path required string

User ID.

Request Body

application/json
schema UsersUpdateStatusRequest
Property Type Required
status boolean required

Responses

200

User
PATCH /users/{userId}/status
GET /users/{userId}/targets

List the messaging targets that are associated with a user.

operationId: Users_listTargets

Parameters

Name In Required Type Description
userId path required string

User ID.
queries query optional array

Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels

Responses

200

Target list
GET /users/{userId}/targets
POST /users/{userId}/targets

Create a messaging target.

operationId: Users_createTargetMessaging

Parameters

Name In Required Type Description
userId path required string

User ID.

Request Body

application/json
schema UsersCreateTargetMessagingRequest
Property Type Required
name string optional
targetId string required
identifier string required
providerId string optional
providerType string required

Responses

201

Target
POST /users/{userId}/targets
DELETE /users/{userId}/targets/{targetId}

Delete a messaging target.

operationId: Users_deleteTargetMessaging

Parameters

Name In Required Type Description
userId path required string

User ID.
targetId path required string

Target ID.

Responses

204

No content
DELETE /users/{userId}/targets/{targetId}
GET /users/{userId}/targets/{targetId}

Get a user’s push notification target by ID.

operationId: Users_getUserTargetById

Parameters

Name In Required Type Description
userId path required string

User ID.
targetId path required string

Target ID.

Responses

200

Target
GET /users/{userId}/targets/{targetId}
PATCH /users/{userId}/targets/{targetId}

Update a messaging target.

operationId: Users_updateTargetMessaging

Parameters

Name In Required Type Description
userId path required string

User ID.
targetId path required string

Target ID.

Request Body

application/json
schema UsersUpdateTargetMessagingRequest
Property Type Required
name string optional
identifier string optional
providerId string optional

Responses

200

Target
PATCH /users/{userId}/targets/{targetId}
POST /users/{userId}/tokens

Returns a token with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the PUT /account/sessions/custom endpoint to complete the login process.

operationId: Users_createTokenSession

Parameters

Name In Required Type Description
userId path required string

User ID.

Request Body

application/json
schema UsersCreateTokenSessionRequest
Property Type Required
expire integer optional
length integer optional

Responses

201

Token
POST /users/{userId}/tokens
PATCH /users/{userId}/verification

Update the user email verification status by its unique ID.

operationId: Users_updateEmailVerification

Parameters

Name In Required Type Description
userId path required string

User ID.

Request Body

application/json
schema UsersUpdateEmailVerificationRequest
Property Type Required
emailVerification boolean required

Responses

200

User
PATCH /users/{userId}/verification
PATCH /users/{userId}/verification/phone

Update the user phone verification status by its unique ID.

operationId: Users_updatePhoneVerification

Parameters

Name In Required Type Description
userId path required string

User ID.

Request Body

application/json
schema UsersUpdatePhoneVerificationRequest
Property Type Required
phoneVerification boolean required

Responses

200

User
PATCH /users/{userId}/verification/phone