latestOpenAPI 3.1.02026-08-1014497184.0 KB

8b99dca11019

Save a user

Creates or updates a user with the provided details. The user will be associated with the project specified in the request context.

put/users

Request body

created_atstring date-time nullable

The timestamp when the user was created.

custom_attributesobject nullable

Arbitrary custom values stored on the user.

emailstring nullable

The primary email address of the user.

external_idstring nullable

The user identifier from an external system.

first_namestring nullable

The first name of the user.

idstring uuid

The unique identifier for the user.

last_namestring nullable

The last name of the user.

last_notified_atstring date-time nullable

The timestamp when the user last received a notification.

last_seen_atstring date-time nullable

The timestamp when the user last opened the inbox.

updated_atstring date-time nullable

The timestamp when the user was last updated.

Example request

{
  "custom_attributes": {
    "key": "value"
  },
  "email": "dan@example.com",
  "external_id": "external-id",
  "first_name": "Dan",
  "id": "8a038704-acc1-47f9-81b0-7523886cbeae",
  "last_name": "Example"
}

Response