workflows.updateStep

Update the configuration for a workflow step.

Reference docs Tester

Method access

HTTP

JavaScript

Python

Java

HTTP

POSThttps://slack.com/api/workflows.updateStep

Bolt for Java

app.client().workflowsUpdateStep

Bolt for Python

app.client.workflows_updateStep

Bolt for JavaScript

app.client.workflows.updateStep

Required scopes

Bot tokensworkflow.steps:execute

Content types

application/x-www-form-urlencodedapplication/json

Rate limits

Tier 2

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

workflow_step_edit_id

string

·Required

A context identifier provided with view_submission payloads used to call back to workflows.updateStep.

Optional arguments

inputs

object

·Optional

A JSON key-value map of inputs required from a user during configuration. This is the data your app expects to receive when the workflow step starts. Please note: the embedded variable format is set and replaced by the workflow system. You cannot create custom variables that will be replaced at runtime. Read more about variables in workflow steps here.

Example

{"title":{"value":"The Title"},"submitter":{"value":"{{user}}"}}

outputs

array

·Optional

An JSON array of output objects used during step execution. This is the data your app agrees to provide when your workflow step was executed.

Example

[{"name":"ticket_id","type":"text","label":"Ticket ID"},{"name":"title","type":"text","label":"Title"}]

step_image_url

string

·Optional

An optional field that can be used to override app image that is shown in the Workflow Builder.

step_name

string

·Optional

An optional field that can be used to override the step name that is shown in the Workflow Builder.

Usage info

Steps from Apps is deprecated
We're retiring all Slack app functionality around Steps from Apps in September 2024. Learn more.

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
`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_inputs`	Error returned when an input is missing the required `value` key
`invalid_payload`	Error returned when the payload is invalid
`invalid_token`	Error returned when the token used is invalid.
`invalid_trigger`	Error returned when the provided `workflow_step_edit_id` does not match any steps in the workflow
`not_found`	Error returned when the `context_id` is invalid
`trigger_expired`	Error returned when there was a timeout between view submission and `workflows.updateStep` call
`unsupported_context_type`	The `context_type` is unsupported
`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.
`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.
`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.

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
`method_deprecated`	Steps from Apps for Legacy Workflow Builder is deprecated. Read https://api.slack.com/changelog/2023-08-workflow-steps-from-apps-step-back for more info.
`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

This method is deprecated.

workflows.updateStep

Facts

Method access

Required scopes

Content types

Rate limits

Arguments

Usage info

Example responses

Errors

Warnings

Arguments

API response