Update Action

put https://example.com/api/v1/project/{project_string_id}/actions/{action_id}

Updates an action within a workflow.

Response

Response body

object

number

The unique identifier of the Action instance.

kind

string

The kind/type of the Action.

active

boolean

A flag indicating whether the Action is active or not.

archived

boolean

Defaults to false

A flag indicating whether the Action is archived or not.

status

string

The status of the Action.

template_id

number

The unique identifier of the Action's associated Action Template.

workflow_id

number

The unique identifier of the Action's associated Workflow.

public_name

string

The public name of the Action.

icon

string

The icon associated with the Action.

description

string

A description of the Action.

trigger_data

object

Payload of the trigger of this action

event_name

string

The name of the event to listen for triggering.

upload_directory_id_list

number

In case for directories events, the list of dir IDs to listen for.

trigger_action_id

number

The ID of the action this trigger belongs to.

config_data

object

The configuration data associated with the Action.

Has additional fields

precondition

object

Object with the metadata for the precondition

event_name

string

The name of the event to allow triggering the action, all other events will not trigger it.

completion_condition_data

object

Object with the metadata for the completion condition data.

event_name

string

The name of the event to allow triggering the action, all other events will not trigger it.

output

object

The output data of the Action.

Has additional fields

output_interface

object

The interface used for the Action's output.

Has additional fields

ordinal

number

The ordinal value of the Action.

is_root

boolean

A flag indicating whether the Action is a root Action or not.

root_id

number

The unique identifier of the Action's root Action.

parent_id

number

The unique identifier of the Action's parent Action.

child_primary_id

number

The unique identifier of the Action's primary child Action.

project_id

number

The unique identifier of the Project associated with the Action.

org_id

number

The unique identifier of the Org associated with the Action.

member_created_id

number

The unique identifier of the Member who created the Action.

member_updated_id

number

The unique identifier of the Member who last updated the Action.

time_created

string

The date and time the Action was created.

time_updated

string

The date and time the Action was last updated.

Language


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://example.com/api/v1/project/project_string_id/actions/action_id \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The updated action.