POST
/
workspaces
/
{id}
/
members
Create a workspace member
curl --request POST \
  --url https://api.steuerboard.com/v1/workspaces/{id}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-client-id: <x-client-id>' \
  --data '{
  "userId": "cmf41ajzv003706un4i99q1a0"
}'
{
  "createdAt": "2024-05-14T08:30:00Z",
  "updatedAt": "2024-06-01T12:00:00Z",
  "workspaceId": "cmf41ajzv003706un4i99q19z",
  "isMuted": false,
  "userId": "cmf41ajzv003706un4i99q1a0",
  "user": {
    "id": "cmf41ajzv003706un4i99q1a0",
    "email": "frida@example.com",
    "firstName": "Frida",
    "lastName": "Meyer"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication

Headers

​
x-client-id
string<cuid>
required

The ID of the client

Example:

"cmf41ajzv003706un4i99q19z"

Path Parameters

​
id
string<cuid>
required

The ID of the item

Example:

"cmf41ajzv003706un4i99q19z"

Body

application/json

Workspace member create

​
userId
string<cuid>
required

Identifier of the user that should be added to the workspace.

Example:

"cmf41ajzv003706un4i99q1a0"

Response

Workspace member created successfully

​
createdAt
string<date-time>
required

The date and time when the workspace membership was created. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

Example:

"2024-05-14T08:30:00Z"

​
updatedAt
string<date-time>
required

The date and time when the workspace membership was last updated. ISO-8601 format (YYYY-MM-DDTHH:MM:SSZ).

Example:

"2024-06-01T12:00:00Z"

​
workspaceId
string<cuid>
required

The identifier of the workspace the member belongs to.

Example:

"cmf41ajzv003706un4i99q19z"

​
isMuted
boolean
required

Whether the member has muted notifications for the workspace.

Example:

false

​
userId
string<cuid>
required

Identifier of the user that is a member of the workspace.

Example:

"cmf41ajzv003706un4i99q1a0"

​
user
object

Optional user object with denormalised information for convenience.