Rate this page:
POST /1/customFields
Create a new Custom Field on a board.
string
The API key to use
^[0-9a-fA-F]{32}$
string
The API token to use
^[0-9a-fA-F]{64}$
string
^[0-9a-fA-F]{24}$
string
The type of model that the Custom Field is being defined on. This should always be board
.
Valid values:Β board
string
The name of the Custom Field
string
The type of Custom Field to create.
Valid values:Β checkbox
, list
, number
, text
, date
string
If the type is checkbox
oneOf [string, number]
boolean
Whether this Custom Field should be shown on the front of Cards
true
1 2 3
curl --request POST \
--url 'https://api.trello.com/1/customFields?key=0471642aefef5fa1fa76530ce1ba4c85&token=9eb76d9a9d02b8dd40c2f3e5df18556c831d4d1fadbe2c45f8310e6c93b5c548' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
GET /1/customFields/{id}
string
ID of the Custom Field.
^[0-9a-fA-F]{24}$
string
The API key to use
^[0-9a-fA-F]{32}$
string
The API token to use
^[0-9a-fA-F]{64}$
1 2 3
curl --request GET \
--url 'https://api.trello.com/1/customFields/{id}' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
PUT /1/customFields/{id}
Update a Custom Field definition.
string
ID of the Custom Field.
^[0-9a-fA-F]{24}$
string
The API key to use
^[0-9a-fA-F]{32}$
string
The API token to use
^[0-9a-fA-F]{64}$
string
The name of the Custom Field
oneOf [string, number]
boolean
Whether to display this custom field on the front of cards
1 2 3
curl --request PUT \
--url 'https://api.trello.com/1/customFields/{id}' \
--header 'Accept: application/json'
Success
Content type | Value |
---|---|
application/json |
DELETE /1/customFields/{id}
Delete a Custom Field from a board.
string
ID of the Custom Field.
^[0-9a-fA-F]{24}$
string
The API key to use
^[0-9a-fA-F]{32}$
string
The API token to use
^[0-9a-fA-F]{64}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/customFields/{id}'
Success
A schema has not been defined for this response code.
GET /1/customFields/{id}/options
Get the options of a drop down Custom Field
string
ID of the customfield.
^[0-9a-fA-F]{24}$
string
The API key to use
^[0-9a-fA-F]{32}$
string
The API token to use
^[0-9a-fA-F]{64}$
1 2
curl --request GET \
--url 'https://api.trello.com/1/customFields/{id}/options'
Success
A schema has not been defined for this response code.
POST /1/customFields/{id}/options
Add an option to a dropdown Custom Field
string
ID of the customfield.
^[0-9a-fA-F]{24}$
string
The API key to use
^[0-9a-fA-F]{32}$
string
The API token to use
^[0-9a-fA-F]{64}$
1 2
curl --request POST \
--url 'https://api.trello.com/1/customFields/{id}/options'
Success
A schema has not been defined for this response code.
GET /1/customFields/{id}/options/{idCustomFieldOption}
Retrieve a specific, existing Option on a given dropdown-type Custom Field
string
ID of the customfielditem.
^[0-9a-fA-F]{24}$
string
ID of the customfieldoption to retrieve.
^[0-9a-fA-F]{24}$
string
The API key to use
^[0-9a-fA-F]{32}$
string
The API token to use
^[0-9a-fA-F]{64}$
1 2
curl --request GET \
--url 'https://api.trello.com/1/customFields/{id}/options/{idCustomFieldOption}'
Success
A schema has not been defined for this response code.
DELETE /1/customFields/{id}/options/{idCustomFieldOption}
Delete an option from a Custom Field dropdown.
string
ID of the customfielditem.
^[0-9a-fA-F]{24}$
string
ID of the customfieldoption to retrieve.
^[0-9a-fA-F]{24}$
string
The API key to use
^[0-9a-fA-F]{32}$
string
The API token to use
^[0-9a-fA-F]{64}$
1 2
curl --request DELETE \
--url 'https://api.trello.com/1/customFields/{id}/options/{idCustomFieldOption}'
Success
A schema has not been defined for this response code.
Rate this page: