Sign in

v1

latestOpenAPI 3.0.02026-07-26392662.9 KB
Custom Field Values

Set a custom field value on an organisation

put/v1/workspaces/{workspaceUuid}/organisations/{organisationUuid}/custom-fields/{key}

Path parameters

workspaceUuidstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

The UUID of the workspace

organisationUuidstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

The UUID of the organisation

keystring required
Example:industry

The key of the custom field

Request body

valuestring required

The value to set for the field

Example request

{
  "value": "Technology"
}

Response

The custom field value that was set

field_identifierstring

The identifier of the field

field_keystring

The machine-readable key of the field

field_typestring

The data type of the field

valuestring

The value of the field

sourcestring

The source of the value

updated_atstring date-time nullable

Example response

{
  "field_identifier": "industry",
  "field_key": "industry",
  "field_type": "text",
  "value": "Technology",
  "source": "manual",
  "updated_at": "2024-01-01T00:00:00Z"
}