{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Data Ingestion and Media Upload API V3","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":"data-ingestion-and-media-upload-api-v3","__idx":0},"children":["Data Ingestion and Media Upload API V3"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Data Ingestion"]}," API V3 to import external profile and message data into Sprinklr. The API works with ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Media Upload"]}," API V3, which uploads the source file and provides the URL required by the ingestion request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide is intended for developers who are building integrations to import profile or message data into Sprinklr."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Media Upload"]}," is the supporting API that gets your spreadsheet to a public URL in the first place. Data Ingestion does not accept a file — it accepts a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileUrl"]}]},". Media Upload is how you produce one."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"data-ingestion-uses-the-following-workflow","__idx":1},"children":["Data ingestion uses the following workflow:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"1. POST /api/v3/media/upload          → Upload the source file (.csv/.xlsx), receive { url }\n2. POST /api/v3/dataIngestion/ingest  → Submit and ingestion task { fileUrl: <that url>, ... }, receive { taskId }\n                                      → Sprinklr processes the ingestion task\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The V3 Developer Portal defines ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /dataIngestion/ingest"]}," as the operation for submitting an ingestion task and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /media/upload"]}," for uploading media. Both operations require bearer-token and API-key authentication."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Data ingestion is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["asynchronous"]},". The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," you get back is an acknowledgement carrying a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskId"]},", not a result. The actual outcome — how many records were created, how many failed, and where to download each set — arrives later at your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callbackUrl"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"supported-ingestion-types","__idx":2},"children":["Supported ingestion types"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ingestion request uses the type field to identify the type of data being imported."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For profile and message ingestion, the existing Data Ingestion and Media Upload API V3 guide documents these values:"]},{"$$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":"Use case"},"children":["Use case"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"type value"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V2 page"},"children":["V2 page"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Import profiles"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PROFILE"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INFLUENCER_PROFILE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/bulk-profile"},"children":["Bulk Profile"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Import messages"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LISTENING_MESSAGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/bulk-messages"},"children":["Bulk Messages"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," values are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["case-sensitive"]},". Define them as constants in your own code."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"before-you-begin","__idx":3},"children":["Before you begin"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"the-template-must-exist-in-the-sprinklr-ui","__idx":4},"children":["The template must exist in the Sprinklr UI"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before submitting an ingestion task, prepare the template used to map the columns in your source file to Sprinklr fields. The saved template name is provided in the templateName field of the ingestion request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Neither ingestion type works from a bare spreadsheet. You must first establish a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["template"]}," in the UI that maps your file's column headers to Sprinklr fields. This is a one-time, per-template manual step."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Prepare a profile template:"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log in to the Sprinklr UI and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Profile"]}," within ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modern Engagement"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Import"]}," icon on the top right."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Download Excel Template"]}," to download the template needed for this API."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Fill in the profile details in the template and upload the file onto the web."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The existing V3 documentation describes profile ingestion as an upsert: when an existing profile identifier is found, Sprinklr updates the profile; otherwise, it creates a profile."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Prepare a message template:"]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log in to the Sprinklr UI and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["First Party Data Ingestion"]}," within ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Modern Research"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Import from Excel"]}," on the top right."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Upload the Excel file from your local machine."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter the unique file name and map the Sprinklr fields to the corresponding file headers used in the Excel file. Save the mapping."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you map the file headers within Sprinklr and save the mapping under a unique name, you can reuse the same file shape to import more data. You can reference that template by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateName"]}," in every subsequent API call and never repeat the UI step for that file shape."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"profile-ingestion-is-an-upsert","__idx":5},"children":["Profile ingestion is an upsert"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each profile has a unique ID. If the system finds a profile with that ID in the spreadsheet it updates the profile; otherwise it creates one. There is no separate update endpoint."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By default, the key is the Sprinklr identifier. You can override this with ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#identifierfields--matching-on-your-own-keys"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identifierFields"]}]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-url","__idx":6},"children":["Base URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the following base URL:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The endpoints used in this workflow are:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/media/upload\nhttps://api3.sprinklr.com/{env}/api/v3/dataIngestion/ingest\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]}," with your assigned Sprinklr environment. For the production environment at app.sprinklr.com, omit the {env} segment from the URL. For information about supported environments and how to identify your environment, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/apis"},"children":["APIs | Sprinklr Developer Portal"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The current V3 API reference identifies the production Data Ingestion endpoint as:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/prod/api/v3/dataIngestion/ingest\n\n"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environment-scoped credentials."]}," API keys and access tokens are scoped to a single environment. A key generated for one environment returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}," against another even when the request is otherwise perfect."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Content-store URLs are environment-specific too."]}," The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["url"]}," returned by Media Upload belongs to the environment you uploaded to. You must feed it to the ingestion endpoint ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["in that same environment"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":7},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All 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":"p","attributes":{},"children":["Both APIs use bearer-token and API-key authentication."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"required-headers","__idx":8},"children":["Required headers"]},{"$$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":["Bearer {{accessToken}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authenticates the user with the server"]},{"$$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":["Authenticates the application with the server"]},{"$$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":["Declares the request body media type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataIngestion/ingest"]}]}]},{"$$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":["multipart/form-data; boundary=<calculated when request is sent>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declares a file upload body"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["media/upload"]}]}]},{"$$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":["Declares the acceptable response type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}," are required on every call. Sending only one returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For file uploads, let your HTTP client generate the appropriate multipart request when attaching the file."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"credential-lifetimes","__idx":9},"children":["Credential lifetimes"]},{"$$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":"Credential"},"children":["Credential"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Lifetime"},"children":["Lifetime"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorization code"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["10 minutes"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["API key"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No expiry"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Access token"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["30 days by default"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["One token pair per API key."]}," Generating a new access token for an API key invalidates the previously issued token and refresh token for that key. Two services sharing one key will knock each other offline. Give each service its own key."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credential hygiene."]}," Never commit an access token or API key, never paste one into a ticket, and never log the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}," header values. Every credential on this page is a placeholder."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"upload-a-file","__idx":10},"children":["Upload a file"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use Media Upload API V3 to upload the source file."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /api/v3/media/upload\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The V3 API reference identifies /media/upload as the operation for uploading one or more media files."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Content store is not Asset Manager."]}," Uploading gives you a stored file and a URL. It does ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," create a managed asset in the Sprinklr Social Asset Manager. For ingestion that is exactly what you want — you only need the URL. If you want the file to appear in Asset Manager, make a separate ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/create-asset"},"children":["Asset Create"]}," call."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-parameters","__idx":11},"children":["Query 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":"Required"},"children":["Required"]},{"$$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":["assetType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The type of asset being uploaded, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["file"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["image"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["video"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The name of the file to upload, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["including its extension"]}," — for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customers.xlsx"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"form-data-body","__idx":12},"children":["Form-data body"]},{"$$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":"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":["file"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Yes"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Source of the uploaded media content"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request","__idx":13},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n  'https://api3.sprinklr.com/{env}/api/v3/media/upload?assetType=file&fileName=customers.xlsx' \\\n  -H 'Authorization: Bearer {{accessToken}}' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Accept: application/json' \\\n  -F 'file=@\"/path/to/customers.xlsx\"'\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The existing V3 guide documents assetType and fileName as required query parameters and file as the multipart form-data field."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response","__idx":14},"children":["Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"id\": \"608676dbc2952f59abc797af\",\n    \"mimeType\": \"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet\",\n    \"name\": \"customers.xlsx\",\n    \"url\": \"https://{env}-assets.sprinklr.com/{env}-cdata/DAM/50001/00000000-0000-0000-0000-000000000000-0000000000/customers.xlsx\",\n    \"previewUrl\": \"\",\n    \"size\": 15511\n  },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the returned data.url value as fileUrl when you submit the ingestion request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"media-upload-response-fields","__idx":15},"children":["Media Upload response fields"]},{"$$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":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier for the uploaded content"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["mimeType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The asset type and format, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["image/png"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$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":["The file name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["url"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["URL"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The URL of the uploaded content on the Sprinklr platform"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["previewUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["URL"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The preview URL of the uploaded content"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["size"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The size of the uploaded content in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["bytes"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["width"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Width of the uploaded content. Returned for image and video asset types"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["height"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Height of the uploaded content. Returned for image and video asset types"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["previewWidth"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Preview width. Returned for the image asset type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["previewHeight"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Preview height. Returned for the image asset type"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["previewUrl"]}," is an empty string for non-previewable types such as spreadsheets, and populated for images."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Uploading multiple files."]}," V3 exposes a single upload path. Call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/media/upload"]}," once per file rather than using the V2 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/media/upload/multiple"]}," path."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"submit-a-data-ingestion-task","__idx":16},"children":["Submit a data ingestion task"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After uploading the source file, submit the ingestion task:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /api/v3/dataIngestion/ingest\n"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The path segment is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataIngestion"]}," — camelCase, not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-ingestion"]},"."]}," This is the change most likely to break a V2 integration. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#migrating-from-v2"},"children":["Migrating from V2"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-parameters","__idx":17},"children":["Request 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":"Field"},"children":["Field"]},{"$$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":["type"]}]},{"$$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":["Type of ingestion — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PROFILE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INFLUENCER_PROFILE"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LISTENING_MESSAGE"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$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":["Unique task name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileName"]}]},{"$$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 file"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileUrl"]}]},{"$$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":["URL of the file to load data from — the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.url"]}," returned by Media Upload"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateName"]}]},{"$$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 template to use for ingestion, as saved in the UI"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callbackUrl"]}]},{"$$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":["Callback URL to receive notification on completion"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["importTag"]}]},{"$$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":["Tag for filtering"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callbackType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callbackUrl"]}," is provided"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of callback to use"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callbackUrlHeaders"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (string → string)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Headers sent with the callback request, for authenticating the call into your receiver"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identifierFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (string → array of strings)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Your own unique identifiers, used to match existing data instead of Sprinklr identifiers. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PROFILE"]}," only"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$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":["Task-related identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ingestionTaskId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Existing ingestion task identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ingestion-task status"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["externalSourceType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["External-source type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credentialsId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credentials identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["additional"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Additional task information"]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Send all eight of the fields marked Required above on every call."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileName"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["importTag"]}," are easy to omit if you are porting a V2 payload — include both."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--import-profile","__idx":18},"children":["Example — Import profile"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n  'https://api3.sprinklr.com/{env}/api/v3/dataIngestion/ingest' \\\n  -H 'Authorization: Bearer {{accessToken}}' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'Accept: application/json' \\\n  -d '{\n    \"type\": \"PROFILE\",\n    \"name\": \"crm-profile-import\",\n    \"fileName\": \"customers.xlsx\",\n    \"fileUrl\": \"https://{env}-assets.sprinklr.com/{env}-cdata/DAM/50001/00000000-0000-0000-0000-000000000000-0000000000/customers.xlsx\",\n    \"importTag\": \"crm-nightly\",\n    \"templateName\": \"crm-profile-template\",\n    \"callbackUrl\": \"https://your-host.example.com/hooks/sprinklr-ingest\",\n    \"callbackType\": \"PUBLIC_URL\",\n    \"callbackUrlHeaders\": {\n      \"X-Webhook-Token\": \"{{callbackSecret}}\"\n    },\n    \"identifierFields\": {\n      \"PARTNER_CUSTOM_PROPERTIES\": [\n        \"crm_customer_id\"\n      ]\n    }\n  }'\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The V3 API schema requires type, name, fileName, fileUrl, templateName, and callbackUrl."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--import-messages","__idx":19},"children":["Example — Import messages"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"curl -X POST \\\n  'https://api3.sprinklr.com/{env}/api/v3/dataIngestion/ingest' \\\n  -H 'Authorization: Bearer {{accessToken}}' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Content-Type: application/json' \\\n  -H 'Accept: application/json' \\\n  -d '{\n    \"type\": \"LISTENING_MESSAGE\",\n    \"name\": \"reviews-import-2026-09-02\",\n    \"fileName\": \"messages.xlsx\",\n    \"fileUrl\": \"https://{env}-assets.sprinklr.com/{env}-cdata/DAM/50001/00000000-0000-0000-0000-000000000000-0000000000/messages.xlsx\",\n    \"importTag\": \"reviews-archive\",\n    \"templateName\": \"reviews-template\",\n    \"callbackUrl\": \"https://your-host.example.com/hooks/sprinklr-ingest\",\n    \"callbackType\": \"PUBLIC_URL\"\n  }'\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The only differences from the profile call are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," and the absence of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identifierFields"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-response-1","__idx":20},"children":["Example response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": \"{\\\"taskId\\\":\\\"6033961866934b5708a5f90a\\\"}\",\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," is a JSON-encoded ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]},", not an object."]}," The value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"{\\\"taskId\\\":\\\"...\\\"}\""]}," — a string containing escaped JSON. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parse it twice"]},": once for the response envelope, then again for the inner payload."]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"envelope = response.json()\ninner = json.loads(envelope[\"data\"])   # second parse — required\ntask_id = inner[\"taskId\"]\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Store the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskId"]},". It is your only correlation handle, and it reappears as the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," on the callback payload."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"use-custom-profile-identifiers","__idx":21},"children":["Use custom profile identifiers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identifierFields"]}," object lets an integration provide unique identifiers used to find existing data instead of relying only on Sprinklr identifiers. The current V3 API schema includes identifierFields as an optional object."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"identifierFields\": {\n    \"PARTNER_CUSTOM_PROPERTIES\": [\n      \"crm_customer_id\"\n    ]\n  }\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this option only when the identifier configuration for your ingestion workflow supports it."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"handle-the-response","__idx":22},"children":["Handle the response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful Data Ingestion request uses the standard V3 response envelope. The current V3 reference defines data as an object, accompanied by errors and metadata."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {},\n  \"errors\": [],\n  \"metadata\": {}\n}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the task information returned by the service to correlate the submitted ingestion with subsequent processing."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"handle-ingestion-completion","__idx":23},"children":["Handle ingestion completion"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ingestion request includes a required callbackUrl, which the V3 API reference describes as the URL used to receive a notification on successful ingestion. Optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callbackUrlHeaders"]}," can also be supplied."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configure the callback endpoint before submitting an ingestion request and use the task identifier returned by the ingestion service to correlate the callback with the source request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response-status-codes","__idx":24},"children":["Response status codes"]},{"$$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":"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. Ingestion returns a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskId"]},"; upload returns content metadata"]}]},{"$$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":["Missing required field, unknown ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", malformed multipart body, or unreachable ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileUrl"]}]}]},{"$$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":["Invalid or missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," token or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}," header"]}]},{"$$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":["Caller lacks permission to ingest data or upload media"]}]},{"$$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":["Wrong path — most often ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-ingestion"]}," instead of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataIngestion"]},". Also an unknown ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateName"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"the-error-object","__idx":25},"children":["The error object"]},{"$$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":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Numeric error code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error key, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account.not.found"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"troubleshooting","__idx":26},"children":["Troubleshooting"]},{"$$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":"Symptom"},"children":["Symptom"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Likely cause"},"children":["Likely cause"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Fix"},"children":["Fix"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}," on every ingestion call"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-ingestion"]}," (kebab) instead of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataIngestion"]}," (camelCase)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Change the path. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["This is the number-one V3 migration failure"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," naming ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileName"]}," is required in V3"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileName"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," naming ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["importTag"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["importTag"]}," is required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["importTag"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Value not one of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PROFILE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INFLUENCER_PROFILE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LISTENING_MESSAGE"]},", or wrong case"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use one of the three exactly"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateName"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Template does not exist, or the name does not match exactly"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Re-check the name saved in the UI"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client fails deserializing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ingestion returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," as a JSON-",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["encoded string"]},", not an object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Parse twice"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," on multipart upload"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}," hard-coded without a matching boundary"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Let the HTTP client set the header"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Upload succeeds, ingestion ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},"s on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The content-store URL is environment-specific"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Upload and ingest in the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Callback never arrives"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Receiver does not return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," to an empty POST, or the TLS certificate is invalid"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Verify both"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Callback arrives, results look wrong"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["You are reading the synchronous response, not the callback payload"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Per-record counts are callback-only"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Cannot tell which rows failed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The synchronous response has no per-record data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Download ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failedFileUrl"]}," — the reason is in the last column"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}," with all headers present"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credentials belong to a different environment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Regenerate for the target environment"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}," after previously working"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Token expired (30-day default), or a second token was issued for the same key"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Refresh; one key per service"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Uploaded file not in Asset Manager"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The content store is not Asset Manager"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Asset Create"]}," separately"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"migrate-from-v2","__idx":27},"children":["Migrate from V2"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Update integrations that use the V2 Data Ingestion endpoint to use the V3 path."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"diff","header":{"controls":{"copy":{}}},"source":"- POST /api/v2/data-ingestion/ingest\n+ POST /api/v3/dataIngestion/ingest\n","lang":"diff"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For V3, the Data Ingestion namespace is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataIngestion"]},". The current V3 endpoint is explicitly published as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /dataIngestion/ingest"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Media uploads use:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /api/v3/media/upload\n\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When migrating, also review your request against the V3 schema rather than assuming V2 and V3 have identical request and response contracts."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-use-cases","__idx":28},"children":["Common Use Cases"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"nightly-crm-to-sprinklr-profile-sync","__idx":29},"children":["Nightly CRM to Sprinklr profile sync"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Export changed customers to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".xlsx"]},", then:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /api/v3/media/upload?assetType=file&fileName=customers-2026-09-02.xlsx\n  → data.url\n\nPOST /api/v3/dataIngestion/ingest\n  { \"type\": \"PROFILE\", \"name\": \"crm-sync-2026-09-02\", \"fileName\": \"customers-2026-09-02.xlsx\",\n    \"fileUrl\": \"<data.url>\", \"importTag\": \"crm-nightly\",\n    \"templateName\": \"crm-profile-template\",\n    \"callbackUrl\": \"https://your-host.example.com/hooks/sprinklr-ingest\",\n    \"callbackType\": \"PUBLIC_URL\" }\n  → { \"taskId\": \"...\" }\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Because profile ingestion upserts, the same job handles both new and changed customers. Use a dated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," so tasks are traceable, and a stable ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["importTag"]}," so all runs of this job can be filtered together."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"match-on-your-own-customer-key","__idx":30},"children":["Match on your own customer key"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you do not want to store Sprinklr IDs, add ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identifierFields"]}," so matching happens on your key instead:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"\"identifierFields\": { \"PARTNER_CUSTOM_PROPERTIES\": [\"crm_customer_id\"] }\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PROFILE"]}," only, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PARTNER_CUSTOM_PROPERTIES"]}," is the only supported key."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"import-historical-messages-for-listening-and-ai","__idx":31},"children":["Import historical messages for listening and AI"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Load an archive of support tickets or reviews as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LISTENING_MESSAGE"]}," so Sprinklr AI, listening, and automation apply to them and they appear alongside native data in the same dashboards."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Message ingestion requires a template mapped through ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["First Party Data Ingestion"]}," in Modern Research."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"reconcile-results-and-retry-failures","__idx":32},"children":["Reconcile results and retry failures"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do not treat the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," as success. On callback:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"if failedRecordsCount > 0:\n    download failedFileUrl        # last column = failure reason\n    fix rows, re-upload, re-ingest\ndownload successfulFileUrl        # last column = Sprinklr ID → store the mapping\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["successfulFileUrl"]}," is the only way to map your rows back to Sprinklr IDs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"handle-re-runs-safely","__idx":33},"children":["Handle re-runs safely"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," unique per run — a timestamp or UUID — and rely on the upsert key (the Sprinklr ID, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identifierFields"]},") to prevent duplicate records if a job is replayed."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"attach-images-or-documents-to-a-workflow","__idx":34},"children":["Attach images or documents to a workflow"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Media Upload is useful independently of ingestion. Upload once, then reference ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.url"]}," wherever the platform accepts a media URL. Remember that this does ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," create an Asset Manager asset — call ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/create-asset"},"children":["Asset Create"]}," if you need that."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"best-practices","__idx":35},"children":["Best practices"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Path and namespace"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The path is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataIngestion"]},", camelCase. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data-ingestion"]}," returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Keep the base path in one configuration constant."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileUrl"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callbackUrl"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["importTag"]}," on every call."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," accepts ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PROFILE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["INFLUENCER_PROFILE"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LISTENING_MESSAGE"]},", and is case-sensitive."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Never send an empty ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileUrl"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Asynchrony"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," is an acknowledgement, not a result. Per-record outcomes arrive only at the callback."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your callback receiver must return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," to an empty POST and present a valid TLS certificate."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Always download ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failedFileUrl"]}," when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["failedRecordsCount > 0"]},"; the reason is in the last column."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Store the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["taskId"]}," — it is the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," on the callback payload and your only correlation handle."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response parsing"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ingestion returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," as a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["JSON-encoded string"]},". Parse twice."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Media Upload returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," as a real object. The two endpoints differ."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Always inspect the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," array, not just the HTTP status."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["startTime"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["completionTime"]}," are epoch ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["milliseconds"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Media upload"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Let your HTTP client set the multipart ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}," boundary."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The form field name is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["file"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fileName"]}," with its extension."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Content-store URLs are environment-specific — upload and ingest in the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Uploading does not create an Asset Manager asset."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Templates and permissions"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The template must be created in the UI first; this cannot be automated through these APIs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["templateName"]}," must match exactly."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}," is a permission gap, not a malformed request."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Volume"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add backoff around bulk jobs, and keep individual files to a size your own pipeline can re-drive on failure."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":36},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/data-ingestion"},"children":["Data Ingestion (V2)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/bulk-profile"},"children":["Bulk Profile (V2)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/bulk-messages"},"children":["Bulk Messages (V2)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/media-upload"},"children":["Media Upload"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/create-asset"},"children":["Create Asset"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/api-overview"},"children":["API Overview"]}]}]}]},"headings":[{"value":"Data Ingestion and Media Upload API V3","id":"data-ingestion-and-media-upload-api-v3","depth":1},{"value":"Data ingestion uses the following workflow:","id":"data-ingestion-uses-the-following-workflow","depth":2},{"value":"Supported ingestion types","id":"supported-ingestion-types","depth":3},{"value":"Before you begin","id":"before-you-begin","depth":2},{"value":"The template must exist in the Sprinklr UI","id":"the-template-must-exist-in-the-sprinklr-ui","depth":3},{"value":"Profile ingestion is an upsert","id":"profile-ingestion-is-an-upsert","depth":3},{"value":"Base URL","id":"base-url","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Required headers","id":"required-headers","depth":3},{"value":"Credential lifetimes","id":"credential-lifetimes","depth":3},{"value":"Upload a file","id":"upload-a-file","depth":2},{"value":"Query parameters","id":"query-parameters","depth":3},{"value":"Form-data body","id":"form-data-body","depth":3},{"value":"Example request","id":"example-request","depth":3},{"value":"Example response","id":"example-response","depth":3},{"value":"Media Upload response fields","id":"media-upload-response-fields","depth":3},{"value":"Submit a data ingestion task","id":"submit-a-data-ingestion-task","depth":2},{"value":"Request parameters","id":"request-parameters","depth":3},{"value":"Example — Import profile","id":"example--import-profile","depth":3},{"value":"Example — Import messages","id":"example--import-messages","depth":3},{"value":"Example response","id":"example-response-1","depth":3},{"value":"Use custom profile identifiers","id":"use-custom-profile-identifiers","depth":2},{"value":"Handle the response","id":"handle-the-response","depth":2},{"value":"Handle ingestion completion","id":"handle-ingestion-completion","depth":2},{"value":"Response status codes","id":"response-status-codes","depth":2},{"value":"The error object","id":"the-error-object","depth":3},{"value":"Troubleshooting","id":"troubleshooting","depth":3},{"value":"Migrate from V2","id":"migrate-from-v2","depth":2},{"value":"Common Use Cases","id":"common-use-cases","depth":2},{"value":"Nightly CRM to Sprinklr profile sync","id":"nightly-crm-to-sprinklr-profile-sync","depth":3},{"value":"Match on your own customer key","id":"match-on-your-own-customer-key","depth":3},{"value":"Import historical messages for listening and AI","id":"import-historical-messages-for-listening-and-ai","depth":3},{"value":"Reconcile results and retry failures","id":"reconcile-results-and-retry-failures","depth":3},{"value":"Handle re-runs safely","id":"handle-re-runs-safely","depth":3},{"value":"Attach images or documents to a workflow","id":"attach-images-or-documents-to-a-workflow","depth":3},{"value":"Best practices","id":"best-practices","depth":2},{"value":"Related","id":"related","depth":2}],"frontmatter":{"seo":{"title":"Data Ingestion and Media Upload API V3"}},"lastModified":"2026-11-06T09:19:25.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/developer-guides-v3/data-ingestion-media-upload-api-v3","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}