docs: add property tables to save list value

This commit is contained in:
Stevan Freeborn
2023-04-18 20:47:29 -05:00
parent fb8499a659
commit ef67963c62
2 changed files with 48 additions and 1 deletions
@@ -6,16 +6,64 @@ This endpoint adds or updates a list value. If a list value id is provided, the
{% table %} {% table %}
- Property Name
- Data Type
- Description
---
- `listId`
- `number`
- The id of the list to which the list value belongs.
{% /table %} {% /table %}
## Request Body Properties ## Request Body Properties
{% table %} {% table %}
- Property Name
- Data Type
- Description
---
- id
- `number`
- The id of the list value to update. If no id is provided, a new list value will be created.
---
- name
- `string`
- The name of the list value.
---
- numericValue
- `number`
- The numeric value of the list value.
---
- color
- `string`
- The color of the list value.
{% /table %} {% /table %}
## Response Body Properties ## Response Body Properties
{% table %} {% table %}
- Property Name
- Data Type
- Description
---
- id
- `string`
- The id of the list value.
{% /table %} {% /table %}
@@ -11,7 +11,6 @@ curl --location --request PUT 'https://api.onspring.com/Lists/id/906/items' \
"name": "Not Started", "name": "Not Started",
"numericValue": 0, "numericValue": 0,
"color": "#ffffff", "color": "#ffffff",
"weight": 0
}' }'
``` ```