Member statuses
Status definitions and assignments describe a member’s current or resolved status.
Object schema
Fields returned by List member status definition holders. Individual endpoint pages document their complete response shapes.
| Name | Type | Required | Description |
|---|---|---|---|
assignmentId | string | Optional | Assignment Id. |
targetKind | string | Optional | Target Kind. Allowed values: "member", "active_front", "account". |
memberId | null | string | Optional | Associated member identifier. |
memberName | null | string | Optional | Member Name. |
memberDisplayName | null | string | Optional | Member Display Name. |
id | string | Optional | Unique identifier. |
userId | string | Optional | Owning account identifier. |
name | string | Optional | Name of the resource. |
description | null | string | Optional | Description of the resource. |
icon | string | Optional | Icon. |
iconType | string | Optional | Icon Type. Allowed values: "custom", "emoji", "lucide". |
colour | null | string | Optional | Colour. |
avatarRingShape | null | string | Optional | Avatar Ring Shape. |
position | number | Optional | Position. |
deletedAt | null | number | Optional | Deletion time; null when active. |
purgeAt | null | number | Optional | Purge At. |
createdAt | number | Optional | Creation time. |
updatedAt | number | Optional | Most recent update time. |
privacyBucketIds | array<string> | Optional | Privacy Bucket Ids. |
Endpoints
16 operations
PUTSet member status definition privacy buckets
/api/v1/member-statuses/{definitionId}/privacy-bucketsPOSTRestore member status definition/api/v1/member-statuses/{definitionId}/restoreGETList member status definition holders/api/v1/member-statuses/{definitionId}PATCHUpdate member status definition/api/v1/member-statuses/{definitionId}DELETEDelete member status definition/api/v1/member-statuses/{definitionId}GETList account member statuses/api/v1/member-statuses/assignments/accountPOSTAssign member status to account/api/v1/member-statuses/assignments/accountPOSTAssign member status to active front/api/v1/member-statuses/assignments/active-frontPOSTAssign member status to members/api/v1/member-statuses/assignments/membersPOSTAssign member status/api/v1/member-statuses/assignmentsPOSTUnassign member status/api/v1/member-statuses/assignments/unassignPOSTReorder member status definitions/api/v1/member-statuses/reorderGETList member status definitions/api/v1/member-statusesPOSTCreate member status definition/api/v1/member-statusesGETList member statuses for member/api/v1/members/{memberId}/statusesDELETEClear member statuses for member/api/v1/members/{memberId}/statusesReference shortcuts
List member status definitionsCreate member status definitionList member statuses for memberAssign member statusfriend statusesList member status definition holdersUpdate member status definitionDelete member status definitionReorder member status definitionsRestore member status definitionSet member status definition privacy bucketsList account member statusesAssign member status to accountAssign member status to active frontAssign member status to membersUnassign member statusClear member statuses for memberconceptslist holdersobject schemaendpoints
