Current section
Files
Jump to
Current section
Files
priv/docs/methods/slackLists.create.json
{
"args": {
"copy_from_list_id": {
"desc": "ID of the List to copy.",
"example": "F1234567",
"required": false,
"type": "string"
},
"description_blocks": {
"desc": "A rich text description of the List.",
"example": "[{\"type\":\"rich_text\",\"elements\":[{\"type\":\"rich_text_section\",\"elements\":[{\"type\":\"text\",\"text\":\"List to keep track of tasks!\"}]}]}]",
"required": false,
"type": "array"
},
"include_copied_list_records": {
"desc": "Boolean indicating whether to include records when a List is copied.",
"example": "false",
"required": false,
"type": "boolean"
},
"name": {
"desc": "Name of the List.",
"example": "My List",
"required": true,
"type": "string"
},
"schema": {
"desc": "Column definition for the List.",
"example": "[{ \"key\": \"task_name\", \"name\": \"Task Name\", \"type\": \"text\", \"is_primary_column\": true }, { \"key\": \"due_date\", \"name\": \"Due Date\", \"type\": \"date\" }, { \"key\": \"status\", \"name\": \"Status\", \"type\": \"select\", \"options\": { \"choices\": [ { \"value\": \"not_started\", \"label\": \"Not Started\", \"color\": \"red\" }, { \"value\": \"in_progress\", \"label\": \"In Progress\", \"color\": \"yellow\" }, { \"value\": \"completed\", \"label\": \"Completed\", \"color\": \"green\" } ] } }, { \"key\": \"assignee\", \"name\": \"Assignee\", \"type\": \"user\" }]",
"required": false,
"type": "array"
},
"todo_mode": {
"desc": "Boolean indicating whether the List should be used to track todo tasks.",
"example": "true",
"required": false,
"type": "boolean"
}
},
"desc": "Create a List.",
"errors": {
"invalid_column_type": "Column type not allowed.",
"invalid_copy_and_schema_args": "Cannot provide both `copy_from_list_id` and `schema`.",
"invalid_primary_column": "Missing or more than one primary column.",
"invalid_schema": "The schema was invalid.",
"missing_arg_copy_from_list_id": "Missing argument `copy_from_list_id`.",
"over_column_maximum": "Cannot create List with more than allowed column count.",
"over_list_file_maximum": "Cannot create any more List files.",
"over_title_length_maximum": "Title can not exceed defined length.",
"permission_denied": "The user does not have permission to perform this action.",
"team_not_found": "The team cannot be found.",
"user_not_found": "The user cannot be found."
},
"rate_limit": {
"label": "Tier 2: 20+ per minute",
"url": "https://docs.slack.dev/apis/web-api/rate-limits"
},
"scopes": {
"bot": [
{
"name": "lists:write",
"url": "https://docs.slack.dev/reference/scopes/lists.write"
}
],
"user": [
{
"name": "lists:write",
"url": "https://docs.slack.dev/reference/scopes/lists.write"
}
]
}
}