Create a Blueprint Step

POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps

Headers

Path parameters

application/json

Body Required

  • name string Required

    Name of the automation step

  • type string Required

    Must be a verified action type or a condition

  • configuration array[string] Required

    Configuration options for this step, requirements depend on type

  • parent_step_uuid string

    Uuid of the step that run before this step, if the parent step is a condition type then a condition state must be given

  • condition_state boolean

    Only required if parent step is a condition, the condition state will determine if this step runs in the true branch or the false branch of the parent condition

Responses

  • 201 application/json
    Hide response attribute Show response attribute object
    • data array[object]

      Additional properties are allowed.
POST /api/v1/automation-blueprints/{automationBlueprint_uuid}/blueprint-steps 
curl \
 -X POST https://api.plannrcrm.com/api/v1/automation-blueprints/automationBlueprint_uuid/blueprint-steps \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"name":"send an email","type":"mail.send","configuration":[{"params":{"account_uuid":{"type":"ref","value":"trigger.account.uuid"}}}],"parent_step_uuid":"string","condition_state":true}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "name": "send an email",
  "type": "mail.send",
  "configuration": [
    {
      "params": {
        "account_uuid": {
          "type": "ref",
          "value": "trigger.account.uuid"
        }
      }
    }
  ],
  "parent_step_uuid": "string",
  "condition_state": true
}
Response examples (201) 
{
  "data": [
    {
      "name": "create a new client",
      "type": "client.create",
      "uuid": "06c30b26-d5e4-4348-930a-665cd89ac37d",
      "updated": "2024-11-20T13:24:03+00:00",
      "created_at": "2024-11-20T13:24:03+00:00",
      "configuration": {
        "params": {
          "account_uuid": {
            "type": "ref",
            "value": "trigger.account.uuid"
          }
        }
      },
      "condition_state": false,
      "parent_step_uuid": "2bcd9a05-73ab-4a2d-923e-6cc1adb26cf5"
    }
  ]
}