slackLists.create

View other methods

Create a list

Reference docs Tester

Facts

Method access

HTTP

JavaScript

Python

Java

HTTP

POSThttps://slack-gov.com/api/slackLists.create

Bolt for Java

app.client().slackListsCreate

Bolt for Python

app.client.slackLists_create

Bolt for JavaScript

app.client.slackLists.create

Required scopes

Bot tokenslists:write

User tokenslists:write

Content types

application/x-www-form-urlencodedapplication/json

Rate limits

Tier 2

Arguments

Required arguments

token

token

·Required

Authentication token bearing required scopes. Tokens should be passed as an HTTP Authorization header or alternatively, as a POST parameter.

Example

xxxx-xxxxxxxxx-xxxx

name

string

·Required

Name of the list

Example

My List

Optional arguments

copy_from_list_id

string

·Optional

Id of the list to copy

Example

F1234567

description_blocks

array

·Optional

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!"}]}]}]

include_copied_list_records

boolean

·Optional

Option to include records when a list is copied

Example

false

schema

array

·Optional

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" }]

todo_mode

boolean

·Optional

Boolean indicating if list should be used to track todo tasks

Default

Example

true

Usage info

This method is used to create a new standalone list owned by the acting user.

The list will be created with only one text column if none of the optional parameters are specified.

When todo_mode is set to true, the list will be create with 3 additional fields used for task tracking:

Completed: a boolean column (column type is todo_completed) to track when an item is completed or not.
Assignee: a people column (column type is todo_assignee) to store who the assignee is for a given list item.
Due date: a date column (column type is todo_due_date) to store when the list item is due.

Schema definition

Here's the definition of the schema argument, with ? denoting the field is optional:

[
  {
    "key": <string>,	// the key of the column
    "name": <string>,	// the name of the column to be displayed in the list
    "type": <string>,	// the type of column, more details in the 'Schema specific values' section
    ?"is_primary_column": <boolean>, // value to specify if the column is the primary column, only one column in the list can be primary, and it must be a text column
    ?"options": {	// column options
      ?"choices": [	// used by select columns to specify options
        {
          "value": <string>,	// the value for the option
          "label": <string>,	// the label of the option to be displayed in the list
          "color": <string>	// the color type, more details in the 'Schema specific values' section
        }
      ],
      ?"format": <string>,		// used by some columns like select to specify some options/formatting, more details in the 'Schema specific values' section
      ?"precision": <integer>,		// used by numeric columns to specify the number of decimal places
      ?"date_format": <string>,		// used by date columns to specify the format of the date, more details in the 'Schema specific values' section
      ?"emoji": <string>,		// used by rating and vote columns, this is the emoji to be displayed, e.g. ":smile:"
      ?"emoji_team_id": <string>,	// used by rating columns, this the team id the emoji belongs to
      ?"max": <integer>,			// used by rating columns to specify the maximum rate value
      ?"default_value_typed": {		// default value for some columns
        ?"user": [ <string> ],		// default user values (encoded user ids) for people column
        ?"channel": [ <string> ],	// default channel values (encoded channel ids) for channel column
        ?"select": [ <string> ]		// default select values for select column, these values should be the same ones used in choices.value
      },
      ?"show_member_name": boolean,	// used by people, channel and canvas columns to specify if the entity name should be shown, default is set to true
      ?"notify_users": boolean	 	// used by people columns to specify if the users should be notified when the column is updated
    }
  }
]

Schema specific values

When schema argument is provided, here are some of the arguments that require specific values:

schema.type:
- text
- message
- number
- select
- date
- user
- attachment
- checkbox
- email
- phone
- channel
- rating
- created_by
- last_edited_by
- created_time
- last_edited_time
- vote
- canvas
- reference
- link
schema.options.format:
- single_select: format used by select columns to select a single option
- multi_select: format used by select columns to allow multiple selections
- single_entity: format used by user and channel columns to allow only one entity in the cell
- multi_entity: format used by user and channel columns to allow multiple entities in the cell
schema.options.date_format:
- default
- DD/MM/YYYY
- MM/DD/YYYY
- YYYY/MM/DD
- MMMM DD, YYYY
- DD MMMM YYYY
schema.options.choices.color:
- indigo
- blue
- cyan
- pink
- yellow
- green
- gray
- red
- purple
- orange
- brown

Example responses

Common successful response

Typical success response

{
    "ok": true,
    "list_id": "F1234ABCD"
}

Common error response

Typical error response

{
    "ok": false,
    "error": "invalid_schema"
}

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

Error	Description
`permission_denied`	The user does not have permission to perform this action.
`invalid_schema`	The schema was invalid.
`invalid_primary_column`	Missing or more than one primary columns.
`team_not_found`	The team cannot be found.
`user_not_found`	The user cannot be found.
`over_list_file_maximum`	Cannot create any more list files.
`over_title_length_maximum`	Title can not exceed defined length.
`invalid_column_type`	Column type not allowed.
`missing_arg_copy_from_list_id`	Missing argument copy_from_list_id.
`invalid_copy_and_schema_args`	Cannot provide both copy_from_list_id and schema.
`over_column_maximum`	Cannot create list with more than allowed column count.
`access_denied`	Access to a resource specified in the request is denied.
`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.
`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.
`is_bot`	This method cannot be called by a legacy bot.
`method_deprecated`	The method has been deprecated.
`missing_scope`	The token used is not granted the specific scope permissions required to complete this request.
`not_allowed_token_type`	The token type used in this request is not allowed.
`not_authed`	No authentication token provided.
`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.
`org_login_required`	The workspace is undergoing an enterprise migration and will not be available until migration is complete.
`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.
`team_access_not_granted`	The token used is not granted the specific workspace access required to complete this request.
`accesslimited`	Access to this method is limited on the current network
`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 either called with invalid arguments or some detail about the arguments passed is invalid, which is more likely when using complex arguments like blocks or attachments.
`invalid_array_arg`	The method was passed an array as an argument. Please only input valid strings.
`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_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`.
`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.
`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_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.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

Warning	Description
`missing_charset`	The method was called via a `POST` request, and recommended practice for the specified `Content-Type` is to include a `charset` parameter. However, no `charset` was present. Specifically, non-form-data content types (e.g. `text/plain`) are the ones for which `charset` is recommended.
`superfluous_charset`	The method was called via a `POST` request, and the specified `Content-Type` is not defined to understand the `charset` parameter. However, `charset` was in fact present. Specifically, form-data content types (e.g. `multipart/form-data`) are the ones for which `charset` is superfluous.

API response

URL

POST body

Submit your arguments to see the API response