Create

client.users.create(, ?): UserCreateResponse { data }

POST/users

Creates a user.

ParametersExpand Collapse

body: UserCreateParams { external_id, tags }

external_id: string

User-provided unique ID.

tags?: Array<Tag>

Tags for the user.

key: string

Tag key. Must not contain #, /, or :. Max 50 characters.

value: string

Tag value. Must not contain #, /, or :. Max 200 characters.

ReturnsExpand Collapse

UserCreateResponse { data }

data: User { id, external_id, tags }

User object.

id: string

FRAGMENT generated unique ID.

external_id: string

User-provided unique ID.

tags: Array<Tag>

Tags for the user.

key: string

Tag key.

value: string

Tag value.

Create

import Fragment from '@fragment-dev/ts-node';

const client = new Fragment();

const user = await client.users.create({ external_id: 'user_ext_123' });

console.log(user.data);

{
  "data": {
    "id": "user_abc123",
    "external_id": "user_ext_123",
    "tags": [
      {
        "key": "department",
        "value": "engineering"
      }
    ]
  }
}

Returns Examples

{
  "data": {
    "id": "user_abc123",
    "external_id": "user_ext_123",
    "tags": [
      {
        "key": "department",
        "value": "engineering"
      }
    ]
  }
}