Skip to content
FRAGMENT
API Reference
Users

Create

users.create(UserCreateParams**kwargs) -> UserCreateResponse
POST/users

Creates a user.

ParametersExpand Collapse
external_id: str

User-provided unique ID.

tags: Optional[Iterable[Tag]]

Tags for the user.

key: str

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

value: str

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

ReturnsExpand Collapse
class UserCreateResponse: …
data: User

User object.

id: str

FRAGMENT generated unique ID.

external_id: str

User-provided unique ID.

tags: List[Tag]

Tags for the user.

key: str

Tag key.

value: str

Tag value.

Create

from fragment import Fragment

client = Fragment()
user = client.users.create(
    external_id="user_ext_123",
)
print(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"
      }
    ]
  }
}