Delete a workflow action by ID | Solvimon

curl -X DELETE https://test.api.solvimon.com/v1/workflow-actions/ \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "workflow_id": "d9f8e7c6-b5a4-4d3c-8b2a-1f0e9d8c7b6a",
  "type": "SEND_EMAIL_TO_CUSTOMER",
  "status": "ACTIVE",
  "object_type": "workflow_action",
  "id": "a3f1c9d2-7b4e-4f8a-9c3d-2e5f7a1b9d6c",
  "description": "Send invoice email to customer upon order completion",
  "created_at": "2024-04-10T09:15:00Z",
  "updated_at": "2024-04-15T11:30:00Z",
  "send_email_to_customer": {
    "integration_id": "int-1234567890",
    "template_name": "invoice_email_template",
    "variant": "INVOICE",
    "subject": "Your Invoice from Acme Corp",
    "from": {
      "email": "billing@acmecorp.com",
      "name": "Acme Billing"
    },
    "reply_to": {
      "email": "support@acmecorp.com",
      "name": "Customer Support"
    },
    "cc_recipients": [
      "accounting@acmecorp.com"
    ],
    "bcc_recipients": [
      "audit@acmecorp.com"
    ],
    "invoice": {
      "include_pdf": true,
      "include_payment_link": true,
      "include_customer_contacts_as_cc": true
    },
    "payment": {
      "include_customer_contacts_as_cc": true
    }
  }
}

Deletes the workflow action identified by the provided resource ID and returns the deleted action. Requires the WORKFLOW_ACTION.DELETE permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Response

workflow_idstring

Workflow that owns this action.

typeenum

Action type that selects the matching action configuration.

Allowed values:

statusenum

Status of the action.

Allowed values:

object_typestring or nullRead-only

idstring or nullRead-only

descriptionstring or nullformat: "^.*$"0-256 characters

Description of what this action does.

created_atstring or nullRead-only

Date time when the action was created.

updated_atstring or nullRead-only

Date time when the action was last updated.

send_email_to_customerobject

Email action configuration used to send an email to the customer.

Errors

401

Unauthorized Error

403

Forbidden Error

Authentication

Path parameters

Headers

Response

Errors