Skip to main content
POST
/
workspaces
/
{workspace_id}
/
members
Add workspace member
curl --request POST \
  --url https://api.wacht.dev/workspaces/{workspace_id}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "9876543210",
  "role_ids": [
    "5555555555",
    "6666666666"
  ]
}
'
{
  "id": "7777777777",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T15:45:00Z",
  "workspace_id": "4444444444",
  "user_id": "9876543210",
  "roles": [
    {
      "id": "5555555555",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T15:45:00Z",
      "name": "Developer",
      "permissions": [
        "read:projects",
        "write:projects",
        "deploy:production"
      ],
      "is_deployment_level": false
    }
  ],
  "public_metadata": {},
  "first_name": "John",
  "last_name": "Doe",
  "username": "johndoe",
  "primary_email_address": "[email protected]",
  "primary_phone_number": "+1234567890",
  "user_created_at": "2024-01-10T10:00:00Z"
}

Authorizations

​
Authorization
string
header
required

API key authentication (Bearer token)

Path Parameters

​
workspace_id
string
required

Workspace ID (integer as string)

Body

application/json
​
user_id
string
required

User ID (integer as string)

Example:

"9876543210"

​
role_ids
string[]
required

Role IDs to assign (array of integers as strings)

Example:
["5555555555", "6666666666"]

Response

Member added successfully

​
id
string
required

Membership ID (integer serialized as string)

Example:

"7777777777"

​
created_at
string<date-time>
required
Example:

"2024-01-15T10:30:00Z"

​
updated_at
string<date-time>
required
Example:

"2024-01-20T15:45:00Z"

​
workspace_id
string
required

Workspace ID (integer serialized as string)

Example:

"4444444444"

​
user_id
string
required

User ID (integer serialized as string)

Example:

"9876543210"

​
roles
object[]
required

Roles assigned to the member

​
public_metadata
object
required

Public metadata (custom fields)

Example:
{}
​
first_name
string
required

User's first name

Example:

"John"

​
last_name
string
required

User's last name

Example:

"Doe"

​
username
string | null
required

User's username

Example:

"johndoe"

​
primary_email_address
string<email> | null
required

User's primary email address

Example:

"[email protected]"

​
primary_phone_number
string | null
required

User's primary phone number with country code

Example:

"+1234567890"

​
user_created_at
string<date-time>
required

User account creation timestamp

Example:

"2024-01-10T10:00:00Z"