> ## Documentation Index > Fetch the complete documentation index at: https://docs.reelevant.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a specific workflow version > Only `analyzeOverrides` can be updated for stats purposes ## OpenAPI ````yaml https://openapi.production.reelevant.io/v1/render/workflow-api post /workflows/{id}/versions/{versionId} openapi: 3.0.0 info: title: workflow-api version: 0.0.0 description: |- # Errors | Error code | Message | HTTP status code | Payload | | :--- | :--- | :--- | :--- | | number | string | 404 | | servers: - url: https://api.reelevant.com/v2/ description: production security: [] paths: /workflows/{id}/versions/{versionId}: post: tags: - Workflow summary: Update a specific workflow version description: Only `analyzeOverrides` can be updated for stats purposes operationId: update-version-workflow parameters: - name: id in: path schema: type: string pattern: ^[0-9a-fA-F]{24}$ required: true - name: versionId in: path schema: type: string pattern: ^[0-9a-fA-F]{24}$ required: true requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WorkflowVersion_With_AnalyzeOverrides' responses: '200': description: Ok content: application/json: schema: allOf: - type: object properties: status: type: string enum: - success required: - status additionalProperties: false - $ref: '#/components/schemas/InternalResponse_SerializedWorkflow' '400': description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/InternalResponse_' - type: object properties: status: type: string enum: - fail error_code: type: number code: type: number message: type: string data: oneOf: - type: object properties: id: type: string required: - id additionalProperties: false - type: object properties: errors: type: array items: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/Error' required: - errors additionalProperties: false - $ref: >- #/components/schemas/MissingContentDependencyErrorPayload - type: object properties: alias: type: string required: - alias additionalProperties: false - type: object properties: id: type: string required: - id additionalProperties: false - type: object properties: id: type: string index: type: number required: - id - index additionalProperties: false - type: object properties: id: type: string entrypointId: type: string required: - id - entrypointId additionalProperties: false - type: object properties: id: type: string required: - id additionalProperties: false - type: object properties: companyId: type: string required: - companyId additionalProperties: false - type: object properties: maxDepth: type: number actualDepth: type: number required: - maxDepth - actualDepth additionalProperties: false - type: object properties: reason: type: string required: - reason additionalProperties: false - type: object properties: companyId: type: string required: - companyId additionalProperties: false - type: object properties: templateIds: type: array items: type: string required: - templateIds additionalProperties: false - type: object properties: templateId: type: string required: - templateId additionalProperties: false - type: object properties: tagKeyId: type: string required: - tagKeyId additionalProperties: false - type: object properties: tagKeyId: type: string tagValueId: type: string required: - tagKeyId - tagValueId additionalProperties: false - type: object properties: branchId: type: string tagKeyId: type: string required: - branchId - tagKeyId additionalProperties: false - type: object properties: tagKeyId: type: string required: - tagKeyId additionalProperties: false required: - status - error_code - code - message additionalProperties: false '404': description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/InternalResponse_' - type: object properties: status: type: string enum: - fail error_code: type: number code: type: number message: type: string data: oneOf: - type: object properties: id: type: string required: - id additionalProperties: false - type: object properties: errors: type: array items: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/Error' required: - errors additionalProperties: false - $ref: >- #/components/schemas/MissingContentDependencyErrorPayload - type: object properties: alias: type: string required: - alias additionalProperties: false - type: object properties: id: type: string required: - id additionalProperties: false - type: object properties: id: type: string index: type: number required: - id - index additionalProperties: false - type: object properties: id: type: string entrypointId: type: string required: - id - entrypointId additionalProperties: false - type: object properties: id: type: string required: - id additionalProperties: false - type: object properties: companyId: type: string required: - companyId additionalProperties: false - type: object properties: maxDepth: type: number actualDepth: type: number required: - maxDepth - actualDepth additionalProperties: false - type: object properties: reason: type: string required: - reason additionalProperties: false - type: object properties: companyId: type: string required: - companyId additionalProperties: false - type: object properties: templateIds: type: array items: type: string required: - templateIds additionalProperties: false - type: object properties: templateId: type: string required: - templateId additionalProperties: false - type: object properties: tagKeyId: type: string required: - tagKeyId additionalProperties: false - type: object properties: tagKeyId: type: string tagValueId: type: string required: - tagKeyId - tagValueId additionalProperties: false - type: object properties: branchId: type: string tagKeyId: type: string required: - branchId - tagKeyId additionalProperties: false - type: object properties: tagKeyId: type: string required: - tagKeyId additionalProperties: false required: - status - error_code - code - message additionalProperties: false security: - password_auth: [] components: schemas: WorkflowVersion_With_AnalyzeOverrides: type: object properties: analyzeOverrides: allOf: - $ref: '#/components/schemas/AnalyzerOverrides' description: Overrides configuration for the analyze additionalProperties: false InternalResponse_SerializedWorkflow: type: object properties: program: type: string version: type: string datetime: type: string status: type: string code: type: number message: type: string data: $ref: '#/components/schemas/SerializedWorkflow' required: - program - version - datetime - status - message - data additionalProperties: false InternalResponse_: type: object properties: program: type: string version: type: string datetime: type: string status: type: string code: type: number message: type: string data: type: object properties: {} additionalProperties: false required: - program - version - datetime - status - message - data additionalProperties: false Error: type: object properties: path: type: string message: type: string payload: type: object properties: {} additionalProperties: $ref: '#/components/schemas/AnyValue' required: - path - message additionalProperties: false MissingContentDependencyErrorPayload: type: object properties: workflows: type: array items: type: object properties: errors: type: array items: type: object properties: errors: type: array items: oneOf: - allOf: - type: object properties: dependencyId: type: string required: - dependencyId additionalProperties: false - type: object properties: type: type: string enum: - datasource id: type: string group: type: object properties: by: type: string mode: oneOf: - type: string enum: - aggregated - type: string enum: - onePerValue - type: string enum: - topValueOnly - type: string enum: - oneValueOnly required: - by - mode additionalProperties: false required: - type - id additionalProperties: false - allOf: - type: object properties: dependencyId: type: string required: - dependencyId additionalProperties: false - type: object properties: type: type: string enum: - url-parameter name: type: string subtype: type: string required: - type - name - subtype additionalProperties: false - allOf: - type: object properties: dependencyId: type: string required: - dependencyId additionalProperties: false - type: object properties: type: oneOf: - type: string enum: - weather - type: string enum: - context - type: string enum: - geolocation - type: string enum: - live-polling required: - type additionalProperties: false contentId: type: string contentIndex: type: number required: - errors - contentId - contentIndex additionalProperties: false id: type: string nodeId: type: string required: - errors - id - nodeId additionalProperties: false required: - workflows additionalProperties: false AnalyzerOverrides: type: object properties: vertexIndividualizedScore: type: object properties: {} additionalProperties: type: number customVertexNames: type: array items: type: object properties: vertexId: type: string name: type: string required: - vertexId - name additionalProperties: false branchCategoryIds: type: object properties: {} additionalProperties: type: string branchTags: type: array items: allOf: - $ref: '#/components/schemas/BranchTag' - type: object properties: branchId: type: string required: - branchId additionalProperties: false additionalProperties: false SerializedWorkflow: allOf: - $ref: >- #/components/schemas/WorkflowDocument_Without_ToJSON_CompanyId_ResourceGroupIds_IntegrationOptions_Versions - type: object properties: integrations: type: array items: oneOf: - type: object properties: type: type: string enum: - web id: type: string workflowId: type: string shortId: type: string includeContext: type: boolean includeDatalayerPath: type: array items: type: string waitForEvents: type: array items: type: string domain: type: string filters: type: object properties: type: oneOf: - type: string enum: - and - type: string enum: - or conditions: type: array items: type: object properties: operator: oneOf: - type: string enum: - empty - type: string enum: - nempty - type: string enum: - eq - type: string enum: - ne - type: string enum: - contains - type: string enum: - notcontains field: type: string values: type: array items: type: string required: - operator - field - values additionalProperties: false required: - type - conditions additionalProperties: false enabled: type: boolean code: type: string selector: type: string emplacement: oneOf: - type: string enum: - replace - type: string enum: - before - type: string enum: - after required: - type - id - workflowId - shortId - domain - enabled additionalProperties: false - type: object properties: type: type: string enum: - landing parameters: type: object properties: {} additionalProperties: type: string id: type: string url: type: string required: - type - parameters - id - url additionalProperties: false - type: object properties: type: oneOf: - type: string enum: - email - type: string enum: - mobile - type: string enum: - landing - type: string enum: - rcs - type: string enum: - whatsapp - type: string enum: - raw parameters: type: object properties: {} additionalProperties: type: string id: type: string display: type: string click: type: string required: - type - parameters - id - display - click additionalProperties: false id: type: string companyId: type: string resourceGroupIds: type: array items: type: string versions: type: array items: $ref: '#/components/schemas/WorkflowVersion' createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - integrations - id - companyId - resourceGroupIds - versions - createdAt - updatedAt AnyValue: description: Can be any value nullable: true BranchTag: type: object properties: tagKeyId: type: string tagValueId: type: string required: - tagKeyId - tagValueId additionalProperties: false WorkflowDocument_Without_ToJSON_CompanyId_ResourceGroupIds_IntegrationOptions_Versions: type: object properties: _id: $ref: '#/components/schemas/ObjectId' name: type: string description: type: string id: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time variableProfileId: type: string description: Variable profile id let frontend pre-select profile hierarchy: type: array items: type: string status: allOf: - $ref: '#/components/schemas/WorkflowStatus' readOnly: true description: This status is used to know if a workflow can be runned or not archivedAt: type: string format: date-time nullable: true readOnly: true hidden: type: boolean required: - _id - name - id - hierarchy - status - archivedAt - hidden additionalProperties: false WorkflowVersion: $ref: '#/components/schemas/SerializedWorkflowVersion' ObjectId: type: string WorkflowStatus: type: string enum: - draft - publishing - published - error - inactive SerializedWorkflowVersion: allOf: - $ref: '#/components/schemas/WorkflowVersion_Without_ToJSON__id' - type: object properties: createdAt: type: string format: date-time updatedAt: type: string format: date-time required: - createdAt - updatedAt WorkflowVersion_Without_ToJSON__id: type: object properties: metadata: type: object properties: {} additionalProperties: $ref: '#/components/schemas/AnyValue' description: >- This is used by the frontend to store their metadata (node positions...) like: { : { position: { x: ..., y: ... } } } id: type: string createdAt: type: string format: date-time updatedAt: type: string format: date-time state: allOf: - $ref: '#/components/schemas/WorkflowVersionState' readOnly: true description: |- The state of the version. If state=draft, it means this is the draft version, where updates occurs. If state=live, it means this is the live version used to run the workflow, it won't be updated again definition: allOf: - $ref: '#/components/schemas/Workflow' description: Workflow definition analyzeOverrides: allOf: - $ref: '#/components/schemas/AnalyzerOverrides' description: Overrides configuration for the analyze analyze: allOf: - $ref: >- #/components/schemas/WorkflowAnalyze_Without_OutputsForEntrypoint_DatasForEntrypoint - type: object properties: outputsForEntrypoint: type: object properties: {} additionalProperties: type: array items: type: string datasForEntrypoint: type: object properties: {} additionalProperties: type: array items: type: string required: - outputsForEntrypoint - datasForEntrypoint additionalProperties: false readOnly: true description: |- Workflow analyze, this field is auto fill at each publish and used by the engine lastSavedBy: allOf: - $ref: '#/components/schemas/ObjectId' readOnly: true description: Last user id that last saved the version changeDescription: type: string description: Description of whats have been changed by this version complexityScore: type: number readOnly: true description: >- Pre-computed structural complexity score of the workflow. Computed at version save time from data node metadata (limit, select, filters, groupBy) and content node dependency counts. See docs/complexity-score.md. required: - id - state - definition - analyze additionalProperties: false WorkflowVersionState: type: string enum: - draft - live - inactive Workflow: type: object properties: nodes: type: object properties: {} additionalProperties: oneOf: - type: object properties: type: type: string metadata: type: object properties: {} additionalProperties: $ref: '#/components/schemas/AnyValue' paths: type: array items: type: object properties: id: type: string options: type: object properties: {} additionalProperties: $ref: '#/components/schemas/AnyValue' required: - id - options additionalProperties: false required: - type - metadata - paths additionalProperties: false - type: object properties: type: type: string options: type: object properties: {} additionalProperties: $ref: '#/components/schemas/AnyValue' metadata: type: object properties: {} additionalProperties: $ref: '#/components/schemas/AnyValue' required: - type - options - metadata additionalProperties: false entrypoints: type: object properties: {} additionalProperties: oneOf: - type: object properties: type: type: string enum: - email format: oneOf: - type: string enum: - header-image - type: string enum: - banner-top-image - type: string enum: - banner-bottom-image - type: string enum: - hero-image - type: string enum: - content-image - type: string enum: - terms-image - type: string enum: - email-content required: - type - format additionalProperties: false - type: object properties: type: type: string enum: - mobile format: oneOf: - type: string enum: - push-image - type: string enum: - in-app-image - type: string enum: - inbox-image required: - type - format additionalProperties: false - type: object properties: type: type: string enum: - web format: oneOf: - type: string enum: - embed-image - type: string enum: - embed-html - type: string enum: - page-html required: - type - format additionalProperties: false - type: object properties: type: type: string enum: - landing format: oneOf: - type: string enum: - embed-image - type: string enum: - embed-html - type: string enum: - page-html required: - type - format additionalProperties: false - type: object properties: type: type: string enum: - rcs format: oneOf: - type: string enum: - card-image - type: string enum: - carousel-image required: - type - format additionalProperties: false - type: object properties: type: type: string enum: - whatsapp format: type: string enum: - header-image required: - type - format additionalProperties: false - type: object properties: type: type: string enum: - raw format: type: string enum: - json required: - type - format additionalProperties: false edges: type: object properties: {} additionalProperties: type: object properties: to: type: string required: - to additionalProperties: false required: - nodes - entrypoints - edges additionalProperties: false WorkflowAnalyze_Without_OutputsForEntrypoint_DatasForEntrypoint: type: object properties: entrypointsByBranches: type: array items: type: object properties: branch: type: string entrypointIds: type: array items: type: string required: - branch - entrypointIds additionalProperties: false description: >- Key is node id In value we have branches that use this data node and entrypoints using those branches branches: type: array items: type: string individualizedBranches: type: array items: type: string branchesScore: type: object properties: {} additionalProperties: type: number defaultBranches: type: array items: type: string usedDatasourceFields: type: object properties: {} additionalProperties: type: array items: type: string branchesInfos: type: object properties: {} additionalProperties: type: array items: type: array items: oneOf: - $ref: '#/components/schemas/BranchInfosElementType' - type: string description: Branch config per branch id entrypointsPerDataNodeId: type: object properties: {} additionalProperties: type: array items: type: string entrypointsPerPathId: type: object properties: {} additionalProperties: type: array items: type: string entrypointTypes: type: array items: type: string entrypointFormats: type: array items: type: string description: >- Entrypoint formats in the same order as `entrypointTypes`, so statistics can split channels that share a type (e.g. rcs cards vs carousels). categoryIdByBranch: type: object properties: {} additionalProperties: type: string branchTags: type: array items: allOf: - $ref: '#/components/schemas/BranchTag' - type: object properties: branchId: type: string required: - branchId additionalProperties: false description: >- Flat list of branch tag associations where `branchId` is the resolved branch id (path/node ids joined with `BRANCH_DELIMITER`). This is the shape exported to the datawarehouse and consumed by statistics. required: - entrypointsByBranches - branches - individualizedBranches - branchesScore - defaultBranches - usedDatasourceFields - branchesInfos - entrypointsPerDataNodeId - entrypointsPerPathId - entrypointTypes - entrypointFormats - categoryIdByBranch - branchTags additionalProperties: false BranchInfosElementType: type: number enum: - 0 - 1 - 2 - 3 securitySchemes: password_auth: type: oauth2 flows: password: tokenUrl: https://api.reelevant.com/v1/auth/token refreshUrl: https://api.reelevant.com/v1/auth/token scopes: {} ````