Sign in
Users

Create or Update User

Create or update a user if already exists.

post/users

Headers

x-api-keystring required

The API key to authenticate with.

Request body

app_user_idstring required

The unique identifier of the referral user in your app.

is_trialboolean nullable

Whether the user is a trial user.

is_premiumboolean nullable

Whether the user is a premium user.

first_seen_atstring date-time nullable

The date when the user was first seen at.

last_seen_atstring date-time nullable

The date when the user was last seen at. Deprecated and will be removed in the future.

metadataobject nullable

The metadata of the user.

stripe_customer_idstring nullable

The unique identifier of the user in Stripe.

Example request

{
  "app_user_id": "821fae4b5-1a2d-4c1e-9152-5297086a161c",
  "first_seen_at": "2024-11-10T10:28:18.104Z",
  "metadata": {},
  "stripe_customer_id": "cus_1234567890"
}

Response

The user has been successfully updated.

Changes

Changed in 1 of the 3 revisions of this API.2

  • 5b921a291cf82See the full diff
    • ○

      added the required property data/user/allOf[User]/affiliate to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/user/allOf[User]/affiliate to the response with the 201 status

      response-required-property-added