Custom fields
Custom field definitions describe additional profile fields; values belong to individual members.
Object schema
Fields returned by List custom fields (one item from the collection). Individual endpoint pages document their complete response shapes.
| Name | Type | Required | Description |
|---|---|---|---|
type | string | Required | Type. |
id | string | Required | Unique identifier. |
userId | string | Required | Owning account identifier. |
description | null | string | Required | Description of the resource. |
memberId | null | string | Required | Associated member identifier. |
icon | null | string | Required | Icon. |
deletedAt | null | number | Required | Deletion time; null when active. |
purgeAt | null | number | Required | Purge At. |
background | null | string | Required | Background storage reference. |
label | string | Required | Label. |
orderIndex | number | Required | Order Index. |
colSpan | number | Required | Col Span. |
rowSpan | number | Required | Row Span. |
required | null | boolean | Required | Required. |
value | null | string | array<string> | Required | Value. |
ownerUserId | string | Optional | Owner User Id. |
privacyBucketIds | array<string> | Required | Privacy Bucket Ids. Privacy bucket ids for friend visibility; at least one once configured (legacy rows may be empty). |
Endpoints
7 operations
POSTRestore custom field definition
/api/v1/members/{memberId}/custom-fields/{fieldId}/restorePATCHUpdate custom field definition/api/v1/members/{memberId}/custom-fields/{fieldId}DELETEDelete custom field definition/api/v1/members/{memberId}/custom-fields/{fieldId}PUTSet custom field value/api/v1/members/{memberId}/custom-fields/{fieldId}/valuePOSTReorder custom fields/api/v1/members/{memberId}/custom-fields/reorderGETList custom fields/api/v1/members/{memberId}/custom-fieldsPOSTCreate custom field definition/api/v1/members/{memberId}/custom-fields