Options

The options resource is used to manage custom field values for various related resources.

Option object

{
  "id": "01988bb8-2044-7fd8-85aa-4k4nf23l94f2",
  "tenant": "01988bb8-1cfb-7c87-9326-93op0349288e",
  "option_field": "activities:type",
  "option_value": "Board meeting",
  "created_at": "2025-08-08 22:05:56",
  "updated_at": "2025-12-29 17:25:54"
}

Fields

• id
  required readonly string
  Unique ID of the record.
• tenant
  required readonly string
  Unique ID of the tenant.
• option_field
  required string
  Field for which the option value is defined. One of:

  • activities:type
  • communication:method
  • goals:category
  • member_applications:status
  • members:status
  • revenues:type
  • revenues:source
  • revenues:method
  • revenues:purpose
  • revenues:campaign
  • staff:status
  • tracking:item
  • units
• option_value
  required string
  Custom value for the option field. Values must be unique to the option field within the same tenant.
• created_at
  required readonly string
  UTC timestamp of when the record was created.
• updated_at
  nullable readonly string
  UTC timestamp of when the record was last updated.

Create an option

POST /tenants/{tenantId}/options

The request body must include an option object.

Required permissions

options:create

Response

List options

GET /tenants/{tenantId}/options

Required permissions

options:read

Response

Read an option

GET /tenants/{tenantId}/options/{id}

Required permissions

options:read

Response

Update an option

PATCH /tenants/{tenantId}/options/{id}

The request body must include parts of an option object.

Required permissions

options:update

Response

Delete an option

DELETE /tenants/{tenantId}/options/{id}

Required permissions

options:delete

Response