Skip to main content
POST
Simulate a user suspension

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The push identifier for the user

Example:

"user_28CJjV7P4Go5PNJvfzghiD"

Response

The suspended user. A user who is already suspended is returned unchanged, with status still suspended, and no webhook is delivered — only a transition into suspension emits one.

id
string
required

Push's identifier assigned to the user

tag
string | null
required

The tag provided in the request to create the user

status
enum<string>
required
Available options:
created,
enabled,
suspended,
disabled
created_at
string<date-time>
required

Date and time in which user was first created in system