Skip to main content
POST
/
poolside
/
v1
/
users
Create user
curl --request POST \
  --url https://api.example.com/poolside/v1/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "name": "<string>",
  "teams": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "email": "jsmith@example.com",
  "id": "<string>",
  "status": "created",
  "teams": {
    "links": {
      "next": "<string>"
    },
    "teams": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "$schema": "<string>"
  },
  "updated_at": "2023-11-07T05:31:56Z",
  "$schema": "<string>",
  "attributes": {
    "scim": {}
  },
  "deleted_at": "2023-11-07T05:31:56Z"
}

Body

application/json
email
string<email>
required

email address of the user to create

Minimum string length: 1
name
string

display name of the user

teams
object[]

teams to add the user to

Maximum array length: 50

Response

Created

created_at
string<date-time>
required
read-only

timestamp when the user account was created

email
string<email>
required

primary email address of the user

id
string
required
read-only

unique identifier for the user

status
enum<string>
required

current status of the user account

Available options:
created,
active,
suspended,
deleted
teams
object
required

the first page of teams that the user belongs to

updated_at
string<date-time>
required
read-only

timestamp when the user account was last updated

$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/User.json"

attributes
object

attributes of the user

deleted_at
string<date-time>
read-only

timestamp when the user account was deleted; omitted if the account is not deleted