> ## Documentation Index > Fetch the complete documentation index at: https://docs.journeybee.io/llms.txt > Use this file to discover all available pages before exploring further. # Create an automation workflow (label, description, trigger, partner types, schedule) > Creates an inactive draft. The trigger, partner types and schedule are optional: an omitted trigger starts as an unset entity_change trigger, and omitted partner types start as every partner type the company runs. Add the graph with updateAutomationWorkflow and switch the workflow on with toggleAutomation. ## OpenAPI ````yaml /openapi.json post /automations/ openapi: 3.1.0 info: title: Journeybee API description: >- Public REST API for the Journeybee PRM platform. Manage partners, leads, deals, products, pricing calculators, tasks, and more programmatically. All endpoints require authentication via API key. Use `Authorization: Bearer ` or `Api-Key ` header. See the [Authentication guide](/guides/authentication) for details. version: 1.0.0 servers: - url: https://api.journeybee.io/v1 description: Production security: - apiKey: [] tags: - name: Account description: >- Authenticated company account info, API key permissions, and enabled modules - name: Agreement Templates - name: Agreements - name: Analytics description: >- Dashboard analytics and reporting — commission, engagement, LMS, and partner revenue metrics - name: Assets description: File and media asset management - name: Attributions description: Attribution type definitions - name: Audit Log description: Unified audit log of company activity (read-only) - name: Automations description: Workflow automation rule configurations - name: Campaign Audience description: Audience filters on a campaign - name: Campaign Partners description: Partners shared into a campaign audience - name: Campaigns description: Partner marketing campaigns - name: Card Assignees description: Assigned users on a card - name: Card Partners description: Partners linked to a card - name: Card Tags description: Tags on a card - name: Cards description: Kanban project cards - name: Categories description: Partner categories - name: Certification Categories description: Categories on a certification - name: Certification Enrollments description: User enrollments in a certification - name: Certification Folders description: Folders on a certification - name: Certification Resources description: Curriculum resources in a certification - name: Certifications description: LMS certifications - name: Commissions description: >- Commission rule configurations with calculation entries, tier/category/partnership scoping - name: Contacts description: Partner contacts across partnerships - name: Currencies description: Available currencies - name: Custom Field Options description: Options on select/multi-select custom fields - name: Custom Field Rules description: Visibility and requirement rules on custom fields - name: Custom Field Values description: Custom field values - name: Custom Fields description: Custom field definitions - name: Deal Commission description: Commission calculation on a deal - name: Deal Custom Field Values description: Custom field values on a deal - name: Deal Notes description: Notes on a deal - name: Deal Partner Roles description: Roles a supporting (co-sell) partner can hold on a deal - name: Deal Partners description: Supporting (co-sell) partners on a deal - name: Deal Payments description: Payment records on a deal (read-only) - name: Deal Products description: Products attached to a deal - name: Deal Stages description: Deal pipeline stages - name: Deal Tags description: Tags on a deal - name: Deal Tasks description: Tasks on a deal - name: Deals description: Deal management - name: Event Subscriptions - name: Event Types - name: Folders description: Content folders - name: Integrations description: Company integration settings - name: Lead Attributions description: Attribution records on a lead - name: Lead Contacts description: Partner contacts on a lead - name: Lead Custom Field Values description: Custom field values on a lead - name: Lead Distributor description: Distributors for a lead - name: Lead Notes description: Notes on a lead - name: Lead Products description: Products attached to a lead - name: Lead Quotes description: >- Quotes on a lead — generated from pricing calculators with line items and totals - name: Lead Tags description: Tags on a lead - name: Lead Tasks description: Tasks on a lead - name: Lead Users description: Assigned users on a lead - name: Leads description: Lead management - name: Marketing Templates description: Marketing email templates - name: Partner Contacts description: Contacts on a partner - name: Partner Custom Field Values description: Custom field values on a partner - name: Partner Domains description: Domains on a partner - name: Partner Notes description: Notes on a partner - name: Partner Resellers description: Reseller assignments on a distributor - name: Partner Stages description: Partner pipeline stages - name: Partner Tags description: Tags on a partner - name: Partner Users description: Assigned users on a partner - name: Partners description: Core partner CRUD - name: Pricing Calculator Fields description: Input fields on a pricing calculator - name: Pricing Calculator Formulas description: Discount/tax/surcharge formulas on a pricing calculator - name: Pricing Calculator Products description: Products attached to a pricing calculator - name: Pricing Calculators description: Pricing calculator configurations - name: Products description: Product catalog - name: Resource Blocks description: Content blocks within a resource - name: Resource Categories description: Categories on a resource - name: Resource Folders description: Folders on a resource - name: Resource Tags description: Tags on a resource - name: Resources description: Learning resources - name: Room Blocks description: Content blocks within a room - name: Room Categories description: Category-based room access control - name: Room Partnerships description: Direct partnership room access - name: Room Secure Files description: >- Private files in a secure_files room block: folders, multipart uploads, signed download links and download history - name: Room Stages description: Stage-based room access control - name: Room Tags description: Tag-based room access control - name: Room Tiers description: Tier-based room access control - name: Rooms description: Partner portal rooms - name: Tags description: Tag definitions - name: Task Users description: Assigned users on a task - name: Tasks description: Task management - name: Tiers description: Partner tiers - name: Users description: Company team members - name: Webhook Events description: Outbound webhook payloads sent to your configured URLs when events occur paths: /automations/: post: tags: - Automations summary: >- Create an automation workflow (label, description, trigger, partner types, schedule) description: >- Creates an inactive draft. The trigger, partner types and schedule are optional: an omitted trigger starts as an unset entity_change trigger, and omitted partner types start as every partner type the company runs. Add the graph with updateAutomationWorkflow and switch the workflow on with toggleAutomation. operationId: createAutomation requestBody: required: true content: application/json: schema: type: object properties: label: type: string description: anyOf: - type: string - type: 'null' trigger_type: type: string enum: - entity_change - user_action - scheduled - manual - stage_change - engagement trigger_entity: anyOf: - type: string enum: - partnership - lead - deal - resource - certification - user - card - campaign - form - engagement - task - room - agreement - type: 'null' trigger_event: description: >- Entity-change triggers only; null for every other trigger type. anyOf: - type: string enum: - created - updated - deleted - viewed - completed - stage_entered - stage_exited - started - downloaded - clicked - shared - submitted - failed - goal_completed - form_submitted - goal_date_reached - sent - signed - declined - voided - expired - type: 'null' trigger_fields: description: >- Entity-change `updated` triggers: the columns to watch. Null = any field. anyOf: - maxItems: 100 type: array items: type: string maxLength: 200 - type: 'null' trigger_config: oneOf: - type: object properties: kind: type: string enum: - stage_change stageUuid: description: >- The stage the trigger watches: a partner stage uuid for a partnership trigger, a deal stage uuid for a deal trigger. Null for a project (card) trigger, which targets `phase` instead, and on a half-built draft. anyOf: - type: string - type: 'null' phase: description: >- Project (card) triggers only: the board-agnostic kanban lifecycle phase. Null for every other entity. anyOf: - type: string enum: - backlog - planned - in_progress - in_review - completed - on_hold - cancelled - type: 'null' stageType: description: >- Derived from trigger_entity (partnership_stage, lead_deal_stage or kanban_stage). Optional on write; when sent it must match. type: string enum: - partnership_stage - lead_deal_stage - kanban_stage triggerOn: type: string enum: - enter - exit - both required: - kind - triggerOn additionalProperties: false - type: object properties: kind: type: string enum: - entity_change required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - scheduled required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - certification certificationUuids: maxItems: 100 type: array items: type: string description: >- Certifications of this company that fire the trigger. Empty = any certification. required: - kind - certificationUuids additionalProperties: false - type: object properties: kind: type: string enum: - task parentEntity: type: string enum: - partnership - lead - deal - card description: >- The record type the task belongs to; the workflow's steps run on that record. statuses: description: >- Statuses that fire the trigger. Absent or empty = `done`. maxItems: 4 type: array items: type: string enum: - to_do - in_progress - in_review - done titleMatch: description: >- Which task titles fire the trigger. Absent = any title. type: object properties: mode: default: any type: string enum: - any - equals - contains value: default: '' type: string maxLength: 200 required: - mode - value additionalProperties: false required: - kind - parentEntity additionalProperties: false - type: object properties: kind: type: string enum: - room_goal roomUuid: description: >- The room's uuid: a `custom` room of this company that partners can be shown (not archived, not a template's, not `internal_only`). Null (or absent) means any room. anyOf: - type: string - type: 'null' roomBlockUuid: description: >- The goals block's uuid (a `goals` block in such a room; in `roomUuid` when both are given). Null (or absent) means any goals block. anyOf: - type: string - type: 'null' goalIds: description: >- Goal ids from the block's `content.goals[].id`; needs `roomBlockUuid`. Absent or empty = every goal in the block. maxItems: 50 type: array items: type: string maxLength: 100 completion: description: >- `each` (the default) fires on every completion of a selected goal; `all` fires on the completion that finishes every selected goal (every goal in the block when none are selected). type: string enum: - each - all required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - room_form roomUuid: description: >- The room's uuid: a `custom` room of this company that partners can be shown (not archived, not a template's, not `internal_only`). Null (or absent) means any room. anyOf: - type: string - type: 'null' roomBlockUuid: description: >- The form block's uuid (a `form` block in such a room; in `roomUuid` when both are given). Null (or absent) means any form block. anyOf: - type: string - type: 'null' required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - room_goal_date roomUuid: description: >- The room's uuid: a `custom` room of this company that partners can be shown (not archived, not a template's, not `internal_only`). Null (or absent) means any room. Required to go live. anyOf: - type: string - type: 'null' roomBlockUuid: description: >- The goals block whose start or target date the trigger counts from (a `goals` block in `roomUuid`). Required to go live. anyOf: - type: string - type: 'null' anchor: description: Which block date to count from. Absent = `start`. type: string enum: - start - target offsetDays: description: >- Days from the date (negative = before, 0 = on the day), at most 365 either way. Absent = 0. type: integer minimum: -365 maximum: 365 required: - kind additionalProperties: false description: >- The trigger's detail, keyed by `kind`, which must match the trigger: `certification`, `task` and the room kinds (`room_goal` for goal_completed, `room_form` for form_submitted, `room_goal_date` for goal_date_reached) follow trigger_entity; otherwise `stage_change`, `scheduled` or `entity_change` follow trigger_type. partner_type_referral: type: boolean partner_type_reseller: type: boolean partner_type_distributor: type: boolean schedule: description: >- Scheduled triggers only: when the workflow runs. Null = no cadence (what a GET returns for any other trigger). anyOf: - type: object properties: schedule_type: type: string enum: - cron - interval - once cron_expression: description: >- Five-field cron expression (UTC) for `cron` schedules: minute hour day-of-month month day-of-week, each `*`, a number, a range, a list or a step; at most 100 characters, and it must be able to run. To go live it must leave at least 30 minutes between runs. anyOf: - type: string maxLength: 100 - type: 'null' interval_minutes: description: >- Minutes between runs for `interval` schedules, a whole number up to 525600 (at least 30 to go live). anyOf: - type: integer minimum: 1 maximum: 525600 - type: 'null' scheduled_at: description: The run time of a `once` schedule. anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ - type: 'null' timezone: description: >- Only UTC is supported: every schedule runs in UTC. Absent = UTC. type: string enum: - UTC required: - schedule_type additionalProperties: false - type: 'null' required: - label additionalProperties: false responses: '201': description: Default Response content: application/json: schema: type: object properties: uuid: type: string label: type: string description: anyOf: - type: string - type: 'null' active: type: boolean trigger_type: type: string enum: - entity_change - user_action - scheduled - manual - stage_change - engagement trigger_entity: anyOf: - type: string enum: - partnership - lead - deal - resource - certification - user - card - campaign - form - engagement - task - room - agreement - type: 'null' trigger_event: anyOf: - type: string enum: - created - updated - deleted - viewed - completed - stage_entered - stage_exited - started - downloaded - clicked - shared - submitted - failed - goal_completed - form_submitted - goal_date_reached - sent - signed - declined - voided - expired - type: 'null' partner_type_referral: type: boolean partner_type_reseller: type: boolean partner_type_distributor: type: boolean created_at: type: string updated_at: type: string trigger_fields: anyOf: - type: array items: type: string - type: 'null' trigger_config: anyOf: - oneOf: - type: object properties: kind: type: string enum: - stage_change stageUuid: description: >- The stage the trigger watches: a partner stage uuid for a partnership trigger, a deal stage uuid for a deal trigger. Null for a project (card) trigger, which targets `phase` instead, and on a half-built draft. anyOf: - type: string - type: 'null' phase: description: >- Project (card) triggers only: the board-agnostic kanban lifecycle phase. Null for every other entity. anyOf: - type: string enum: - backlog - planned - in_progress - in_review - completed - on_hold - cancelled - type: 'null' stageType: description: >- Derived from trigger_entity (partnership_stage, lead_deal_stage or kanban_stage). Optional on write; when sent it must match. type: string enum: - partnership_stage - lead_deal_stage - kanban_stage triggerOn: type: string enum: - enter - exit - both required: - kind - triggerOn additionalProperties: false - type: object properties: kind: type: string enum: - entity_change required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - scheduled required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - certification certificationUuids: type: array items: type: string description: >- Certifications of this company that fire the trigger. Empty = any certification. required: - kind - certificationUuids additionalProperties: false - type: object properties: kind: type: string enum: - task parentEntity: type: string enum: - partnership - lead - deal - card description: >- The record type the task belongs to; the workflow's steps run on that record. statuses: description: >- Statuses that fire the trigger. Absent or empty = `done`. type: array items: type: string enum: - to_do - in_progress - in_review - done titleMatch: description: >- Which task titles fire the trigger. Absent = any title. type: object properties: mode: default: any type: string enum: - any - equals - contains value: default: '' type: string maxLength: 200 required: - mode - value additionalProperties: false required: - kind - parentEntity additionalProperties: false - type: object properties: kind: type: string enum: - room_goal roomUuid: description: >- The room's uuid: a `custom` room of this company that partners can be shown (not archived, not a template's, not `internal_only`). Null (or absent) means any room. anyOf: - type: string - type: 'null' roomBlockUuid: description: >- The goals block's uuid (a `goals` block in such a room; in `roomUuid` when both are given). Null (or absent) means any goals block. anyOf: - type: string - type: 'null' goalIds: description: >- Goal ids from the block's `content.goals[].id`; needs `roomBlockUuid`. Absent or empty = every goal in the block. maxItems: 50 type: array items: type: string maxLength: 100 completion: description: >- `each` (the default) fires on every completion of a selected goal; `all` fires on the completion that finishes every selected goal (every goal in the block when none are selected). type: string enum: - each - all required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - room_form roomUuid: description: >- The room's uuid: a `custom` room of this company that partners can be shown (not archived, not a template's, not `internal_only`). Null (or absent) means any room. anyOf: - type: string - type: 'null' roomBlockUuid: description: >- The form block's uuid (a `form` block in such a room; in `roomUuid` when both are given). Null (or absent) means any form block. anyOf: - type: string - type: 'null' required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - room_goal_date roomUuid: description: >- The room's uuid: a `custom` room of this company that partners can be shown (not archived, not a template's, not `internal_only`). Null (or absent) means any room. Required to go live. anyOf: - type: string - type: 'null' roomBlockUuid: description: >- The goals block whose start or target date the trigger counts from (a `goals` block in `roomUuid`). Required to go live. anyOf: - type: string - type: 'null' anchor: description: >- Which block date to count from. Absent = `start`. type: string enum: - start - target offsetDays: description: >- Days from the date (negative = before, 0 = on the day). Absent = 0. type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - kind additionalProperties: false description: >- The trigger's detail, keyed by `kind`, which must match the trigger: `certification`, `task` and the room kinds (`room_goal` for goal_completed, `room_form` for form_submitted, `room_goal_date` for goal_date_reached) follow trigger_entity; otherwise `stage_change`, `scheduled` or `entity_change` follow trigger_type. - type: 'null' description: >- Null only when the stored trigger refers to a room, block or stage that no longer exists (it can never fire as saved); send a new trigger_config to repair it. schedule: anyOf: - type: object properties: schedule_type: type: string enum: - cron - interval - once cron_expression: description: >- Five-field cron expression (UTC) for `cron` schedules. anyOf: - type: string - type: 'null' interval_minutes: description: >- Minutes between runs for `interval` schedules (at least 30 to go live). anyOf: - type: number - type: 'null' scheduled_at: description: The run time of a `once` schedule. anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ - type: 'null' timezone: description: Absent = UTC. type: string required: - schedule_type additionalProperties: false - type: 'null' description: >- The cadence of a scheduled trigger; null for any other trigger. workflow_definition: type: object properties: nodes: type: array items: oneOf: - type: object properties: id: type: string type: type: string enum: - trigger position: type: object properties: x: type: number 'y': type: number required: - x - 'y' additionalProperties: false data: type: object properties: label: type: string triggerType: type: string enum: - entity_change - user_action - scheduled - manual - stage_change - engagement required: - label additionalProperties: false required: - id - type - position - data additionalProperties: false - type: object properties: id: type: string type: type: string enum: - condition position: type: object properties: x: type: number 'y': type: number required: - x - 'y' additionalProperties: false data: type: object properties: label: type: string config: $ref: '#/components/schemas/ConditionTree' required: - label - config additionalProperties: false required: - id - type - position - data additionalProperties: false - type: object properties: id: type: string type: type: string enum: - action position: type: object properties: x: type: number 'y': type: number required: - x - 'y' additionalProperties: false data: oneOf: - type: object properties: label: type: string actionType: type: string enum: - field_update config: type: object properties: fieldName: type: string fieldValue: description: >- For fieldName `stage_id`, `tier_id` or `category_id` this is the target resource's uuid (string), not its internal id — the stage table is the partnership pipeline or the deal pipeline depending on the automation's trigger_entity. `null` clears the field. For a deal automation's fieldName `expiration_date`, `null` removes the deal's expiry and a whole number N from 1 to 3650 sets it to N days after the step runs. anyOf: - type: string - type: number - type: boolean - type: 'null' required: - fieldName - fieldValue additionalProperties: false required: - label - actionType - config additionalProperties: false - type: object properties: label: type: string actionType: type: string enum: - tag config: type: object properties: action: type: string enum: - add - replace tagUuids: type: array items: type: string required: - action - tagUuids additionalProperties: false required: - label - actionType - config additionalProperties: false - type: object properties: label: type: string actionType: type: string enum: - assigned_users config: type: object properties: action: type: string enum: - add - replace userUuids: type: array items: type: string required: - action - userUuids additionalProperties: false required: - label - actionType - config additionalProperties: false - type: object properties: label: type: string actionType: type: string enum: - task config: type: object properties: title: type: string assignedUserUuids: type: array items: type: string priority: type: string enum: - low - medium - high - urgent dueDateOffsetDays: type: number document: type: object properties: type: type: string content: type: array items: type: object additionalProperties: true required: - type additionalProperties: false required: - title additionalProperties: false required: - label - actionType - config additionalProperties: false - type: object properties: label: type: string actionType: type: string enum: - note config: type: object properties: document: type: object properties: type: type: string content: type: array items: type: object additionalProperties: true required: - type additionalProperties: false mentionUuids: type: array items: type: string required: - document additionalProperties: false required: - label - actionType - config additionalProperties: false - type: object properties: label: type: string actionType: type: string enum: - send_marketing_email config: type: object properties: template_uuid: description: >- The marketing email template's uuid. Required to configure a send_marketing_email action; only appears as null in a response, when the stored template id no longer resolves (deleted). anyOf: - type: string - type: 'null' subject_override: type: string physical_address: type: string required: - template_uuid additionalProperties: false required: - label - actionType - config additionalProperties: false - type: object properties: label: type: string actionType: type: string enum: - create_deal config: type: object properties: stageUuids: description: >- Deal stage per partner type (uuid of a deal stage of that partner type). Distributor deals use the reseller stage. Absent = the first stage, as when adding a deal by hand. type: object properties: referral: type: string reseller: type: string additionalProperties: false tagUuids: description: Deal tags to add to the new deal. maxItems: 100 type: array items: type: string expirationDays: description: >- Days until the new deal expires. Null or absent = the partnership's, then the company's, default. anyOf: - type: integer exclusiveMinimum: 0 maximum: 3650 - type: 'null' customFields: description: >- Fixed values for deal custom fields. A run keeps only the fields of the lead's partner type (distributor uses reseller fields). maxItems: 100 type: array items: type: object properties: customFieldUuid: type: string value: type: object properties: text: description: Value for text-like fields anyOf: - type: string - type: 'null' textarea: description: >- Legacy value key for textarea fields; write using text anyOf: - type: string - type: 'null' number: description: Value for number fields anyOf: - type: number - type: string - type: 'null' date: description: >- Value for date fields (ISO 8601 date string) anyOf: - type: string - type: 'null' boolean: description: Value for checkbox fields anyOf: - type: boolean - type: string - type: 'null' select: description: Option ID for single-select fields anyOf: - type: number - type: 'null' multi_select: description: Option IDs for multi-select fields anyOf: - type: array items: type: number - type: 'null' additionalProperties: false required: - customFieldUuid - value additionalProperties: false leadFieldMappings: description: >- Lead values to copy into deal custom fields, at most one row per deal field. A copied value wins over the field's fixed value in customFields, which is used instead when the lead's value is empty (blank, an option with no pair, or not valid for the deal field). A required deal field left empty fails the run. Like fixed values, a run keeps only the rows whose deal field is of the lead's partner type (distributor uses reseller fields), and fields hidden or locked by custom-field rules are left to the rules. Nothing is blocked for visibility: copying an internal lead field into a shared deal field means partners will see the value on the deal, and copying a lead field partners can fill in (a shared lead field, or one of the lead's own fields, since partners submit leads) into an internal number, select, multi-select, checkbox or boolean deal field means partners can set a value that commissions or payments may read. maxItems: 100 type: array items: type: object properties: targetCustomFieldUuid: type: string description: >- The deal custom field (category lead_deal) the value is copied into. source: oneOf: - type: object properties: kind: type: string enum: - standard field: type: string enum: - company_name - first_name - last_name - email - phone_number - source required: - kind - field additionalProperties: false - type: object properties: kind: type: string enum: - custom customFieldUuid: type: string required: - kind - customFieldUuid additionalProperties: false description: >- Where the value comes from: one of the lead's own fields (all text), or a lead custom field (category lead) of the deal field's partner type (distributor lead fields count as reseller). The types must fit: anything copies into a text, textarea, email, website or phone field (a select copies its option label, a multi-select its labels joined with a comma); otherwise number to number, date to date, checkbox or boolean to checkbox or boolean, select to select and multi-select to multi-select. optionMappings: description: >- For a select to select or multi-select to multi-select copy: which deal option each lead option becomes. Options are never matched by label; a lead option with no pair copies nothing (for a multi-select it is left out). maxItems: 500 type: array items: type: object properties: sourceOptionId: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Option id of the lead field. targetOptionId: type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: Option id of the deal field. required: - sourceOptionId - targetOptionId additionalProperties: false required: - targetCustomFieldUuid - source additionalProperties: false skipIfLeadHasDeal: description: >- When true (the default), the step does nothing if the lead already has a deal. type: boolean additionalProperties: false required: - label - actionType - config additionalProperties: false - type: object properties: label: type: string actionType: type: string enum: - request_signature config: type: object properties: templateUuid: anyOf: - type: string enum: - '' - type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ name: type: string maxLength: 500 signers: maxItems: 25 type: array items: type: object properties: roleName: type: string minLength: 1 maxLength: 64 routingOrder: default: 1 type: integer minimum: 1 maximum: 32767 userUuid: type: string format: uuid pattern: >- ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ email: type: string maxLength: 320 name: type: string maxLength: 255 required: - roleName - routingOrder additionalProperties: false required: - templateUuid - name - signers additionalProperties: false required: - label - actionType - config additionalProperties: false required: - id - type - position - data additionalProperties: false edges: type: array items: type: object properties: id: type: string source: type: string target: type: string sourceHandle: type: string targetHandle: type: string required: - id - source - target additionalProperties: false required: - nodes - edges additionalProperties: false required: - uuid - label - description - active - trigger_type - trigger_entity - trigger_event - partner_type_referral - partner_type_reseller - partner_type_distributor - created_at - updated_at - trigger_fields - trigger_config - schedule - workflow_definition additionalProperties: false components: schemas: ConditionTree: anyOf: - type: object properties: type: type: string const: group operator: type: string enum: - and - or children: type: array items: $ref: '#/components/schemas/ConditionTree' required: - type - operator - children additionalProperties: false - oneOf: - type: object properties: type: type: string const: field field: type: string operator: type: string enum: - equals - not_equals - contains - not_contains - greater_than - less_than - is_empty - is_not_empty value: description: >- For field `tier_id`, `category_id` or `stage_id` (partnership/certification triggers) or `stage_id`/`currency_id` (deal triggers) this is the target resource's uuid (string), not its internal id — same semantics as field_update.fieldValue (see apiAutomationFieldUpdateActionConfigSchema); the stage table is the partnership pipeline or the deal pipeline depending on the automation's trigger_entity, and `currency_id` resolves against the global `currencies` table (no company scoping — currencies aren't company-owned). `null` clears the condition value. Any other field name (status, direction, `custom_field_`, …) is a plain scalar, never id-bearing. anyOf: - type: string - type: number - type: boolean - type: 'null' required: - type - field - operator - value additionalProperties: false - type: object properties: type: type: string const: tag tagOperator: type: string enum: - has_tag - has_any_tag - has_all_tags - has_no_tags tagUuids: type: array items: type: string required: - type - tagOperator - tagUuids additionalProperties: false - type: object properties: type: type: string const: metric metric: type: string enum: - won_revenue - open_pipeline - new_pipeline - cert_completions - cert_started - lead_count - deal_count operator: type: string enum: - gte - gt - lte - lt - eq value: type: number window: oneOf: - type: object properties: type: type: string const: all_time required: - type additionalProperties: false - type: object properties: type: type: string const: rolling unit: type: string enum: - day - week - month - quarter - year count: type: integer exclusiveMinimum: 0 maximum: 9007199254740991 required: - type - unit - count additionalProperties: false - type: object properties: type: type: string const: named period: type: string enum: - this_month - last_month - this_quarter - last_quarter - this_year - ytd required: - type - period additionalProperties: false certificationUuids: type: array items: type: string required: - type - metric - operator - value - window additionalProperties: false - type: object properties: type: type: string const: contact_field field: type: string operator: type: string enum: - equals - not_equals - contains - not_contains - greater_than - less_than - is_empty - is_not_empty value: description: >- For field `tier_id`, `category_id` or `stage_id` (partnership/certification triggers) or `stage_id`/`currency_id` (deal triggers) this is the target resource's uuid (string), not its internal id — same semantics as field_update.fieldValue (see apiAutomationFieldUpdateActionConfigSchema); the stage table is the partnership pipeline or the deal pipeline depending on the automation's trigger_entity, and `currency_id` resolves against the global `currencies` table (no company scoping — currencies aren't company-owned). `null` clears the condition value. Any other field name (status, direction, `custom_field_`, …) is a plain scalar, never id-bearing. anyOf: - type: string - type: number - type: boolean - type: 'null' required: - type - field - operator - value additionalProperties: false - type: object properties: type: type: string const: task_field field: type: string enum: - status - title - priority operator: type: string enum: - equals - not_equals - contains - not_contains - greater_than - less_than - is_empty - is_not_empty value: anyOf: - type: string - type: number - type: boolean - type: 'null' required: - type - field - operator - value additionalProperties: false - type: object properties: type: type: string const: task_lookup taskOperator: type: string enum: - has_task_with_status - has_no_task_with_status titleMatch: default: mode: any value: '' type: object properties: mode: default: any type: string enum: - any - equals - contains value: default: '' type: string maxLength: 200 required: - mode - value additionalProperties: false status: type: string enum: - to_do - in_progress - in_review - done required: - type - taskOperator - titleMatch - status additionalProperties: false - type: object properties: type: type: string const: contact_tag tagOperator: type: string enum: - has_tag - has_any_tag - has_all_tags - has_no_tags tagUuids: type: array items: type: string required: - type - tagOperator - tagUuids additionalProperties: false - type: object properties: type: type: string const: contact_exists tagUuids: maxItems: 100 type: array items: type: string description: >- Contact tag uuids; a matching contact must carry ANY of them. Empty means no tag requirement. A stored leaf whose tags have all since been deleted can never match, so responses return it as an empty `or` group (which never passes) rather than as an empty tag list. positionMatch: type: object properties: mode: type: string enum: - any - equals - contains value: type: string maxLength: 200 required: - mode - value additionalProperties: false required: - type - tagUuids - positionMatch additionalProperties: false - type: object properties: type: type: string const: room_goal roomBlockUuid: description: >- The goals block's uuid (a `goals` room block of this company). Null only on a half-built condition, which never passes. A stored condition whose block has since been deleted can never pass, so responses return it as an empty `or` group (which never passes) rather than as a null block. anyOf: - type: string - type: 'null' goalIds: maxItems: 50 type: array items: type: string maxLength: 100 description: >- Goal ids from the block's `content.goals[].id`. Empty means every goal in the block. Ids no longer in the block are ignored; when none of the listed goals remain the condition never passes. state: type: string enum: - complete - incomplete match: type: string enum: - all - any required: - type - roomBlockUuid - goalIds - state - match additionalProperties: false - type: object properties: type: type: string const: room_opened roomUuid: description: >- The room's uuid (a `custom` room of this company that partners can be shown, i.e. not `internal_only`; built-in rooms such as Leads or Deals don't record views). Null only on a half-built condition, which never passes. A stored condition whose room has since been deleted, archived or made internal-only can never pass, so responses return it as an empty `or` group (which never passes) rather than as a null room. anyOf: - type: string - type: 'null' state: type: string enum: - opened - not_opened description: >- `opened` passes when a contact of the run's partnership (archived contacts included) has viewed the room in the partner portal; views by the company's own users, such as a portal preview, never count. `not_opened` passes when there is no such view AND the partnership can currently see the room, so it never passes for a partner without access. withinDays: anyOf: - type: integer minimum: 1 maximum: 3650 - type: 'null' description: >- Only count views from the last this many days, counted back from when the condition is checked. Null counts a view at any time. required: - type - roomUuid - state - withinDays additionalProperties: false securitySchemes: apiKey: type: http scheme: bearer description: API key authentication. Use "Bearer " or "Api-Key ". ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.