{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Participant 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":"participant-api-v3--developer-guide","__idx":0},"children":["Participant 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 Account Participant API V3 (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/account/participants"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/participant-api"},"children":["Participant API | 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":["Using the participant APIs, you can create a participant and configure a primary participant for participating in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["omnichannel handover protocol"]},". In V2, the create operation is described as setting up a participant ID for a third-party bot, and the account-participant update is used to link that participant with a social account on Sprinklr."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Related knowledge base article: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/articles/api/omnichannel-handover-protocol/64832193723d925979db8cd4"},"children":["Omnichannel Handover Protocol."]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Participant V3 exposes full CRUD on a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["single resource path"]},", differentiated by HTTP method:"]},{"$$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":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create participant"]},{"$$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/account/participants"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch participant(s)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/account/participants?id="]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?accountId="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update participant (full replace)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/account/participants?id="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Patch participant associations"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/account/participants?id="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete participant(s)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/account/participants?id="]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"11-the-participant-data-model","__idx":2},"children":["1.1 The participant data model"]},{"$$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":"Object"},"children":["Object"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Fields"},"children":["Fields"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Participant"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["imageUrl"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callbackUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The participant record itself"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AccountParticipantPatchRequestDTO"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountLinkAction"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["primaryAction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The association between a participant and a social account"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AccountParticipantFetchResponseDTO"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participant"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participantIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read result — a single participant, or a list of participant IDs"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A participant is created first; its ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["association with a social account"]}," (link/unlink, primary/not-primary) is then managed separately through ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"12-addressing-a-participant","__idx":3},"children":["1.2 Addressing a participant"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A participant is addressed by its Sprinklr participant ID in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," query parameter, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["6a671fbad316e45725dac06c"]},". ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," accept ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["comma-separated"]}," IDs for bulk operations; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," act on a single ID."]},{"$$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 API calls are sent to the production endpoint:"]}]},{"$$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 participant resource is:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/account/participants\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":["prod11"]},", and so on — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/apis"},"children":["APIs | Sprinklr Developer Portal"]}," for the environment list)."]},{"$$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 Participant API calls are authenticated with OAuth 2.0. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/articles/developer-tools/developer-tools-in-sprinklr/692e8b39f0afa271d18a5929"},"children":["Developer Tools in Sprinklr"]}," for API key and secret generation, and the Authorize flow on the developer portal."]},{"$$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":["******"]}]},{"$$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":["POST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]}]},{"$$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":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-write-operations","__idx":6},"children":["4. Write operations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"41-create-a-participant","__idx":7},"children":["4.1 Create a participant"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/account/participants"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates a participant that can take part in the omnichannel handover protocol — for example, a third-party bot."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body--participant","__idx":8},"children":["Request body — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Participant"]}]},{"$$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":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Participant id. Server-assigned on create."]}]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the participant"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["imageUrl"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Image URL of the participant"]}]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Callback URL of the participant"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request","__idx":9},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/{env}/api/v3/account/participants' \\\n--header 'Authorization: ******' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--data-raw '{\n    \"name\": \"Cricket Club & Programmes1\",\n    \"imageUrl\": \"https://s3.ap-south-1.amazonaws.com/qa4-uploads-container/400002/ACCOUNT/IMAGE/0EA329067F374758DEA0BF2458155C7D\"\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response","__idx":10},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 Success"]},", body ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AccountParticipantFetchResponseDTO"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}," ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(illustrative example, generated from the documented schema)"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"participant\": {\n    \"id\": \"6a671fbad316e45725dac06c\",\n    \"name\": \"Cricket Club & Programmes1\",\n    \"imageUrl\": \"https://s3.ap-south-1.amazonaws.com/qa4-uploads-container/400002/ACCOUNT/IMAGE/0EA329067F374758DEA0BF2458155C7D\",\n    \"callbackUrl\": \"https://example.com/participant/callback\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Capture the returned ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participant.id"]},". Every later call addresses the participant by that ID."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"42-update-a-participant--full-update","__idx":11},"children":["4.2 Update a participant — full update"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v3/account/participants?id={participantId}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replaces the participant record with the supplied document."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters","__idx":12},"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":"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":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$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":["Optional in the specification; required in practice"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Participant id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["6a671fbad316e45725dac06c"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body--participant-1","__idx":13},"children":["Request body — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Participant"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Same schema as ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#41-create-a-participant"},"children":["§4.1"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-1","__idx":14},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request PUT 'https://api3.sprinklr.com/{env}/api/v3/account/participants?id=6a671fbad316e45725dac06c' \\\n--header 'Authorization: ******' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--data-raw '{\n  \"name\": \"Cricket Club & Programmes Updated\",\n  \"imageUrl\": \"https://s3.ap-south-1.amazonaws.com/qa4-uploads-container/400002/ACCOUNT/IMAGE/0EA329067F374758DEA0BF2458155C7D\"\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-1","__idx":15},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 Success"]},", body type ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}," per the specification (not the JSON envelope returned by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},")."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"️-put-replaces--it-does-not-merge","__idx":16},"children":["⚠️ ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," replaces — it does not merge"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," takes the whole ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Participant"]}," document. Any field you omit — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callbackUrl"]},", for instance, as in the sample above — is at risk of being cleared. Before issuing a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},":"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," the current participant."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Merge your changes into the retrieved document."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," the merged result back."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you only need to change the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["account association"]}," (link/unlink, primary), use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#43-patch-participant-associations"},"children":["§4.3"]},") — that is a different schema entirely and does not touch ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["imageUrl"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callbackUrl"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"43-patch-participant-associations","__idx":17},"children":["4.3 Patch participant associations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/account/participants?id={participantId}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Partial update: link or unlink a participant to an account, and/or set or unset it as the primary participant on that account."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Dev note:"]}," make this call ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["immediately after creating the participant"]},", to link that participant with the social account on Sprinklr."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters-1","__idx":18},"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":"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":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$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":["Optional in the specification; required in practice"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Participant id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["6a671fbad316e45725dac06c"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body--accountparticipantpatchrequestdto","__idx":19},"children":["Request Body — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AccountParticipantPatchRequestDTO"]}]},{"$$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":"th","attributes":{"data-label":"Allowed values"},"children":["Allowed values"]}]}]},{"$$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":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["int64"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account id for link or primary operations"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["66000000"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountLinkAction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Link participant to account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNSET"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["primaryAction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Primary participant on account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SET"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNSET"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-2","__idx":20},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request PATCH 'https://api3.sprinklr.com/{env}/api/v3/account/participants?id=6a671fbad316e45725dac06c' \\\n--header 'Authorization: ******' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Content-Type: application/json' \\\n--header 'Accept: application/json' \\\n--data '{\n    \"accountId\": \"66000000\",\n    \"accountLinkAction\": \"SET\"\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-2","__idx":21},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 Success"]},", body type ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"choosing-the-right-action","__idx":22},"children":["Choosing the right action"]},{"$$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":"Intent"},"children":["Intent"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Body"},"children":["Body"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Link the participant to an account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"accountId\": <id>, \"accountLinkAction\": \"SET\"}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unlink the participant from an account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"accountId\": <id>, \"accountLinkAction\": \"UNSET\"}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Make the participant primary on an account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"accountId\": <id>, \"primaryAction\": \"SET\"}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Remove primary status"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"accountId\": <id>, \"primaryAction\": \"UNSET\"}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Link and set primary in one call"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"accountId\": <id>, \"accountLinkAction\": \"SET\", \"primaryAction\": \"SET\"}"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"44-delete-participants","__idx":23},"children":["4.4 Delete participant(s)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/account/participants?id={participantId}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deletes one or more participants. Supports bulk deletion through comma-separated IDs."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"query-parameters-2","__idx":24},"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":"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":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$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":["Optional in the specification; required in practice"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Participant id(s), comma-separated"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["6a60813b6a74f25cd1467718"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-3","__idx":25},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request DELETE 'https://api3.sprinklr.com/{env}/api/v3/account/participants?id=6a60813b6a74f25cd1467718' \\\n--header 'Authorization: ******' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Bulk delete\ncurl --location --request DELETE 'https://api3.sprinklr.com/{env}/api/v3/account/participants?id=6a60813b6a74f25cd1467718,6a671fbad316e45725dac06c' \\\n--header 'Authorization: ******' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-3","__idx":26},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 Success"]},", body type ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"45-method-comparison--when-to-use-which","__idx":27},"children":["4.5 Method comparison — when to use which"]},{"$$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":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"POST"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"PUT"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"PATCH"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"DELETE"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Purpose"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a participant"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Replace the participant record"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Change account association only"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Remove participant(s)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Addressing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None — identity is server-assigned"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}," (comma-separated)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Body schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Participant"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Participant"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AccountParticipantPatchRequestDTO"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unspecified fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Replaced/cleared"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Preserved"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["N/A"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bulk"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Yes"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response body"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AccountParticipantFetchResponseDTO"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," take ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["different body schemas"]},". You cannot reuse one payload for both methods."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-read-operations","__idx":28},"children":["5. Read operations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"51-get-apiv3accountparticipants--fetch-participants","__idx":29},"children":["5.1 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/account/participants"]}," — Fetch participant(s)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["dual-mode"]}," endpoint: fetch a participant by its own ID, or list the participant IDs attached to an account."]},{"$$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":"th","attributes":{"data-label":"Example"},"children":["Example"]}]}]},{"$$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":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Participant id(s), comma-separated"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["6a671fbad316e45725dac06c"]}]}]},{"$$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":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account id to list participants for"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["66000000"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"mode-1--fetch-by-participant-id","__idx":30},"children":["Mode 1 — Fetch by participant id"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/{env}/api/v3/account/participants?id=6a671fbad316e45725dac06c' \\\n--header 'Authorization: ******' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"# Multiple IDs in one call\ncurl --location 'https://api3.sprinklr.com/{env}/api/v3/account/participants?id=6a671fbad316e45725dac06c,6a60813b6a74f25cd1467718' \\\n--header 'Authorization: ******' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"mode-2--list-participants-on-an-account","__idx":31},"children":["Mode 2 — List participants on an account"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/{env}/api/v3/account/participants?accountId=66000000' \\\n--header 'Authorization: ******' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-4","__idx":32},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 Success"]},", body: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["array of"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AccountParticipantFetchResponseDTO"]},"."]},{"$$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":["participant"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Participant"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Participant details when fetched by participant id"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participantIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Participant ids when fetched by account id"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response — fetch by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]}," ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(illustrative example, generated from the documented schema)"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"[\n  {\n    \"participant\": {\n      \"id\": \"6a671fbad316e45725dac06c\",\n      \"name\": \"Cricket Club & Programmes1\",\n      \"imageUrl\": \"https://s3.ap-south-1.amazonaws.com/qa4-uploads-container/400002/ACCOUNT/IMAGE/0EA329067F374758DEA0BF2458155C7D\",\n      \"callbackUrl\": \"https://example.com/participant/callback\"\n    }\n  }\n]\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response — fetch by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]}]}," ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(illustrative example, generated from the documented schema)"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"[\n  {\n    \"participantIds\": [\n      \"6a671fbad316e45725dac06c\",\n      \"6a60813b6a74f25cd1467718\"\n    ]\n  }\n]\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetching by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]}," returns ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["IDs only"]},". To hydrate them, follow up with a comma-separated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}," call rather than one call per ID."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter hygiene."]}," Both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]}," are declared optional, so a call with neither is syntactically valid but has no defined behavior. Always send exactly one of the two."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-response-format-and-status-codes","__idx":33},"children":["6. Response format and status codes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"61-response-bodies","__idx":34},"children":["6.1 Response bodies"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unlike most V3 read endpoints, the participant operations do ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," all return the standard ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}," envelope in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sprinklr-v3.yaml"]},":"]},{"$$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":"Declared 200 schema"},"children":["Declared ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," schema"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["array"]}," of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AccountParticipantFetchResponseDTO"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$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":["AccountParticipantFetchResponseDTO"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Parse ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," responses as plain strings, not JSON objects — or confirm with the API owner that the gateway wraps them in the standard envelope (",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#10-questions-for-the-api-owner"},"children":["§10"]},")."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"62-response-codes","__idx":35},"children":["6.2 Response codes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Declared on every participant operation:"]},{"$$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":["Operation completed 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 required parameters or invalid parameter combinations"]}]},{"$$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":["Caller lacks permission on the account or participant entity"]}]},{"$$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 participant matches the supplied ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountId"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500 Internal Server Error"]}," is not declared on these operations; handle it defensively regardless."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"7-v2--v3-migration","__idx":36},"children":["7. V2 → V3 migration"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"71-endpoint-mapping","__idx":37},"children":["7.1 Endpoint mapping"]},{"$$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":"V2"},"children":["V2"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V3"},"children":["V3"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/create-participant-api"},"children":["Create Participant API"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/account/participants"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/update-account-participant"},"children":["Update Account Participant"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/account/participants?id="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch participant"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/account/participants?id="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List participants on an account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/account/participants?accountId="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete participant"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/account/participants?id="]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update participant record"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v3/account/participants?id="]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The central structural change: V2 exposed participant creation and account-participant update as ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["separate named endpoints"]},"; V3 consolidates all five operations onto a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["single path"]}," differentiated by HTTP method, and splits \"update the participant record\" (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},") from \"update the account association\" (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},")."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"72-migration-steps","__idx":38},"children":["7.2 Migration steps"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Update the base URL."]}," Point at ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api3.sprinklr.com/{env}/api/v3"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Collapse your endpoint routing."]}," All five operations now hit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/account/participant"]},"; select behavior with the HTTP method."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Split your write path."]}," Route creates to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},", participant-record edits to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},", and account link/primary changes to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Move identifiers to the query string."]}," Participant IDs travel in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]},", not in the path or body."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Adopt the action enums."]}," Express link and primary changes as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accountLinkAction"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["primaryAction"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SET"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNSET"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Update response parsing."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," returns an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["array"]},"; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," return a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Preserve the create → link ordering."]}," Call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," immediately after ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},", as in V2."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"8-supported-enums","__idx":39},"children":["8. Supported enums"]},{"$$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":"Allowed values"},"children":["Allowed values"]},{"$$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":["accountLinkAction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Link the participant to the account"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNSET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unlink the participant from the account"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["primaryAction"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Mark the participant as primary on the account"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UNSET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Remove primary status"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Values are uppercase."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"9-use-cases","__idx":40},"children":["9. Use cases"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"91-onboard-a-third-party-bot-as-a-participant","__idx":41},"children":["9.1 Onboard a third-party bot as a participant"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scenario:"]}," you are integrating an external bot into the omnichannel handover protocol."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/account/participants"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["imageUrl"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callbackUrl"]},". Capture ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participant.id"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Immediately"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/account/participants?id={participantId}"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"accountId\": <accountId>, \"accountLinkAction\": \"SET\"}"]}," to link it to the social account."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Skipping step 2 leaves an orphan participant that no account can hand over to."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"92-promote-a-participant-to-primary-on-an-account","__idx":42},"children":["9.2 Promote a participant to primary on an account"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request PATCH 'https://api3.sprinklr.com/{env}/api/v3/account/participants?id=6a671fbad316e45725dac06c' \\\n--header 'Authorization: ******' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\"accountId\": 66000000, \"primaryAction\": \"SET\"}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"93-audit-which-participants-are-attached-to-an-account","__idx":43},"children":["9.3 Audit which participants are attached to an account"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/account/participants?accountId=66000000"]}," → returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["participantIds"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/account/participants?id=id1,id2,id3"]}," → hydrates names, images, and callback URLs in a single call."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"94-rebrand-a-participant","__idx":44},"children":["9.4 Rebrand a participant"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetch first, then replace:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/account/participants?id=6a671fbad316e45725dac06c"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Change ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["imageUrl"]}," on the retrieved document, keeping ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["callbackUrl"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v3/account/participants?id=6a671fbad316e45725dac06c"]}," with the merged document."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Do not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," a partial body — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#42-update-a-participant--full-update"},"children":["§4.2"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"95-decommission-a-bot","__idx":45},"children":["9.5 Decommission a bot"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"accountId\": <id>, \"primaryAction\": \"UNSET\"}"]},", then ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"accountId\": <id>, \"accountLinkAction\": \"UNSET\"}"]}," for each linked account."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/account/participants?id={participantId}"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Unlink before deleting so no account is left pointing at a removed primary participant. Whether ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," cascades the unlink automatically is not documented — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#10-questions-for-the-api-owner"},"children":["§10"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"96-clean-up-test-participants-in-bulk","__idx":46},"children":["9.6 Clean up test participants in bulk"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request DELETE 'https://api3.sprinklr.com/{env}/api/v3/account/participants?id=id1,id2,id3,id4' \\\n--header 'Authorization: ******' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," is the only participant operation with bulk support. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," act on a single ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]}]},"headings":[{"value":"Participant API V3 — Developer Guide","id":"participant-api-v3--developer-guide","depth":1},{"value":"1. Overview","id":"1-overview","depth":2},{"value":"1.1 The participant data model","id":"11-the-participant-data-model","depth":3},{"value":"1.2 Addressing a participant","id":"12-addressing-a-participant","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. Write operations","id":"4-write-operations","depth":2},{"value":"4.1 Create a participant","id":"41-create-a-participant","depth":3},{"value":"Request body — Participant","id":"request-body--participant","depth":4},{"value":"Request","id":"request","depth":4},{"value":"Response","id":"response","depth":4},{"value":"4.2 Update a participant — full update","id":"42-update-a-participant--full-update","depth":3},{"value":"Query parameters","id":"query-parameters","depth":4},{"value":"Request body — Participant","id":"request-body--participant-1","depth":4},{"value":"Request","id":"request-1","depth":4},{"value":"Response","id":"response-1","depth":4},{"value":"⚠️ PUT replaces — it does not merge","id":"️-put-replaces--it-does-not-merge","depth":4},{"value":"4.3 Patch participant associations","id":"43-patch-participant-associations","depth":3},{"value":"Query Parameters","id":"query-parameters-1","depth":4},{"value":"Request Body — AccountParticipantPatchRequestDTO","id":"request-body--accountparticipantpatchrequestdto","depth":4},{"value":"Request","id":"request-2","depth":4},{"value":"Response","id":"response-2","depth":4},{"value":"Choosing the right action","id":"choosing-the-right-action","depth":4},{"value":"4.4 Delete participant(s)","id":"44-delete-participants","depth":3},{"value":"Query parameters","id":"query-parameters-2","depth":4},{"value":"Request","id":"request-3","depth":4},{"value":"Response","id":"response-3","depth":4},{"value":"4.5 Method comparison — when to use which","id":"45-method-comparison--when-to-use-which","depth":3},{"value":"5. Read operations","id":"5-read-operations","depth":2},{"value":"5.1 GET /api/v3/account/participants — Fetch participant(s)","id":"51-get-apiv3accountparticipants--fetch-participants","depth":3},{"value":"Mode 1 — Fetch by participant id","id":"mode-1--fetch-by-participant-id","depth":4},{"value":"Mode 2 — List participants on an account","id":"mode-2--list-participants-on-an-account","depth":4},{"value":"Response","id":"response-4","depth":4},{"value":"6. Response format and status codes","id":"6-response-format-and-status-codes","depth":2},{"value":"6.1 Response bodies","id":"61-response-bodies","depth":3},{"value":"6.2 Response codes","id":"62-response-codes","depth":3},{"value":"7. V2 → V3 migration","id":"7-v2--v3-migration","depth":2},{"value":"7.1 Endpoint mapping","id":"71-endpoint-mapping","depth":3},{"value":"7.2 Migration steps","id":"72-migration-steps","depth":3},{"value":"8. Supported enums","id":"8-supported-enums","depth":2},{"value":"9. Use cases","id":"9-use-cases","depth":2},{"value":"9.1 Onboard a third-party bot as a participant","id":"91-onboard-a-third-party-bot-as-a-participant","depth":3},{"value":"9.2 Promote a participant to primary on an account","id":"92-promote-a-participant-to-primary-on-an-account","depth":3},{"value":"9.3 Audit which participants are attached to an account","id":"93-audit-which-participants-are-attached-to-an-account","depth":3},{"value":"9.4 Rebrand a participant","id":"94-rebrand-a-participant","depth":3},{"value":"9.5 Decommission a bot","id":"95-decommission-a-bot","depth":3},{"value":"9.6 Clean up test participants in bulk","id":"96-clean-up-test-participants-in-bulk","depth":3}],"frontmatter":{"seo":{"title":"Participant API V3 — Developer Guide"}},"lastModified":"2026-10-12T04:13:20.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/developer-guides-v3/participant-api-v3-developer-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}