workflowActions

Update a workflow action by ID

Updates workflow action fields. Requires the WORKFLOW_ACTION.UPDATE permission.

patch/v{version}/workflow-actions/{resourceId}

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/workflow-actions/{resourceId}
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

resourceIdstring required

The ID of the resource to be requested.

Headers

x-platform-idstring

Platform ID.

Request body

object_typestring nullable
idstring nullable
workflow_idstring

Workflow that owns this action.

type'SEND_EMAIL_TO_CUSTOMER' | 'EXPORT_TO_ERP' | 'SEND_WEBHOOK'

Action type that selects the matching action configuration.

descriptionstring nullable

Description of what this action does.

status'ACTIVE' | 'INACTIVE' | 'DRAFT' | 'ARCHIVED'

Status of the action.

created_atstring nullable

Date time when the action was created.

updated_atstring nullable

Date time when the action was last updated.

Response

OK

object_typestring nullable
idstring nullable
workflow_idstring

Workflow that owns this action.

type'SEND_EMAIL_TO_CUSTOMER' | 'EXPORT_TO_ERP' | 'SEND_WEBHOOK'

Action type that selects the matching action configuration.

descriptionstring nullable

Description of what this action does.

status'ACTIVE' | 'INACTIVE' | 'DRAFT' | 'ARCHIVED'

Status of the action.

created_atstring nullable

Date time when the action was created.

updated_atstring nullable

Date time when the action was last updated.

Changes

No recorded changes to this operation across all 1 revision of this API.