CampaignNodeCatalogEntry

A step type that can be added to a sequence. Pass `id` as `type` in Add Node.

Properties

idstring

Catalog id — pass this as `type` when adding a node

node_typestring

The type this persists as

labelstring
descriptionstring
categorystring
"automatic""manual"
default_configobject

Config applied when the node is created

fieldsarray of

The config fields surfaced in the builder. Fields marked required are enforced when adding or updating a node.

keystring
labelstring
typestring
requiredboolean
optionsarray of
object

Example

CampaignNodeCatalogEntry example
{
  "id": "manual_email",
  "node_type": "send",
  "label": "Manual Email",
  "description": "string",
  "category": "automatic",
  "default_config": {},
  "fields": [
    {
      "key": "string",
      "label": "string",
      "type": "string",
      "required": false,
      "options": [
        {}
      ]
    }
  ]
}