Add an existing user to a workspace

Verified current owner/admin or exact platform admin; API keys also require workspace_members write scope.

POST

https://api.channelautomation.com/api/workspace-members

Authorization

BearerAuth
HTTP Bearer (JWT)
required

Request body JSON required

workspace_id
optional
string
user_id
optional
string
role
optional
owner
or
admin
or
manager
or
agent
or
viewer

Returns

200

Operation completed

201

Member or workspace created

400

Invalid request

401

Invalid or missing verified identity

403

Current authority denied

404

Workspace or member not found

409

Existing member or workspace

503

Authority verification unavailable

Add an existing user to a workspace

curl --request POST \
  --url https://api.channelautomation.com/api/workspace-members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "string",
  "user_id": "string",
  "role": "owner"
}
'

const url = 'https://api.channelautomation.com/api/workspace-members';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({workspace_id: 'string', user_id: 'string', role: 'owner'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/workspace-members"

payload = {
    "workspace_id": "string",
    "user_id": "string",
    "role": "owner"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)