Update a company team member
PUT
/api/v3/teams/company/{platformUserUniqueId}
const url = 'https://api.tryletterhead.com/api/v3/teams/company/example';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"role":"administrator","channels":["amazing-example"],"accountAdminAccess":true}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.tryletterhead.com/api/v3/teams/company/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "role": "administrator", "channels": [ "amazing-example" ], "accountAdminAccess": true }'Changes an existing team member’s role, channel access, or account-admin access.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” platformUserUniqueId
required
string
The team member’s unique identifier, from the team member list.
Request Body required
Section titled “Request Body required ” Media type application/json
object
role
required
string
channels
required
Channel slugs this member has access to.
Array<string>
accountAdminAccess
required
boolean
Example
{ "role": "administrator", "channels": [ "amazing-example" ], "accountAdminAccess": true}Responses
Section titled “ Responses ”200 OK
Media type application/json
object
items
Array
message
string
total
integer
Example
{ "items": [], "message": "Team member updated.", "total": 10}Still can’t find what you need? Contact support.