updateMember

PATCH

/api/v1/workspaces/{workspaceId}/members/{userId}

updateMember

curl --request PATCH \
  --url '<base-url>/api/v1/workspaces/<workspaceId>/members/<userId>' \
  --header 'Content-Type: application/json' \
  --cookie 'agenthold_session=<agenthold_session>' \
  --data '
{
  "role": "owner"
}
'

const url = '<base-url>/api/v1/workspaces/<workspaceId>/members/<userId>';
const options = {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
    cookie: 'agenthold_session=<agenthold_session>'
  },
  body: JSON.stringify({role: 'owner'})
};

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

import requests

url = "<base-url>/api/v1/workspaces/<workspaceId>/members/<userId>"

payload = { "role": "owner" }
headers = {
    "cookie": "agenthold_session=<agenthold_session>",
    "Content-Type": "application/json"
}

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

print(response.text)

Response example

{
  "user": {
    "id": "string",
    "email": "string",
    "name": "string",
    "avatarUrl": "string"
  },
  "role": "owner",
  "joinedAt": "2019-08-24T14:15:22Z"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

workspaceId
string
required
userId
string
required

Request body JSON required

role
owner
or
admin
or
member
required

Returns

200

Updated.

JSON

user
object
required
- id
  string
  required
- email
  string
  required
- name
  string
  required
- avatarUrl
  string
  required
}
role
owner
or
admin
or
member
required
joinedAt
string
required
format: date-time

403

Error.

JSON

error
string
required

404

Error.

JSON

error
string
required

409

Error.

JSON

error
string
required