{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"CFM Workflow API V3 — Developer Guide","description":"Sprinklr offers robust, convenient, and simple RESTful Web service APIs to integrate data from Sprinklr to any external system.","keywords":["Sprinklr API","Sprinklr Developer Portal","OAuth 2.0","RESTful API","Social Media API","Customer Experience API","Unified-CXM","Social Listening API"]},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"cfm-workflow-api-v3--developer-guide","__idx":0},"children":["CFM Workflow API V3 — Developer Guide"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Applies to:"]}," Sprinklr Customer Feedback Management (CFM) Workflow API V3 (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/cfmWorkflow"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/cfm-workflow-api"},"children":["CFM Workflow API | Sprinklr Developer Portal"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CFM module overview:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/customer-feedback-management"},"children":["Customer Feedback Management | Sprinklr Developer Portal"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-overview","__idx":1},"children":["1. Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CFM Workflow API"]}," starts a Customer Feedback Management workflow from an external system event. You supply a workflow identifier and a set of context parameters; Sprinklr runs the configured workflow, which can create or update a customer profile and trigger a personalized survey distribution over ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Email, SMS, or WhatsApp"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This turns real customer-journey moments — an online purchase, a form submission, an abandoned cart, a support-case closure — into a targeted, automated feedback request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["V3 exposes ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["two POST operations"]}," under a single resource prefix:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"operationId"},"children":["operationId"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run workflow via event"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/cfmWorkflow/trigger"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CfmWorkflowApiV3_triggerWorkflow"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run workflow via event with profile details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/cfmWorkflow/triggerWithNewProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CfmWorkflowApiV3_triggerWorkflowWithProfile"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both are tagged ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CFM Workflow V3"]}," in the OpenAPI specification."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The central design change from V2: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 documented a single endpoint"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/cfm-workflow/triggerWithNewProfile"]}," — which always required a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}," object. V3 splits the capability in two, so a caller who only needs to fire an event against an already-known workflow context can use the lighter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/trigger"]}," operation and omit profile construction entirely."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Prerequisite."]}," CFM must be enabled in your environment before you can use these APIs. Contact your Success Manager."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"11-the-workflow-trigger-data-model","__idx":2},"children":["1.1 The workflow trigger data model"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A trigger request is composed of at most three parts:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Part"},"children":["Part"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What it does"},"children":["What it does"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Present on"},"children":["Present on"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Workflow selector"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifies the active CFM workflow to execute"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Both operations — ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Runtime context"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (map)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Free-form key/value pairs passed into the workflow, used by its conditions and actions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Both operations — optional"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Customer identity"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UnifiedProfile"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A new or upserted customer profile the workflow acts on and distributes the survey to"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["triggerWithNewProfile"]}," only"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The workflow itself — its conditions, its branching, and the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Trigger Survey Distribution"]}," action that actually sends the survey — is configured in the Sprinklr UI under ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sprinklr Insights → Customer Feedback Management → ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["survey"]}," → Automation"]},", using the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["CFM Workflow API"]}," event type. The API only starts it. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/articles/setting-workflow-trigger-events/setting-up-a-cfm-workflow-api-event-workflow/6807458589cac71a44d0022c"},"children":["Setting Up a CFM Workflow API Event Workflow"]}," for the configuration side."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"12-where-workflowid-comes-from","__idx":3},"children":["1.2 Where ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowId"]}," comes from"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowId"]}," is the identifier of a workflow you have already created and activated in the CFM Automation canvas. It is a UUID-shaped string, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["595b4041-6eba-400f-aff0-797f1029c6f2"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can obtain a ready-made request — with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowId"]}," pre-filled from the current workflow — by opening the workflow record and choosing ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Test API Connection"]},". That screen also lets you pick a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Channel Type"]}," (Email, WhatsApp Business, SMS), supply a first name, full name, and social network user ID, and add extra ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]},", then click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get API Request"]},". Copy the generated request, add your authentication headers, and run it. (Source: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/articles/setting-workflow-trigger-events/setting-up-a-cfm-workflow-api-event-workflow/6807458589cac71a44d0022c"},"children":["Setting Up a CFM Workflow API Event Workflow"]},")"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-base-urls-and-environments","__idx":4},"children":["2. Base URLs and environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["All production API calls are sent to:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["So the workflow resources in production are:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/cfmWorkflow/trigger\nhttps://api3.sprinklr.com/{env}/api/v3/cfmWorkflow/triggerWithNewProfile\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]}," with your assigned environment identifier (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod0"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod2"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod3"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod4"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod5"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod6"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod8"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod11"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod12"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod15"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod16"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod17"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod18"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod19"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod21"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod24"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["production"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spr-uat"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["azrqa"]}," — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/apis"},"children":["APIs | Sprinklr Developer Portal"]}," for the full environment list)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["QA and pre-production environments use a different host shape, in which the environment is a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["hostname prefix"]}," rather than a path segment:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Base URL"},"children":["Base URL"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Trigger resource"},"children":["Trigger resource"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Production"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api3.sprinklr.com/{env}/api/v3"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api3.sprinklr.com/{env}/api/v3/cfmWorkflow/trigger"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-authentication-and-common-headers","__idx":5},"children":["3. Authentication and common headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All CFM Workflow API calls are authenticated with OAuth 2.0. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/api-overview"},"children":["API Overview"]}," for portal registration, API key and secret generation, and the Authorize flow."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required on"},"children":["Required on"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{accessToken}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credential used by the API to authenticate a user with the server. For generating the authorization token, refer to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authorize"]}," section on the developer portal."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{apiKey}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["API key that authenticates the application with the server. For generating an API key, refer to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Getting Started"]}," guide."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines the type of data (media/resource) present in the request body"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," operations"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines the acceptable response type from the server"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Permissions:"]}," the CFM Workflow API event does not require any special permission within the Sprinklr Audience Profile Event module. However, you must configure the CFM Workflow API within your own systems and hold valid Sprinklr API authentication. (Source: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/articles/setting-workflow-trigger-events/setting-up-a-cfm-workflow-api-event-workflow/6807458589cac71a44d0022c"},"children":["Setting Up a CFM Workflow API Event Workflow"]},")"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-run-workflow-via-event","__idx":6},"children":["4. Run workflow via event"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Triggers an active CFM workflow using only a workflow identifier and runtime context. Use this when the customer profile the workflow acts on is already resolvable from the workflow's own configuration or from the supplied context, and you do not need to create or update a profile in the same call."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /api/v3/cfmWorkflow/trigger\n"},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["operationId:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CfmWorkflowApiV3_triggerWorkflow"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Summary (OpenAPI):"]}," Run workflow via event"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request schema:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CfmWorkflowTriggerV3Request"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body:"]}," required"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response schema:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"41-request-body","__idx":7},"children":["4.1 Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Schema ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CfmWorkflowTriggerV3Request"]}," — ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Request body for triggering a CFM workflow via API v3."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the active workflow to be executed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains contextual parameters passed to the workflow at runtime. Declared in OpenAPI as an object with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additionalProperties: {type: string}"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IGNORE_DEDUP"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines whether duplicate detection is ignored during workflow execution."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lang"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Language code used to localize workflow behavior or content."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["country"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Country name used as contextual input for the workflow."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Two-letter country code associated with the specified country."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyFilled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether the survey has been completed."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowId"]}," is the only field in the OpenAPI ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required"]}," array."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IGNORE_DEDUP"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lang"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["country"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyFilled"]}," are the keys shown in every supplied example. They are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["conventional keys, not a closed enum"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}," is an open map, so you can pass any key your workflow's conditions reference."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"42-example-request","__idx":8},"children":["4.2 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --request POST \\\n  --url 'https://api3.sprinklr.com/{env}/api/v3/cfmWorkflow/trigger' \\\n  --header 'Authorization: {{accessToken}}' \\\n  --header 'Key: {{apiKey}}' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data '{\n    \"workflowId\": \"595b4041-6eba-400f-aff0-797f1029c6f2\",\n    \"contextParams\": {\n      \"IGNORE_DEDUP\": true,\n      \"lang\": \"ar\",\n      \"country\": \"Jordan\",\n      \"countryCode\": \"SA\",\n      \"surveyFilled\": \"true\"\n    }\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"43-example-response","__idx":9},"children":["4.3 Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": \"Success\",\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Dev note:"]}," a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Success\""]}," value in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," indicates that the API endpoint successfully triggered the CFM workflow for the profile. It does ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," confirm that the survey was delivered — delivery happens asynchronously inside the workflow. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#10-caveats-and-best-practices"},"children":["§10"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"44-response-parameters","__idx":10},"children":["4.4 Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates the outcome of the API request. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Success\""]}," when the workflow was triggered."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Error"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains any errors encountered during the request. Empty when no errors occurred."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ResponseMetadata"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response metadata. Declared on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}," envelope but ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["absent from every supplied example"]}," for this endpoint."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-run-workflow-via-event-with-profile-details","__idx":11},"children":["5. Run workflow via event with profile details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Triggers an active CFM workflow and supplies a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["new unified customer profile"]}," in the same request. Sprinklr creates or updates the profile from the payload and then runs the workflow against it — which is what lets the workflow's ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Trigger Survey Distribution"]}," action reach a customer the platform has never seen before."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /api/v3/cfmWorkflow/triggerWithNewProfile\n"},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["operationId:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CfmWorkflowApiV3_triggerWorkflowWithProfile"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Summary (OpenAPI):"]}," Run workflow via event with profile details"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request schema:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CfmWorkflowTriggerProfileV3Request"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body:"]}," required"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response schema:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the direct V3 successor to the single V2 endpoint ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/cfm-workflow/triggerWithNewProfile"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"51-request-body","__idx":12},"children":["5.1 Request body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Schema ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CfmWorkflowTriggerProfileV3Request"]}," — ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Request body for triggering a CFM workflow with a new profile via API v3."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the active workflow to be executed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contextual parameters passed to the workflow at runtime. Same semantics and same caveat as ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#41-request-body"},"children":["§4.1"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UnifiedProfile"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unified profile of the new user."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowId"]}," is the only field in the OpenAPI ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required"]}," array."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"52-the-unifiedprofile-object","__idx":13},"children":["5.2 The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}," object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}," is the platform-wide ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UnifiedProfile"]}]}," schema — ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["\"Unified view of a profile in sprinklr.\""]}," It is the same object the Profile V3 API returns, and it is large. Only a small subset is relevant to a workflow trigger."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fields used in practice"]}," (per every supplied example):"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the unified profile. Omit when creating a new profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contact"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ContactInfo"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact information of the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.contact"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["firstName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First name of the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.contact"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last name of the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.contact"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["maidenName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maiden name of the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.contact"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fullName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Full name of the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.contact"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email ID of the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.contact"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Username of the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.contact"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phoneNo"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Phone number of the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.contact"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["address"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Address"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Address of the profile. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#53-address-object"},"children":["§5.3"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.contact"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["website"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of websites for the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.contact"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phoneDetails"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PhoneDetail"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Phone details for the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.contact"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["emailDetails"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EmailDetail"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email details for the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profiles"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Profile"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of social identities linked to the profile. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["This is the array that determines which channels the survey can be distributed over."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Yes"]},"¹"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the person."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Yes"]},"¹"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Channel type of the profile — for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMAIL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WHATSAPP_BUSINESS"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Yes"]},"¹"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the customer on that channel. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["If the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelId"]}," is unique, a new profile is created and a journey is associated with it; otherwise the journey is associated with the existing profile."]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permalink"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Yes"]},"¹"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Link of the profile on the social channel."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["avatarUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Profile image link."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileImageUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Profile image link."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bio"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Detailed description about the user."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["followers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (int32)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Followers count of the user."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["following"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (int32)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Count of users/pages followed by this user."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["username"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the user."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["verified"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," if the user is verified by the channel. Default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unSubscribed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," if the user is subscribed for email and other activities. Default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," if the profile is deleted natively. Default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["snCreatedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (int64)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Social channel created time (epoch milliseconds)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["snModifiedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (int64)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Social channel modified time (epoch milliseconds)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["statusCount"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (int32)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Status count for the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountSpecificInfos"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AccountSpecificInfo"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account-specific information. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#54-accountspecificinfo-object"},"children":["§5.4"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["demographics"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Demographics"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Demographic details of the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileWorkflow"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ProfileWorkflow"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partner-level workflow container. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#55-profileworkflow-and-profilespaceworkflow"},"children":["§5.5"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (int64)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Created time of the profile in Sprinklr (epoch milliseconds)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (int64)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last modified time of the profile in Sprinklr (epoch milliseconds)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customPropertiesMetadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CustomPropertyWithMetadata"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom property details."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["restricted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Profile masked flag."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["¹ ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelId"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permalink"]}," are listed in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required"]}," array of the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Profile"]}," schema. Note that ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["no supplied example sends ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permalink"]}]}," — including the V2 portal page, which marks it Optional, and the Help Center in-product sample. Treat the OpenAPI ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["required"]}," list on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Profile"]}," as unverified for this use case."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UnifiedProfile"]}," additionally carries ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["works"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["organizations"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["certificates"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recommendations"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["educations"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["languages"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["skills"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["courses"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["honors"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["patents"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["projects"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["publications"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["testScores"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["voluntaryExp"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["operatingHours"]},". None of these are referenced by any supplied CFM example; they are inherited from the shared profile model and are not documented further here. See the Profile API V3 guide for their semantics."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"53-address-object","__idx":14},"children":["5.3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Address"]}," object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.contact.address"]},", schema ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Address"]}," — ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Describes the schema for Address."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["street1"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["First line of the user's address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["street2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Second line of the user's address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["city"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The city of the user's address, to help identify the location."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["state"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The state of the user's address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["country"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The country of the user's address."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["postalCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ZIP code of the address."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"54-accountspecificinfo-object","__idx":15},"children":["5.4 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AccountSpecificInfo"]}," object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profiles[].accountSpecificInfos[]"]},", schema ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AccountSpecificInfo"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (int64)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account ID of the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["External ID of the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastBrandEngagedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (int64)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last brand engagement time (epoch milliseconds)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastFanEngagedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (int64)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last fan engagement time (epoch milliseconds)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["optIn"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," if opted in. Default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fanSubscriptionState"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Subscription state of the fan."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["activeUser"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," if the user is active. Default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["invited"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," if invited. Default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"55-profileworkflow-and-profilespaceworkflow","__idx":16},"children":["5.5 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ProfileWorkflow"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ProfileSpaceWorkflow"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profileWorkflow"]},", schema ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ProfileWorkflow"]}," — ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Describes the schema of partner-level workflow in profile."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileLists"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Integer (int64)]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partner profile lists on the profile, if any."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (map of String → Array[String])"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partner custom properties on the profile, if any. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Profile-level custom fields are not currently supported"]}," (per V2 documentation)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileSpaceWorkflows"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ProfileSpaceWorkflow"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of client-level workflows on the profile, if any."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.profileWorkflow.profileSpaceWorkflows[]"]},", schema ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ProfileSpaceWorkflow"]},":"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spaceId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client ID. The only required field on this schema."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (int64)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Last modified time of the space workflow (epoch milliseconds)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (map of String → Array[String])"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client custom properties on the asset, if any."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["queues"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Queue"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client queue details of the message, if any."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileLists"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Integer (int64)]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client profile lists on the profile, if any."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client tags on the profile, if any."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"56-example-request","__idx":17},"children":["5.6 Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --request POST \\\n  --url 'https://api3.sprinklr.com/{env}/api/v3/cfmWorkflow/triggerWithNewProfile' \\\n  --header 'Authorization: {{accessToken}}' \\\n  --header 'Key: {{apiKey}}' \\\n  --header 'Content-Type: application/json' \\\n  --header 'Accept: application/json' \\\n  --data-raw '{\n    \"workflowId\": \"595b4041-6eba-400f-aff0-797f1029c6f2\",\n    \"contextParams\": {\n      \"IGNORE_DEDUP\": true,\n      \"lang\": \"ar\",\n      \"country\": \"Jordan\",\n      \"countryCode\": \"SA\",\n      \"surveyFilled\": \"true\"\n    },\n    \"unifiedProfile\": {\n      \"contact\": {\n        \"firstName\": \"Alex\",\n        \"lastName\": \"Doe\",\n        \"email\": \"alex.doe@example.com\",\n        \"phoneNo\": \"9876543210\"\n      },\n      \"profiles\": [\n        {\n          \"name\": \"Alex Doe\",\n          \"channelType\": \"EMAIL\",\n          \"channelId\": \"alex.doe@example.com\"\n        }\n      ]\n    }\n  }'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Multi-channel variant"]}," — attach several channel identities so the workflow can select a distribution channel:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"workflowId\": \"{{workflowId}}\",\n  \"contextParams\": {\n    \"IGNORE_DEDUP\": true,\n    \"lang\": \"en\",\n    \"country\": \"India\",\n    \"countryCode\": \"IN\",\n    \"surveyFilled\": \"false\"\n  },\n  \"unifiedProfile\": {\n    \"contact\": {\n      \"firstName\": \"Alex\"\n    },\n    \"profiles\": [\n      { \"channelType\": \"WHATSAPP_BUSINESS\", \"channelId\": \"918012345678\", \"name\": \"Alex Doe\" },\n      { \"channelType\": \"SMS\",               \"channelId\": \"918012345678\", \"name\": \"Alex Doe\" },\n      { \"channelType\": \"EMAIL\",             \"channelId\": \"alex.doe@example.com\", \"name\": \"Alex Doe\" }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"57-example-response","__idx":18},"children":["5.7 Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": \"Success\",\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"58-response-parameters","__idx":19},"children":["5.8 Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates the outcome of the API request. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Success\""]}," when the workflow was triggered for the profile."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Error"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contains any errors encountered during the request. Empty when no errors occurred."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ResponseMetadata"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response metadata. Declared on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}," envelope; absent from every supplied example."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-response-format-and-status-codes","__idx":20},"children":["6. Response format and status codes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"61-the-v3-envelope","__idx":21},"children":["6.1 The V3 envelope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both operations declare the shared ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}]}," schema:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {},\n  \"errors\": [],\n  \"metadata\": {}\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operation result. For both CFM Workflow operations this is the string ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Success\""]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Error"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of error objects. Empty when no errors occurred."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ResponseMetadata"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response metadata."]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Specification gap."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse.data"]}," is declared as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: object"]},", but both CFM Workflow operations return a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["JSON string"]},". The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ResponseMetadata"]}," schema is declared with an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["empty ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties"]}," map"]},", so no metadata fields can be documented from the specification, and no supplied example returns a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}," key at all for these endpoints. Parse defensively: treat ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}," as possibly absent."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"62-response-codes","__idx":22},"children":["6.2 Response codes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Declared in the OpenAPI specification for ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["both"]}," operations:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP code"},"children":["HTTP code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scenario"},"children":["Scenario"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The CFM workflow was triggered successfully."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid parameters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowId"]},", malformed JSON, or an invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile"]}," payload."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid or missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," token."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Insufficient permissions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The caller lacks the permission required to trigger the workflow."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No matching workflow for the supplied ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowId"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the full status-code catalogue see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/"},"children":["REST API Error and Status Codes"]}," on the developer portal."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"8-reference-values","__idx":23},"children":["8. Reference values"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"81-channeltype-values-used-in-cfm-distribution","__idx":24},"children":["8.1 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelType"]}," values used in CFM distribution"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Channel"},"children":["Channel"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Typical channelId"},"children":["Typical ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelId"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMAIL"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email survey distribution"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email address, e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["alex.doe@example.com"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMS survey distribution"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Phone number in international format, e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["918012345678"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WHATSAPP_BUSINESS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["WhatsApp Business survey distribution"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Phone number in international format, e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["918012345678"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These three are the channels named in the CFM Workflow API description and used in the V2 and Help Center samples. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelType"]}," on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Profile"]}," schema is declared as an open ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type: string"]},", not a closed enum, so the platform-wide channel list also applies. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Values are uppercase and case-sensitive."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"82-conventional-contextparams-keys","__idx":25},"children":["8.2 Conventional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}," keys"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Key"},"children":["Key"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type in examples"},"children":["Type in examples"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IGNORE_DEDUP"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ignore duplicate detection during workflow execution."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lang"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Language code used to localize workflow behavior or content, e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ar"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["en"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["country"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Country name used as contextual input, e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Jordan"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Two-letter country code, e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SA"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IN"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["surveyFilled"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the survey has been completed, e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"true\""]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}," is an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["open map"]},". Any additional key you pass becomes available as a workflow variable to the workflow's conditions and actions. Add extra keys through ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Test API Connection"]}," in the workflow record to see them reflected in a generated request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"83-workflow-actions-and-conditions-reachable-from-a-trigger","__idx":26},"children":["8.3 Workflow actions and conditions reachable from a trigger"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once triggered, the workflow can run any of the elements supported by the CFM Workflow API (Audience Profile) event:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Bucket"},"children":["Bucket"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Element"},"children":["Element"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey Processes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Trigger Survey Distribution"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Selects an already-created trigger-based survey distribution on Email, SMS, or WhatsApp and fires it based on the workflow conditions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey Processes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom Field Actions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sets case or profile custom fields directly, or copies them from workflow variables."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey Processes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update Properties"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Updates supported custom properties, attributes, or metadata from workflow variables."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Journey Processes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Decision Box"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Adds a decision point to branch on specific conditions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Communication"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Send Resolved Message"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sends a follow-up email, SMS, or WhatsApp message, customizable with workflow variables."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Records"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get Records"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieves data from Sprinklr entity records for use in later actions or conditions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Utility"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Go to Node"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Directs flow to a specific node, allowing custom paths."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Utility"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add or remove from queues"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Adds or removes cases from queues based on workflow conditions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Actions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["End Event"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Marks the end of the workflow."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Actions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create Record"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Creates a new record from workflow information."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Actions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update Record"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Modifies an existing record based on triggers or conditions."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["(Source: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/articles/setting-workflow-trigger-events/setting-up-a-cfm-workflow-api-event-workflow/6807458589cac71a44d0022c"},"children":["Setting Up a CFM Workflow API Event Workflow"]},")"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"9-use-cases","__idx":27},"children":["9. Use cases"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"91-cart-abandonment-follow-up","__idx":28},"children":["9.1 Cart-abandonment follow-up"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A customer abandons a shopping cart. Your commerce platform calls ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /cfmWorkflow/triggerWithNewProfile"]}," with the shopper's contact details and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}," describing the cart. The workflow updates the profile and triggers a personalized survey or incentive over email or SMS to encourage the customer to complete the purchase. If the customer responds, the team follows up with targeted offers or addresses the issue that caused the abandonment."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"92-post-purchase-feedback-collection","__idx":29},"children":["9.2 Post-purchase feedback collection"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After a purchase completes, your order-management system triggers the workflow with transaction context. The workflow sends a personalized survey over the customer's preferred channel. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}," to carry order value, product category, and store identifier so the workflow's conditions can route high-value orders to a longer survey."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"93-cross-channel-customer-journey-insight","__idx":30},"children":["9.3 Cross-channel customer-journey insight"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send a trigger after each key interaction — purchase, profile update, service visit. Because every trigger consolidates into the same unified profile (keyed on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelId"]},"), you accumulate a complete view of the customer's interactions across channels while still gathering point-in-time feedback."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"94-known-customer-no-profile-payload","__idx":31},"children":["9.4 Known customer, no profile payload"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your CRM already synchronizes profiles into Sprinklr nightly. At event time you only need to fire the workflow. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /cfmWorkflow/trigger"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}," only — no profile construction, smaller payload, fewer moving parts. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["This case had no V2 equivalent."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"95-localized-survey-distribution","__idx":32},"children":["9.5 Localized survey distribution"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lang"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["country"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["countryCode"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]},". The workflow branches on these values to select a localized survey template and an appropriate distribution channel per market — for example the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"lang\": \"ar\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"country\": \"Jordan\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"countryCode\": \"SA\""]}," combination used in the reference examples."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"96-suppressing-deduplication-for-a-deliberate-re-send","__idx":33},"children":["9.6 Suppressing deduplication for a deliberate re-send"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"IGNORE_DEDUP\": true"]}," when you intentionally want a second survey to reach a customer who has already been contacted — for example a re-survey after a service recovery. Leave it unset (or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},") for normal traffic so the platform's duplicate detection protects the customer from survey fatigue."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"97-multi-channel-fallback","__idx":34},"children":["9.7 Multi-channel fallback"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Attach ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WHATSAPP_BUSINESS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMAIL"]}," identities in a single ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profiles[]"]}," array, as in the (#56-example-request) multi-channel variant. The workflow's distribution action can then choose the channel, and you have not had to decide it at trigger time."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"98-verifying-an-integration-before-go-live","__idx":35},"children":["9.8 Verifying an integration before go-live"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open the workflow record, choose ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Test API Connection"]},", fill in channel type, first name, full name, social network user ID, and any extra ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]},", then click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get API Request"]},". The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowId"]}," is filled in automatically. Add your authentication headers and run the generated request from Postman. A successful execution confirms the API connection before you wire the trigger into your production system flow."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"99-support-case-closure-feedback","__idx":36},"children":["9.9 Support-case-closure feedback"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When your ticketing system closes a case, trigger the workflow with the case reference in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]},". The workflow sends a post-support satisfaction survey and, based on the response, can create a follow-up record or route the customer to a recovery journey."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"10-caveats-and-best-practices","__idx":37},"children":["10. Caveats and best practices"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Success\""]}," is an acknowledgement, not a delivery receipt."]}," The dev note in the endpoint specification is precise: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"Success\""]}," indicates the API endpoint was successful in ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["triggering"]}," the CFM workflow. Survey delivery happens asynchronously inside the workflow. Do not treat a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}," as proof the customer received anything. Instrument delivery on the workflow side."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelId"]}," is the deduplication key."]}," Per the V2 documentation, if the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelId"]}," is unique a new profile is created and a journey is associated with it; otherwise the journey attaches to the existing profile. Get ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelId"]}," normalization right — inconsistent phone-number formatting between systems (with and without country code, with and without ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["+"]},") will silently fragment one customer into several profiles."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Send the same phone number consistently across ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WHATSAPP_BUSINESS"]},"."]}," They are separate ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profiles[]"]}," entries with separate ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelType"]}," values but typically the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelId"]},". Both must be present if you want the workflow to be able to choose between them."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["channelType"]}," is uppercase and case-sensitive."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}," is not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMAIL"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Do not enable ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IGNORE_DEDUP"]}," globally."]}," It exists for deliberate re-sends. Left on by default it will over-survey your customers and depress response rates."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Treat ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["contextParams"]}," as your workflow's public interface."]}," Every key you send becomes a workflow variable that conditions may reference. Adding a key is safe; renaming or removing one silently breaks the branch that reads it. Version your key names and coordinate changes with whoever owns the workflow canvas."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Profile-level custom fields are not supported."]}," The V2 documentation states this explicitly for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileWorkflow.customProperties"]},", and no supplied V3 source contradicts it. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["profileSpaceWorkflows[].customProperties"]}," (workspace-scoped) instead."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Build retry handling despite the specification."]}," No ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}," is declared on either operation, and no rate limit, idempotency, or retry behavior is documented in any supplied source. Implement exponential backoff on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5xx"]}," and on network timeouts. Note that ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["these operations are not documented as idempotent"]}," — a retried ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /triggerWithNewProfile"]}," may fire the workflow twice. Guard retries with your own request-deduplication key until idempotency semantics are confirmed."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Never log request bodies verbatim."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["unifiedProfile.contact"]}," carries names, email addresses, and phone numbers — personally identifiable information. Redact before logging."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Never embed credentials in code, tickets, or chat."]}," See the credential-hygiene callout in (#3-authentication-and-common-headers), including the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["outstanding rotation action"]}," for the three secrets exposed."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parse the response envelope defensively."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}," is declared on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}," but is absent from every supplied CFM example, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ResponseMetadata"]}," has no declared properties. Do not require the key to be present."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Confirm the conflicts in (#12-questions-for-the-api-owner) before publishing this guide."]}," Nine material contradictions between the ticket, the OpenAPI specification, the endpoint specifications, and the V2 baseline are flagged inline. Several affect the request contract directly."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"11-quick-reference","__idx":38},"children":["11. Quick reference"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"111-cfm-workflow-v3-operations","__idx":39},"children":["11.1 CFM Workflow V3 operations"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required field"},"children":["Required field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Response"},"children":["Response"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run workflow via event"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/cfmWorkflow/trigger"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"data\": \"Success\", \"errors\": []}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Run workflow via event with profile details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/cfmWorkflow/triggerWithNewProfile"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workflowId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"data\": \"Success\", \"errors\": []}"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Item"},"children":["Item"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OpenAPI tag"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CFM Workflow V3"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Production base URL"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api3.sprinklr.com/{env}/api/v3"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Request schemas"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CfmWorkflowTriggerV3Request"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CfmWorkflowTriggerProfileV3Request"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["APIResponse"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declared status codes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required headers"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type: application/json"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept: application/json"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Distribution channels"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EMAIL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WHATSAPP_BUSINESS"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fix version"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["26.10 (release date 2026-09-07)"]}]}]}]}]}]},"headings":[{"value":"CFM Workflow API V3 — Developer Guide","id":"cfm-workflow-api-v3--developer-guide","depth":1},{"value":"1. Overview","id":"1-overview","depth":2},{"value":"1.1 The workflow trigger data model","id":"11-the-workflow-trigger-data-model","depth":3},{"value":"1.2 Where workflowId comes from","id":"12-where-workflowid-comes-from","depth":3},{"value":"2. Base URLs and environments","id":"2-base-urls-and-environments","depth":2},{"value":"3. Authentication and common headers","id":"3-authentication-and-common-headers","depth":2},{"value":"4. Run workflow via event","id":"4-run-workflow-via-event","depth":2},{"value":"4.1 Request body","id":"41-request-body","depth":3},{"value":"4.2 Example request","id":"42-example-request","depth":3},{"value":"4.3 Example response","id":"43-example-response","depth":3},{"value":"4.4 Response parameters","id":"44-response-parameters","depth":3},{"value":"5. Run workflow via event with profile details","id":"5-run-workflow-via-event-with-profile-details","depth":2},{"value":"5.1 Request body","id":"51-request-body","depth":3},{"value":"5.2 The unifiedProfile object","id":"52-the-unifiedprofile-object","depth":3},{"value":"5.3 Address object","id":"53-address-object","depth":3},{"value":"5.4 AccountSpecificInfo object","id":"54-accountspecificinfo-object","depth":3},{"value":"5.5 ProfileWorkflow and ProfileSpaceWorkflow","id":"55-profileworkflow-and-profilespaceworkflow","depth":3},{"value":"5.6 Example request","id":"56-example-request","depth":3},{"value":"5.7 Example response","id":"57-example-response","depth":3},{"value":"5.8 Response parameters","id":"58-response-parameters","depth":3},{"value":"6. Response format and status codes","id":"6-response-format-and-status-codes","depth":2},{"value":"6.1 The V3 envelope","id":"61-the-v3-envelope","depth":3},{"value":"6.2 Response codes","id":"62-response-codes","depth":3},{"value":"8. Reference values","id":"8-reference-values","depth":2},{"value":"8.1 channelType values used in CFM distribution","id":"81-channeltype-values-used-in-cfm-distribution","depth":3},{"value":"8.2 Conventional contextParams keys","id":"82-conventional-contextparams-keys","depth":3},{"value":"8.3 Workflow actions and conditions reachable from a trigger","id":"83-workflow-actions-and-conditions-reachable-from-a-trigger","depth":3},{"value":"9. Use cases","id":"9-use-cases","depth":2},{"value":"9.1 Cart-abandonment follow-up","id":"91-cart-abandonment-follow-up","depth":3},{"value":"9.2 Post-purchase feedback collection","id":"92-post-purchase-feedback-collection","depth":3},{"value":"9.3 Cross-channel customer-journey insight","id":"93-cross-channel-customer-journey-insight","depth":3},{"value":"9.4 Known customer, no profile payload","id":"94-known-customer-no-profile-payload","depth":3},{"value":"9.5 Localized survey distribution","id":"95-localized-survey-distribution","depth":3},{"value":"9.6 Suppressing deduplication for a deliberate re-send","id":"96-suppressing-deduplication-for-a-deliberate-re-send","depth":3},{"value":"9.7 Multi-channel fallback","id":"97-multi-channel-fallback","depth":3},{"value":"9.8 Verifying an integration before go-live","id":"98-verifying-an-integration-before-go-live","depth":3},{"value":"9.9 Support-case-closure feedback","id":"99-support-case-closure-feedback","depth":3},{"value":"10. Caveats and best practices","id":"10-caveats-and-best-practices","depth":2},{"value":"11. Quick reference","id":"11-quick-reference","depth":2},{"value":"11.1 CFM Workflow V3 operations","id":"111-cfm-workflow-v3-operations","depth":3}],"frontmatter":{"seo":{"title":"CFM Workflow API V3 — Developer Guide"}},"lastModified":"2026-10-22T18:13:07.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/developer-guides-v3/cfm-workflow-api-v3-developer-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}