Skip to main content
POST
/
v3
/
users
Create or Update a User
curl --request POST \
  --url https://api.captaindata.co/v3/users \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'x-project-id: <api-key>' \
  --data '
{
  "email": "<string>",
  "full_name": "<string>",
  "country": "<string>",
  "timezone": "<string>",
  "uid": "<string>"
}
'
{
  "user": {
    "uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "country": "US",
    "project_uid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "accounts": []
  },
  "message": "User created."
}

Authorizations

​
Authorization
string
header
required

The Authorization header must include 'x-api-key' followed by your API key (e.g., 'Authorization: x-api-key YOUR_API_KEY').

​
x-project-id
string
header
required

Workspace UID required to identify the workspace.

Body

application/json
​
email
string

The email address of the user.

​
full_name
string

The full name of the user.

​
country
string

ISO 3166-1 alpha-2 country code, e.g., 'us' or 'US' for United States.

​
timezone
string

The user's timezone.

​
uid
string

Leave empty to create a new user; provide a UID to update an existing user.

Response

Successful Response