Packages

A Slack Web & Real Time Messaging API client.

Retired package: Renamed - 1.0.0-alpha.0

Current section

Files

Jump to
slack_kit lib slack web docs slackLists.create.json
Raw

lib/slack/web/docs/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": {
"access_denied": "Access to a resource specified in the request is denied.",
"accesslimited": "Access to this method is limited on the current network",
"account_inactive": "Authentication token is for a deleted user or workspace when using a `bot` token.",
"deprecated_endpoint": "The endpoint has been deprecated.",
"ekm_access_denied": "Administrators have suspended the ability to post a message.",
"enterprise_is_restricted": "The method cannot be called from an Enterprise.",
"fatal_error": "The server could not complete your operation(s) without encountering a catastrophic error. It's possible some aspect of the operation succeeded before the error was raised.",
"internal_error": "The server could not complete your operation(s) without encountering an error, likely due to a transient issue on our end. It's possible some aspect of the operation succeeded before the error was raised.",
"invalid_arg_name": "The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than `_`. If you get this error, it is typically an indication that you have made a _very_ malformed API call.",
"invalid_arguments": "The method was called with invalid arguments.",
"invalid_array_arg": "The method was passed an array as an argument. Please only input valid strings.",
"invalid_auth": "Some aspect of authentication cannot be validated. Either the provided token is invalid or the request originates from an IP address disallowed from making the request.",
"invalid_charset": "The method was called via a `POST` request, but the `charset` specified in the `Content-Type` header was invalid. Valid charset names are: `utf-8` `iso-8859-1`.",
"invalid_column_type": "Column type not allowed.",
"invalid_copy_and_schema_args": "Cannot provide both `copy_from_list_id` and `schema`.",
"invalid_form_data": "The method was called via a `POST` request with `Content-Type` `application/x-www-form-urlencoded` or `multipart/form-data`, but the form data was either missing or syntactically invalid.",
"invalid_post_type": "The method was called via a `POST` request, but the specified `Content-Type` was invalid. Valid types are: `application/json` `application/x-www-form-urlencoded` `multipart/form-data` `text/plain`.",
"invalid_primary_column": "Missing or more than one primary column.",
"invalid_schema": "The schema was invalid.",
"method_deprecated": "The method has been deprecated.",
"missing_arg_copy_from_list_id": "Missing argument `copy_from_list_id`.",
"missing_post_type": "The method was called via a `POST` request and included a data payload, but the request did not include a `Content-Type` header.",
"missing_scope": "The token used is not granted the specific scope permissions required to complete this request.",
"no_permission": "The workspace token used in this request does not have the permissions necessary to complete the request. Make sure your app is a member of the conversation it's attempting to post a message to.",
"not_allowed_token_type": "The token type used in this request is not allowed.",
"not_authed": "No authentication token provided.",
"org_login_required": "The workspace is undergoing an enterprise migration and will not be available until migration is complete.",
"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.",
"ratelimited": "The request has been ratelimited. Refer to the `Retry-After` header for when to retry the request.",
"request_timeout": "The method was called via a `POST` request, but the `POST` data was either missing or truncated.",
"service_unavailable": "The service is temporarily unavailable",
"team_access_not_granted": "The token used is not granted the specific workspace access required to complete this request.",
"team_added_to_org": "The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.",
"team_not_found": "The team cannot be found.",
"token_expired": "Authentication token has expired",
"token_revoked": "Authentication token is for a deleted user or workspace or the app has been removed when using a `user` token.",
"two_factor_setup_required": "Two factor setup is required.",
"user_not_found": "The user cannot be found."
}
}