Custom Field Groups

Create card custom field group

Creates a custom field group within a card. Either baseCustomFieldGroupId or name must be provided. Requires board editor permissions.

post/cards/{cardId}/custom-field-groups

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/cards/{cardId}/custom-field-groups
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

cardIdstring required
Example:1357158568008091264

ID of the card to create the custom field group in

Request body

baseCustomFieldGroupIdstring

ID of the base custom field group used as a template

positionnumber required

Position of the custom field group within the card

namestring nullable

Name/title of the custom field group (required if baseCustomFieldGroupId is not provided)

Example request

{
  "baseCustomFieldGroupId": "1357158568008091265",
  "position": 65536,
  "name": "Properties"
}

Response

Custom field group created successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "boardId": "1357158568008091265",
    "cardId": "1357158568008091266",
    "baseCustomFieldGroupId": "1357158568008091267",
    "position": 65536,
    "name": "Properties",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.