Update a Automation Blueprint | PlannrCRM API documentation

Update a Automation Blueprint Run in API Explorer

PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}

Personal access token & O auth2

Path parameters

automationBlueprint_uuid string Required

The UUID of the automation

application/json

Body

name string

Name of the automation
trigger string

What triggers this automation
is_active boolean

Is this automation currently active

conditions

array[object]

List of conditions to evaluate on the trigger before running automation, operator types can be on ofequals, not_equal_to, more_than, less_than, less_than_or_equal_to and more_than_or_equal_to

Show conditions attributes object

field string

field name for the condition

operator

string

operator for the condition

Value	Description
equals	Equals
not_equal_to	Not Equal To
more_than	More Than
less_than	Less Than
less_than_or_equal_to	Less Than Or Equal To
more_than_or_equal_to	More Than Or Equal To

Values are equals, not_equal_to, more_than, less_than, less_than_or_equal_to, or more_than_or_equal_to.

value string

value for condition to check against

configuration object

Extra configuration options for the trigger of this blueprint

Additional properties are allowed.

Responses

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- name string
  
  Name of the Automation Blueprint
- trigger string
  
  What type of event will trigger this AutomationBlueprint
- is_active boolean
  
  Is the automation currently active? If false will not create new execution instances
- account object
  
  Account that made this automation blueprints
  
  Hide account attributes Show account attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  last_interaction_at string
  
  referral_code string
  
  permissions object
  
  Hide permissions attributes Show permissions attributes object
  
  firm:read array[string]
  
  network:read array[string]
  
  custom_fields string
  
  external_references string
- conditions array
  
  Conditions for the automation blueprint
- configuration array
  
  Extra configuration options for the trigger of this blueprint
- steps array[object]
  
  All blueprint steps attached to this blueprint
  
  Hide steps attributes Show steps attributes object
  
  uuid string
  
  created_at string
  
  updated string
  
  name string
  
  type string
  
  configuration object
  
  Hide configuration attribute Show configuration attribute object
  
  params object
  
  Hide params attribute Show params attribute object
  
  account_uuid object
  
  Hide account_uuid attributes Show account_uuid attributes object
  
  type string
  
  value string
  
  condition_state boolean
  
  parent_step_uuid string
- steps_count string
  
  Amount of blueprints steps on this automation blueprint
- webhook_targets array[object]
  
  List of webhook target endpoints that can be used to trigger this automation
  
  Hide webhook_targets attributes Show webhook_targets attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  url string

PUT /api/v1/automation-blueprints/{automationBlueprint_uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/automation-blueprints/dcf0-484e-a0c5-08590fe89a84-f6aa1670' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"name":"Add a new client to system on calendly webhook","trigger":"webhook","is_active":false,"conditions":[{"field":"client.is_prospect","value":true,"operator":"equals"}],"configuration":{}}'

Request examples

{
  "name": "Add a new client to system on calendly webhook",
  "trigger": "webhook",
  "is_active": false,
  "conditions": [
    {
      "field": "client.is_prospect",
      "value": true,
      "operator": "equals"
    }
  ],
  "configuration": {}
}

Response examples (200)

{
  "name": "Add new client on webhook",
  "uuid": "5a9cb7c7-3141-4718-a4df-872857fdd209",
  "steps": [
    {
      "name": "create a new client",
      "type": "client.create",
      "uuid": "6346e89e-0dc8-4059-b89a-52dfa3845de4",
      "updated": "2026-04-09T17:35:06+01:00",
      "created_at": "2026-04-09T17:35:06+01:00",
      "configuration": {
        "params": {
          "account_uuid": {
            "type": "ref",
            "value": "trigger.account.uuid"
          }
        }
      },
      "condition_state": false,
      "parent_step_uuid": "98063b04-b09a-4c73-8959-4bf99ceb2601"
    }
  ],
  "account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "097cb2a3-31cd-4fa8-afbe-69dcbe8bb9c0",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2026-04-09T17:35:06+01:00",
    "first_name": "Gareth",
    "updated_at": "2026-04-09T17:35:06+01:00",
    "with_login": true,
    "inactive_at": "2026-04-09",
    "permissions": {
      "firm:read": [
        "firm"
      ],
      "network:read": [
        "network:uuid"
      ]
    },
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "referral_code": "ABC12345",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2026-04-09T17:35:06+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2026-04-09T17:35:06+01:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "last_interaction_at": "2026-04-09 17:35:06",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2026-04-09T17:35:06+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2026-04-09T17:35:06+01:00"
  },
  "trigger": "client.create",
  "is_active": false,
  "conditions": [],
  "created_at": "2026-04-09T17:35:06+01:00",
  "updated_at": "2026-04-09T17:35:06+01:00",
  "steps_count": "1",
  "configuration": [],
  "webhook_targets": [
    {
      "url": "https://api.plannrcrm.com/api/v1/webhooks/01605357-9fba-4cab-b4f0-141476dfa4ea",
      "uuid": "960ec219-032a-4ead-980d-621505945d42",
      "created_at": "2026-04-09T17:35:06+01:00",
      "updated_at": "2026-04-09T17:35:06+01:00"
    }
  ]
}