Skip to content

Create Team Member Note

POST
/team-members/{team_member_id}/notes

Leave an internal note on a member.

MENTIONING SOMEONE NOTIFIES THEM. Mentions carry an id, a name and optionally an email, and the note itself is org-internal.

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.TeamMemberNoteCreateRequest.

object
content
required

Note content.

string
mentioned_users
Array<object>

Mirrors team_members.TeamMemberMentionedUserDto.

object
email
Any of:
string
id
required
string
name
required
string

Responses

201

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