Slack.Web.SlackLists.Download (SlackKit v1.0.0-alpha.0)

View Source

Summary

Functions

Retrieve List download URL from an export job to download List contents.

Initiate a job to export List contents.

Functions

get(job_id, list_id, optional_params \\ %{})

Retrieve List download URL from an export job to download List contents.

API reference

Rate limit: Tier 4: 100+ per minute
Scopes:

View on docs.slack.dev ↗

Required Params

  • job_id - The ID of the recently started job to export the List. ex: Le48SKT566
  • list_id - ID of the List to export. ex: F1234567

Errors the API can return:

  • job_not_found - Could not find an export job matching that ID.
  • list_not_found - The List was not found.
  • permission_denied - The bot does not have permission to perform this action.
  • unknown_method - Feature not enabled for this team.

See the Common Errors guide for errors returned by every Web API method.

start(list_id, optional_params \\ %{})

Initiate a job to export List contents.

API reference

Rate limit: Tier 2: 20+ per minute
Scopes:

View on docs.slack.dev ↗

Required Params

  • list_id - ID of the List to export. ex: F1234567

Optional Params

  • include_archived -

Errors the API can return:

  • list_not_found - The List was not found.
  • permission_denied - The bot does not have permission to perform this action.
  • unknown_method - Feature not enabled for this team.

See the Common Errors guide for errors returned by every Web API method.