Skip to content

Update Team Member

PATCH
/team-members/{team_member_id}

Edit somebody else’s roster record. Omitted fields are left alone.

Authorizations

Parameters

Path Parameters

team_member_id
required

Team member id.

string

Team member id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors team_members.TeamMemberUpdateRequest, field for field.

Every field is optional and an omitted field is LEFT ALONE - this is a PATCH, not a replacement.

object
achievements
Any of:
Array<string>
avatar_url
Any of:
string
bio_full
Any of:
string
bio_short
Any of:
string
certifications
Any of:
Array<string>
company
Any of:
string
<= 255 characters
custom_notes
Any of:
string
department
Any of:
string
<= 100 characters
expertise_areas
Any of:
Array<string>
languages
Any of:
Array<string>
linkedin_url
Any of:
string
name
Any of:
string
>= 1 characters <= 255 characters
personal_interests
Any of:
Array<string>
personal_website
Any of:
string
phone
Any of:
string
<= 50 characters
preferences
Any of:
object
key
additional properties
any
responsibilities
Any of:
string
timezone
Any of:
string
<= 100 characters
title
Any of:
string
<= 255 characters
tools_platforms
Any of:
Array<string>
topics_of_interest
Any of:
Array<string>
twitter_url
Any of:
string
voice_tone
Any of:
string
<= 50 characters

Responses

200

Successful Response

object
data
required

An open envelope for a single role, team, member or account record.

Open on purpose. The app’s own response models on this surface grow with the product - RoleResponse gained rep_limits and manages_role_slugs, TeamResponse gained channel counts and a campaign count - and a pinned mirror would SILENTLY DROP whatever it had not caught up on. A dropped permission in a role read is the worst possible kind of stale: it reads as “they do not have it”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string