{"items":[{"type":"link","label":"Guest API","link":"/cdp/guest-rest-api","routeSlug":"/cdp/guest-rest-api","content":{"contentType":"overview","meta":{"name":"Guest API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/cdp/guest-rest-api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/cdp/guest-rest-api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"description":"Production server AP","url":"https://api-engage-ap.sitecorecloud.io"},{"description":"Production server EU","url":"https://api-engage-eu.sitecorecloud.io"},{"description":"Production server JP","url":"https://api-engage-jpe.sitecorecloud.io"},{"description":"Production server US","url":"https://api-engage-us.sitecorecloud.io"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Guest API (v2.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Guest REST API to create, retrieve, update, and delete guest data in Sitecore CDP."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This REST API lets you interact with:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The guest object. The guest object is the core entity of Sitecore CDP. It stores the personal data of a customer, and all relevant transactional and behavioral data is linked in a guest profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The guest data extension object. A guest data extension is an object that lets you specify any key-value pairs you want. Guest data extensions are optional and enable your organization to capture more robust information about your guests."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After capturing guest information, Sitecore CDP users can:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"View the captured data in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/cdp/en/users/sitecore-cdp/view-a-guest-profile-in-sitecore-cdp.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guest profile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the captured data to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/cdp/en/users/sitecore-cdp/introduction-to-batch-segmentation.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"build segments of guests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/cdp/en/users/sitecore-cdp/audience-export.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Export audience data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to activate audiences outside Sitecore CDP."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this REST API, you must "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/cdp/en/developers/api/authentication-and-authorization.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authenticate"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" your API requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API requests are made in your production environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This reference documentation describes Sitecore CDP functionality for data model 2.1."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/cdp/en/developers/api/index-en.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"official Sitecore CDP developer documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/cdp/guest-rest-api"}],"sectionId":"/cdp/guest-rest-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Guest REST API uses basic authentication."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic authentication involves sending a user name and a password with every request."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To find your user name and password, in Sitecore CDP, on the navigation pane, click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user name is the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The password is the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must include the user name and password in every request you make. For example:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X GET '{baseURL}/v2/guests' \\  \n-u '{YOUR_USERNAME}:{YOUR_PASSWORD}' \\  \n-H 'Accept: application/json'  \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X GET '{baseURL}/v2/guests' \\  \n-u '{YOUR_USERNAME}:{YOUR_PASSWORD}' \\  \n-H 'Accept: application/json'  \n"},"children":[]}]}]}],"sectionId":"/cdp/guest-rest-api/section/authentication"}]}]}},{"type":"link","label":"Authentication","link":"/cdp/guest-rest-api/section/authentication","routeSlug":"/cdp/guest-rest-api/section/authentication","content":null},{"type":"group","label":"Guest","link":"/cdp/guest-rest-api/guest","routeSlug":"/cdp/guest-rest-api/guest","items":[{"label":"Create a guest","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/guest-rest-api/guest/createguest","routeSlug":"/cdp/guest-rest-api/guest/createguest","metadata":{"seo":{"title":"Create a guest","description":"Creates a guest.The REST API does not check whether a guest already exists in Sitecore CDP when you create a guest. To avoid creating duplicates, first retrieve guests by their email address or other identifying information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateGuest","name":"Create a guest","isWebhook":false,"pointer":"/paths/~1v2.1~1guests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a guest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a guest."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The REST API does not check whether a guest already exists in Sitecore CDP when you create a guest. To avoid creating duplicates, first retrieve guests by their email address or other identifying information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key contains the guest reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"guest/createguest/request/find-the-guest-in-sitecore-cdp","deepLinkHash":"/guest/createguest#guest/createguest/request/find-the-guest-in-sitecore-cdp"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Find the guest in Sitecore CDP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also use the guest reference to find data about the guest in Sitecore CDP. In Sitecore CDP, click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and select the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guest type: All"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter. Then, in the search dropdown, select "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guest reference"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then enter the guest reference in the search field. Then, Sitecore CDP lists the guest profile for the guest."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestCreate"}},"schemaId":"components/schemas/GuestCreate","pointer":"/paths/~1v2.1~1guests/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2.1/guests","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GuestCreate"}},"responseCodes":["201","400","401"],"pointer":"/v2.1/guests","href":"guest/createguest","openApiOperationId":"CreateGuest","summary":"Create a guest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/GuestCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Resource successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestCreateResponse"}},"schemaId":"components/schemas/GuestCreateResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestBadRequestResponse"}},"schemaId":"components/schemas/GuestBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1guests/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/GuestCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestCreateResponse"}}},{"code":"400","schemaId":"components/schemas/GuestBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest/createguest"}],"panels":[]}]},"httpPath":"/v2.1/guests"},{"label":"Retrieve guests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/guest-rest-api/guest/retrieveguests","routeSlug":"/cdp/guest-rest-api/guest/retrieveguests","metadata":{"seo":{"title":"Retrieve guests","description":"Retrieves a maximum of 100 of the most recent guests. We recommend that you retrieve guests by their email address or other identifying information using query parameters before you create a guest. This lets you check if a certain guest already exists in Sitecore CDP. If the guest exists, avoid creating duplicates. Instead, update the existing guest."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveGuests","name":"Retrieve guests","isWebhook":false,"pointer":"/paths/~1v2.1~1guests/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve guests","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a maximum of 100 of the most recent guests. We recommend that you retrieve guests by their email address or other identifying information using query parameters before you create a guest. This lets you check if a certain guest already exists in Sitecore CDP. If the guest exists, avoid creating duplicates. Instead, update the existing guest."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"guest/retrieveguests/request/query-parameters","deepLinkHash":"/guest/retrieveguests#guest/retrieveguests/request/query-parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use the following query parameters to retrieve guests by exact match, using some of the following identifying information:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderReferenceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderRef"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifiers.provider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" plus "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifiers.id"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alternatively, you can use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to retrieve guests with all their key-value pairs listed."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"guest/retrieveguests/request/examples","deepLinkHash":"/guest/retrieveguests#guest/retrieveguests/request/examples"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here's an example of how to use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to retrieve guests by their email address:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{baseURL}/v2.1/guests?email=john.doe@gmail.com\""},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here's an example of how to use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifiers.provider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifiers.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters to retrieve guests by their identifiers:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{baseURL}/v2.1/guests?identifiers.provider=ProfileSystem&identifiers.id=B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41\""},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If any of this returns a guest, avoid creating another guest with the same identifying information. Instead, update the existing guest."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"guest/retrieveguests/request/guest-reference","deepLinkHash":"/guest/retrieveguests#guest/retrieveguests/request/guest-reference"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guest reference"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items.href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the guest reference is the string that follows the final slash&:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\\\"href\\\": \\\"{baseURL}/v2.1/guests/{guestRef}\" "},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example guest reference: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the guest reference to interact with the full guest record, for example, to retrieve or update it."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also use the guest reference to find data about the guest in Sitecore CDP. In Sitecore CDP, click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, enter the guest reference, then click the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guest type: All"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter. Then, Sitecore CDP lists the guest profile for the guest."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_840"},{"name":"limit","in":"query","schemaId":"schema_841"},{"name":"expand","in":"query","schemaId":"schema_842"},{"name":"sort","in":"query","schemaId":"schema_843"}],"pointer":"/paths/~1v2.1~1guests/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/guests","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","example":10,"schemaId":"components/schemas/Offset"},{"name":"limit","in":"query","example":40,"schemaId":"components/schemas/Limit"},{"name":"expand","in":"query","example":true,"schemaId":"components/schemas/Expand"},{"name":"sort","in":"query","example":"createdAt::ASC|label::DESC'","schemaId":"schema_843"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v2.1/guests","href":"guest/retrieveguests","openApiOperationId":"RetrieveGuests","summary":"Retrieve guests"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveGuestsResponse"}},"schemaId":"components/schemas/RetrieveGuestsResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1guests/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RetrieveGuestsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveGuestsResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest/retrieveguests"}],"panels":[]}]},"httpPath":"/v2.1/guests"},{"label":"Retrieve a guest","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/guest-rest-api/guest/retrieveguest","routeSlug":"/cdp/guest-rest-api/guest/retrieveguest","metadata":{"seo":{"title":"Retrieve a guest","description":"Retrieves the full guest record of a guest, including any guest data extensions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveGuest","name":"Retrieve a guest","isWebhook":false,"pointer":"/paths/~1v2.1~1guests~1{guestRef}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a guest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the full guest record of a guest, including any guest data extensions."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guestRef","in":"path","schemaId":"schema_844","required":true}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_845"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/guests/{guestRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"guestRef","in":"path","required":true,"example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03","schemaId":"schema_844"}],"query":[{"name":"expand","in":"query","example":true,"schemaId":"schema_845"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v2.1/guests/{guestRef}","href":"guest/retrieveguest","openApiOperationId":"RetrieveGuest","summary":"Retrieve a guest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestCreateResponse"}},"schemaId":"components/schemas/GuestCreateResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestNotFoundResponse"}},"schemaId":"components/schemas/GuestNotFoundResponse"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuestCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestCreateResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/GuestNotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestNotFoundResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest/retrieveguest"}],"panels":[]}]},"httpPath":"/v2.1/guests/{guestRef}"},{"label":"Update a guest","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/guest-rest-api/guest/putguest","routeSlug":"/cdp/guest-rest-api/guest/putguest","metadata":{"seo":{"title":"Update a guest","description":"Fully updates a guest, replacing the entire resource including all the key-value pairs with the data you send in the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutGuest","name":"Update a guest","isWebhook":false,"pointer":"/paths/~1v2.1~1guests~1{guestRef}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a guest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fully updates a guest, replacing the entire resource including all the key-value pairs with the data you send in the request.\n\nTo update certain key-value pairs only, use the Partially update a guest endpoint instead."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guestRef","in":"path","schemaId":"schema_844","required":true}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestUpdateRequest"}},"schemaId":"components/schemas/GuestUpdateRequest","pointer":"/paths/~1v2.1~1guests~1{guestRef}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2.1/guests/{guestRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"guestRef","in":"path","required":true,"example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03","schemaId":"schema_844"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GuestUpdateRequest"}},"responseCodes":["200","400","401"],"pointer":"/v2.1/guests/{guestRef}","href":"guest/putguest","openApiOperationId":"PutGuest","summary":"Update a guest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/GuestUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestCreateResponse"}},"schemaId":"components/schemas/GuestCreateResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestBadRequestResponse"}},"schemaId":"components/schemas/GuestBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuestCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestCreateResponse"}}},{"code":"400","schemaId":"components/schemas/GuestBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest/putguest"}],"panels":[]}]},"httpPath":"/v2.1/guests/{guestRef}"},{"label":"Partially update a guest","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/guest-rest-api/guest/updateguests","routeSlug":"/cdp/guest-rest-api/guest/updateguests","metadata":{"seo":{"title":"Partially update a guest","description":"Partially updates a guest, replacing only those fields in the resource that you provide in the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateGuests","name":"Partially update a guest","isWebhook":false,"pointer":"/paths/~1v2.1~1guests~1{guestRef}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update a guest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates a guest, replacing only those fields in the resource that you provide in the request.\n\n For example, you can use this request to update the guest's array of phone numbers when they enter a new one."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guestRef","in":"path","schemaId":"schema_844","required":true}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestPartialUpdateRequest"}},"schemaId":"components/schemas/GuestPartialUpdateRequest","pointer":"/paths/~1v2.1~1guests~1{guestRef}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2.1/guests/{guestRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"guestRef","in":"path","required":true,"example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03","schemaId":"schema_844"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GuestPartialUpdateRequest"}},"responseCodes":["200","400","401"],"pointer":"/v2.1/guests/{guestRef}","href":"guest/updateguests","openApiOperationId":"UpdateGuests","summary":"Partially update a guest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/GuestPartialUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestPartialUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestCreateResponse"}},"schemaId":"components/schemas/GuestCreateResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestBadRequestResponse"}},"schemaId":"components/schemas/GuestBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuestCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestCreateResponse"}}},{"code":"400","schemaId":"components/schemas/GuestBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest/updateguests"}],"panels":[]}]},"httpPath":"/v2.1/guests/{guestRef}"},{"label":"Delete a guest","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/guest-rest-api/guest/deleteguest","routeSlug":"/cdp/guest-rest-api/guest/deleteguest","metadata":{"seo":{"title":"Delete a guest","description":"Deletes a guest record and all entities associated with the guestincluding orders, sessions, and events. This is an irreversibleoperation. After you delete a guest record, you cannot retrieve theguest record or any related entities."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteGuest","name":"Delete a guest","isWebhook":false,"pointer":"/paths/~1v2.1~1guests~1{guestRef}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a guest","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a guest record and all entities associated with the guest"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"including orders, sessions, and events. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is an irreversible"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operation. After you delete a guest record, you cannot retrieve the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"guest record or any related entities."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guestRef","in":"path","schemaId":"schema_844","required":true}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2.1/guests/{guestRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"guestRef","in":"path","required":true,"example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03","schemaId":"schema_844"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","404"],"pointer":"/v2.1/guests/{guestRef}","href":"guest/deleteguest","openApiOperationId":"DeleteGuest","summary":"Delete a guest"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"404","description":"Resource not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestNotFoundResponse"}},"schemaId":"components/schemas/GuestNotFoundResponse"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"404","schemaId":"components/schemas/GuestNotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestNotFoundResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest/deleteguest"}],"panels":[]}]},"httpPath":"/v2.1/guests/{guestRef}"}],"content":{"contentType":"group","meta":{"name":"Guest"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Guest","showPageActions":true},{"nodeType":"markdoc","content":"The guest object is the core entity of Sitecore CDP. It stores the personal data of a customer, and all relevant transactional and behavioral data is linked in a guest profile.\n\n To get started with this API, create a guest then find it in Sitecore CDP."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2.1/guests","summary":"Create a guest","prefix":{"name":"post","color":"post"},"badges":[],"link":"/guest/createguest","deprecated":false},{"title":"/v2.1/guests","summary":"Retrieve guests","prefix":{"name":"get","color":"get"},"badges":[],"link":"/guest/retrieveguests","deprecated":false},{"title":"/v2.1/guests/{guestRef}","summary":"Retrieve a guest","prefix":{"name":"get","color":"get"},"badges":[],"link":"/guest/retrieveguest","deprecated":false},{"title":"/v2.1/guests/{guestRef}","summary":"Update a guest","prefix":{"name":"put","color":"put"},"badges":[],"link":"/guest/putguest","deprecated":false},{"title":"/v2.1/guests/{guestRef}","summary":"Partially update a guest","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/guest/updateguests","deprecated":false},{"title":"/v2.1/guests/{guestRef}","summary":"Delete a guest","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/guest/deleteguest","deprecated":false}]}]}]}]}},{"type":"group","label":"Guest data extension","link":"/cdp/guest-rest-api/guest-data-extension","routeSlug":"/cdp/guest-rest-api/guest-data-extension","items":[{"label":"Create a data extension","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/guest-rest-api/guest-data-extension/createguestdataextension","routeSlug":"/cdp/guest-rest-api/guest-data-extension/createguestdataextension","metadata":{"seo":{"title":"Create a data extension","description":"Creates a data extension for a guest. You can create up to six data extensions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateGuestDataExtension","name":"Create a data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a data extension for a guest. You can create up to six data extensions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To avoid creating key-value pairs in a data extension that already exist within a guest profile, first retrieve a guest's collection of data extensions to check that the keys you intend to create are unique."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"guest-data-extension/createguestdataextension/request/creating-the-request-body","deepLinkHash":"/guest-data-extension/createguestdataextension#guest-data-extension/createguestdataextension/request/creating-the-request-body"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating the request body"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the request body, you must provide one object. This object represents the data extension. Note the following about the object:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can contain primitive values only. You cannot nest objects. If you need to group key-value pairs, use prefixes for the key names."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can contain a maximum of 100 key-value pairs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must contain the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key. This is the name of the data extension."},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you send extension data from one source, set the value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you send extension data from multiple sources, you can create up to six data extensions by setting the value for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to one of the following: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The other key-value pairs you include in the object become the extension data. For example, if you include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"loyaltyTier\": \"level2\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the object, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Loyalty Tier"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes extension data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported data types for the values:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"level2\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"floating-point number, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"99.9"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"guest-data-extension/createguestdataextension/request/naming-keys","deepLinkHash":"/guest-data-extension/createguestdataextension#guest-data-extension/createguestdataextension/request/naming-keys"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Naming keys"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The keys you enter in the request body must be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphanumeric [A-Z,a-z,0-9] as per the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc7159"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON RFC 7159"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In camel case."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique across all data extensions within a guest profile. For example, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vipMember"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key, you must not use that key in any other data extensions for the same guest."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"guest-data-extension/createguestdataextension/request/example-request-body","deepLinkHash":"/guest-data-extension/createguestdataextension#guest-data-extension/createguestdataextension/request/example-request-body"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example request body"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here's an example request body:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n\"name\": \"ext\",\n\"vipMember\": true,\n\"loyaltyTier\": \"level2\",\n\"rewardBalance\": 5012.25,\n\"loyaltyNumber\": 3452\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n\"name\": \"ext\",\n\"vipMember\": true,\n\"loyaltyTier\": \"level2\",\n\"rewardBalance\": 5012.25,\n\"loyaltyNumber\": 3452\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This creates four key-value pairs in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data extension for the guest."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"guest-data-extension/createguestdataextension/request/finding-the-data-in-sitecore-cdp","deepLinkHash":"/guest-data-extension/createguestdataextension#guest-data-extension/createguestdataextension/request/finding-the-data-in-sitecore-cdp"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finding the data in Sitecore CDP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can find the created data in Sitecore CDP by clicking "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > the guest profile you created the data for > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Properties"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data displays in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data extension group"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data displays in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data extension group 1"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data displays in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data extension group 2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data displays in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data extension group 3"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data displays in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data extension group 4"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data displays in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Data extension group 5"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"guest-data-extension/createguestdataextension/request/multiple-sources","deepLinkHash":"/guest-data-extension/createguestdataextension#guest-data-extension/createguestdataextension/request/multiple-sources"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Multiple sources"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can send extension data from multiple sources. For example, your organization might want to send extension data both from a loyalty system to capture loyalty data, and from a Customer Relationship Management (CRM) system to capture email preferences, alternative mailing addresses, and so on."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To send data from multiple sources, we recommend that you use a different data extension name for each source system. For example, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data extension for the loyalty system data, and use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" data extension for the CRM data."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guestRef","in":"path","schemaId":"schema_844","required":true}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionCreateRequest"}},"schemaId":"components/schemas/GuestDataExtensionCreateRequest","pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2.1/guests/{guestRef}/extensions","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"guestRef","in":"path","required":true,"example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03","schemaId":"schema_844"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionCreateRequest"}},"responseCodes":["201","400","409"],"pointer":"/v2.1/guests/{guestRef}/extensions","href":"guest-data-extension/createguestdataextension","openApiOperationId":"CreateGuestDataExtension","summary":"Create a data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/GuestDataExtensionCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionResponse"}},"schemaId":"components/schemas/GuestDataExtensionResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionBadRequestResponse"}},"schemaId":"components/schemas/GuestDataExtensionBadRequestResponse"},{"code":"409","description":"Conflict request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionConflictResponse"}},"schemaId":"components/schemas/GuestDataExtensionConflictResponse"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/GuestDataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionResponse"}}},{"code":"400","schemaId":"components/schemas/GuestDataExtensionBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionBadRequestResponse"}}},{"code":"409","schemaId":"components/schemas/GuestDataExtensionConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest-data-extension/createguestdataextension"}],"panels":[]}]},"httpPath":"/v2.1/guests/{guestRef}/extensions"},{"label":"Retrieve a guest's collection of data extensions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/guest-rest-api/guest-data-extension/retrieveguestdataextensions","routeSlug":"/cdp/guest-rest-api/guest-data-extension/retrieveguestdataextensions","metadata":{"seo":{"title":"Retrieve a guest's collection of data extensions","description":"Retrieves the URLs for each of the guest's data extensions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveGuestDataExtensions","name":"Retrieve a guest's collection of data extensions","isWebhook":false,"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a guest's collection of data extensions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the URLs for each of the guest's data extensions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We recommend that you retrieve the URLs using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to check that the keys you intend to create when you Create a data extension are unique. This is because keys must be unique across all data extensions within a guest profile."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, each URL in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items.href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" corresponds to one data extension. Use this URL to interact with the guest's data extension, for example, to retrieve or update it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guestRef","in":"path","schemaId":"schema_844","required":true}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_840"},{"name":"limit","in":"query","schemaId":"schema_841"},{"name":"expand","in":"query","schemaId":"schema_842"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/guests/{guestRef}/extensions","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"guestRef","in":"path","required":true,"example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03","schemaId":"schema_844"}],"query":[{"name":"offset","in":"query","example":10,"schemaId":"components/schemas/Offset"},{"name":"limit","in":"query","example":40,"schemaId":"components/schemas/Limit"},{"name":"expand","in":"query","example":true,"schemaId":"components/schemas/Expand"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2.1/guests/{guestRef}/extensions","href":"guest-data-extension/retrieveguestdataextensions","openApiOperationId":"RetrieveGuestDataExtensions","summary":"Retrieve a guest's collection of data extensions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveDataGuestExtensionsResponse"}},"schemaId":"components/schemas/RetrieveDataGuestExtensionsResponse"},{"code":"404","description":"Guest data extension not found.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionNotFoundResponse"}},"schemaId":"components/schemas/GuestDataExtensionNotFoundResponse"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RetrieveDataGuestExtensionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveDataGuestExtensionsResponse"}}},{"code":"404","schemaId":"components/schemas/GuestDataExtensionNotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionNotFoundResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest-data-extension/retrieveguestdataextensions"}],"panels":[]}]},"httpPath":"/v2.1/guests/{guestRef}/extensions"},{"label":"Retrieve a data extension","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/guest-rest-api/guest-data-extension/retrieveguestdataextension","routeSlug":"/cdp/guest-rest-api/guest-data-extension/retrieveguestdataextension","metadata":{"seo":{"title":"Retrieve a data extension","description":"Retrieves a data extension for a guest."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveGuestDataExtension","name":"Retrieve a data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a data extension for a guest."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guestRef","in":"path","schemaId":"schema_844","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_846","required":true}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_845"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"guestRef","in":"path","required":true,"example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03","schemaId":"schema_844"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext1","schemaId":"schema_846"}],"query":[{"name":"expand","in":"query","example":true,"schemaId":"schema_845"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}","href":"guest-data-extension/retrieveguestdataextension","openApiOperationId":"retrieveGuestDataExtension","summary":"Retrieve a data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionResponse"}},"schemaId":"components/schemas/GuestDataExtensionResponse"},{"code":"404","description":"Guest data extension not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestNotFoundResponse"}},"schemaId":"components/schemas/GuestNotFoundResponse"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuestDataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionResponse"}}},{"code":"404","schemaId":"components/schemas/GuestNotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestNotFoundResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest-data-extension/retrieveguestdataextension"}],"panels":[]}]},"httpPath":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}"},{"label":"Update a data extension","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/guest-rest-api/guest-data-extension/putguestdataextension","routeSlug":"/cdp/guest-rest-api/guest-data-extension/putguestdataextension","metadata":{"seo":{"title":"Update a data extension","description":"Fully updates a data extension for a guest, replacing the entire resource including all the key-value pairs with the data you send in the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutGuestDataExtension","name":"Update a data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fully updates a data extension for a guest, replacing the entire resource including all the key-value pairs with the data you send in the request.\n\nTo update certain key-value pairs only, use the Partially update a data extension endpoint instead."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guestRef","in":"path","schemaId":"schema_844","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_847","required":true}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionRequest"}},"schemaId":"components/schemas/GuestDataExtensionRequest","pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"guestRef","in":"path","required":true,"example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03","schemaId":"schema_844"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext","schemaId":"schema_847"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionRequest"}},"responseCodes":["200","400"],"pointer":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}","href":"guest-data-extension/putguestdataextension","openApiOperationId":"PutGuestDataExtension","summary":"Update a data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/GuestDataExtensionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionResponse"}},"schemaId":"components/schemas/GuestDataExtensionResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionUpdateBadRequestResponse"}},"schemaId":"components/schemas/GuestDataExtensionUpdateBadRequestResponse"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuestDataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionResponse"}}},{"code":"400","schemaId":"components/schemas/GuestDataExtensionUpdateBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionUpdateBadRequestResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest-data-extension/putguestdataextension"}],"panels":[]}]},"httpPath":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}"},{"label":"Partially update a data extension","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/guest-rest-api/guest-data-extension/updateguestdataextension","routeSlug":"/cdp/guest-rest-api/guest-data-extension/updateguestdataextension","metadata":{"seo":{"title":"Partially update a data extension","description":"Partially updates a data extension for a guest, replacing only those key-value pairs in the resource that you provide in the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateGuestDataExtension","name":"Partially update a data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update a data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates a data extension for a guest, replacing only those key-value pairs in the resource that you provide in the request.\n\nIf multiple source systems use the same data extension, use this endpoint to safely update the key-value pairs from a specific source system without accidentally overwriting the key-value pairs from other source systems."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guestRef","in":"path","schemaId":"schema_844","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_846","required":true}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionPatchRequest"}},"schemaId":"components/schemas/GuestDataExtensionPatchRequest","pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"guestRef","in":"path","required":true,"example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03","schemaId":"schema_844"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext1","schemaId":"schema_846"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionPatchRequest"}},"responseCodes":["200","400"],"pointer":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}","href":"guest-data-extension/updateguestdataextension","openApiOperationId":"UpdateGuestDataExtension","summary":"Partially update a data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/GuestDataExtensionPatchRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionPatchRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionResponse"}},"schemaId":"components/schemas/GuestDataExtensionResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionUpdateBadRequestResponse"}},"schemaId":"components/schemas/GuestDataExtensionUpdateBadRequestResponse"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuestDataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionResponse"}}},{"code":"400","schemaId":"components/schemas/GuestDataExtensionUpdateBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionUpdateBadRequestResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest-data-extension/updateguestdataextension"}],"panels":[]}]},"httpPath":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}"},{"label":"Delete a data extension","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/guest-rest-api/guest-data-extension/deleteguestdataextension","routeSlug":"/cdp/guest-rest-api/guest-data-extension/deleteguestdataextension","metadata":{"seo":{"title":"Delete a data extension","description":"Deletes the data extension for a guest, including all the key-value pairs in the data extension."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteGuestDataExtension","name":"Delete a data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the data extension for a guest, including all the key-value pairs in the data extension.\n\nTo delete certain key-value pairs only, use the Delete key-value pairs from a data extension endpoint instead."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guestRef","in":"path","schemaId":"schema_844","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_846","required":true}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"guestRef","in":"path","required":true,"example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03","schemaId":"schema_844"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext1","schemaId":"schema_846"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}","href":"guest-data-extension/deleteguestdataextension","openApiOperationId":"DeleteGuestDataExtension","summary":"Delete a data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"404","description":"Guest data extension not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestNotFoundResponse"}},"schemaId":"components/schemas/GuestNotFoundResponse"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"404","schemaId":"components/schemas/GuestNotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestNotFoundResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest-data-extension/deleteguestdataextension"}],"panels":[]}]},"httpPath":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}"},{"label":"Delete key-value pairs from a data extension","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/guest-rest-api/guest-data-extension/deleteguestdataextensionfields","routeSlug":"/cdp/guest-rest-api/guest-data-extension/deleteguestdataextensionfields","metadata":{"seo":{"title":"Delete key-value pairs from a data extension","description":"Deletes the key-value pairs you provide in the name query parameter from a data extension for a guest."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGuestDataExtensionFields","name":"Delete key-value pairs from a data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}~1fields/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete key-value pairs from a data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the key-value pairs you provide in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter from a data extension for a guest."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if your data extension contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vipMember"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"loyaltyMember"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys, you can delete both keys and their values by making the following request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{baseURL}/v2.1/guests/{guestRef}/extensions/{dataExtensionName}/fields?name=vipMember|loyaltyMember"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you don't provide the query parameter, this operation will empty the data extension: the data extension itself will not be deleted, but all the key-value pairs in it will."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"guestRef","in":"path","schemaId":"schema_844","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_846","required":true}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}~1fields/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_848"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}~1fields/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}/fields","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"guestRef","in":"path","required":true,"example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03","schemaId":"schema_844"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext1","schemaId":"schema_846"}],"query":[{"name":"name","in":"query","example":"vipMember|loyaltyTier","schemaId":"schema_848"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}/fields","href":"guest-data-extension/deleteguestdataextensionfields","openApiOperationId":"deleteGuestDataExtensionFields","summary":"Delete key-value pairs from a data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionResponse"}},"schemaId":"components/schemas/GuestDataExtensionResponse"}],"pointer":"/paths/~1v2.1~1guests~1{guestRef}~1extensions~1{dataExtensionName}~1fields/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GuestDataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GuestDataExtensionResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/guest-data-extension/deleteguestdataextensionfields"}],"panels":[]}]},"httpPath":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}/fields"}],"content":{"contentType":"group","meta":{"name":"Guest data extension"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Guest data extension","showPageActions":true},{"nodeType":"markdoc","content":"A guest data extension is an object that lets you specify any key-value pairs you want. Guest data extensions are optional and enable your organization to capture more robust information about your guests.\n\n To get started with this API, create a data extension for the guest you previously created, then find the data in Sitecore CDP in the guest profile."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2.1/guests/{guestRef}/extensions","summary":"Create a data extension","prefix":{"name":"post","color":"post"},"badges":[],"link":"/guest-data-extension/createguestdataextension","deprecated":false},{"title":"/v2.1/guests/{guestRef}/extensions","summary":"Retrieve a guest's collection of data extensions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/guest-data-extension/retrieveguestdataextensions","deprecated":false},{"title":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}","summary":"Retrieve a data extension","prefix":{"name":"get","color":"get"},"badges":[],"link":"/guest-data-extension/retrieveguestdataextension","deprecated":false},{"title":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}","summary":"Update a data extension","prefix":{"name":"put","color":"put"},"badges":[],"link":"/guest-data-extension/putguestdataextension","deprecated":false},{"title":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}","summary":"Partially update a data extension","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/guest-data-extension/updateguestdataextension","deprecated":false},{"title":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}","summary":"Delete a data extension","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/guest-data-extension/deleteguestdataextension","deprecated":false},{"title":"/v2.1/guests/{guestRef}/extensions/{dataExtensionName}/fields","summary":"Delete key-value pairs from a data extension","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/guest-data-extension/deleteguestdataextensionfields","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CollectionResourceGuestDataExtension":{"id":"components/schemas/CollectionResourceGuestDataExtension","kind":"json-schema","title":"CollectionResourceGuestDataExtension","data":{"type":"object","properties":{"first":{"$ref":"#/components/schemas/Link"},"href":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/GuestDataExtension"}},"last":{"$ref":"#/components/schemas/Link"},"limit":{"type":"integer","format":"int32"},"next":{"$ref":"#/components/schemas/Link"},"nextOffset":{},"offset":{},"prev":{"$ref":"#/components/schemas/Link"}}}},"components/schemas/CollectionResourceLink":{"id":"components/schemas/CollectionResourceLink","kind":"json-schema","title":"CollectionResourceLink","data":{"type":"object","properties":{"first":{"$ref":"#/components/schemas/Link"},"href":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"last":{"$ref":"#/components/schemas/Link"},"limit":{"type":"integer","format":"int32"},"next":{"$ref":"#/components/schemas/Link"},"nextOffset":{},"offset":{},"prev":{"$ref":"#/components/schemas/Link"}}}},"components/schemas/Expand":{"id":"components/schemas/Expand","kind":"json-schema","title":"Expand","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can expand items in a collection by setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This eliminates the need to send multiple follow-up requests (one for the collection and another for each of its items). This also helps you check if the data you intend to create already exists."},"children":[]}]}]}],"example":true,"items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can expand items in a collection by setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This eliminates the need to send multiple follow-up requests (one for the collection and another for each of its items). This also helps you check if the data you intend to create already exists."},"children":[]}]}]}],"example":"true"},"properties":{"empty":{"type":"boolean"}}}},"components/schemas/Fields":{"id":"components/schemas/Fields","kind":"json-schema","title":"Fields","data":{"type":"array","description":"The fields in the data extension object that you want to delete.","example":"vipMember|loyaltyTier","items":{"type":"string","description":"The fields in the data extension object that you want to delete.","example":"vipMember|loyaltyTier"},"properties":{"empty":{"type":"boolean"}}}},"components/schemas/First":{"id":"components/schemas/First","kind":"json-schema","title":"First","data":{"type":"object","description":"The request's first list of guests URL.","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/guests?offset=0&limit=10"}}}},"components/schemas/Guest":{"id":"components/schemas/Guest","kind":"json-schema","title":"Guest","data":{"type":"object","description":"The guest object.","properties":{"city":{"type":"string","format":"title case","description":"The guest's city.\n\nExample values: \"Dublin\", \"London\", \"Madrid\", \"Paris\"\n","example":"Dublin"},"country":{"type":"string","format":"2-letter ISO 3166-1 Alpha-2 country code","description":"The guest's country.\n\nExample values: \"IE\", \"GB\", \"ES\", \"FR\"","example":"IE"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the resource was created in Sitecore CDP.\n","example":"2024-01-01T16:17:16.000Z"},"dataExtensions":{"$ref":"#/components/schemas/CollectionResourceGuestDataExtension","description":"The Guest's data extensions"},"dateOfBirth":{"type":"string","format":"date-time","description":"The guest's date of birth. Validation: Date must be in the past.\n","example":"1991-01-01T16:17:16.000Z"},"email":{"type":"string","deprecated":true},"emails":{"type":"array","description":"All the email addresses of the guest.\n","example":["john.doe@gmail.com"],"items":{"type":"string"},"maxItems":1,"minItems":0},"firstName":{"type":"string","format":"title case","description":"The guest's first name.","example":"John"},"firstSeen":{"type":"string","format":"date-time","description":"The first seen date for the guest.\n","example":"2024-01-01T16:17:16.000Z"},"gender":{"type":"string","format":"lowercase","description":"The guest's gender.\n\nExample values: \"male\", \"female\", \"unknown\"\n","example":"male"},"guestType":{"type":"string","format":"lowercase","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The level of identity obtained. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"traveller\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only applicable to certain industries."},"children":[]}]}]}],"enum":["visitor","customer","traveller"],"example":"visitor"},"href":{"type":"string"},"identifiers":{"type":"array","description":"A list of identifiers for the guest.\n","items":{"$ref":"#/components/schemas/Identifier"}},"identityStatus":{"type":"string","deprecated":true},"language":{"type":"string","format":"2-letter ISO 639 language code","description":"The preferred language of the guest.\n\nExample values: \"EN\", \"FR\", \"DE\"\n","example":"EN"},"lastName":{"type":"string","format":"title case recommended","description":"The guest's last name.","example":"Doe"},"lastSeen":{"type":"string","format":"date-time","description":"The last time the guest interacted with your brand. If the guest is currently online and is interacting with your brand, this returns the date and timestamp of when the current session started.\n","example":"2024-01-01T16:17:16.000Z"},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time when the resource was updated in Sitecore CDP.\n","example":"2024-01-01T16:17:16.000Z"},"nationality":{"type":"string","format":"title case","description":"The guest's nationality.\n\nExample values: \"Irish\", \"British\", \"Spanish\", \"French\"\n","example":"Irish"},"passportExpiry":{"type":"string","format":"date-time","description":"The expiry date of the guest's passport.\n","example":"2025-01-01T00:00:00.000Z"},"passportNumber":{"type":"string","format":"uppercase","description":"The passport number of the guest.\n","example":"PZ4A9565"},"phoneNumbers":{"type":"array","description":"The phone numbers of the guest.\n","example":["+353161123345","+353161123346"],"items":{"type":"string"}},"postCode":{"type":"string","format":"uppercase","description":"The guest's postcode.\n","example":"D2"},"ref":{"type":"string"},"state":{"type":"string","format":"title case","description":"The state (address) of the guest.\n","example":"Oregon"},"street":{"type":"array","format":"title case strings","description":"The street address of the guest.\n","example":["Ashford House","Tara Street","Dublin 2"],"items":{"type":"string"}},"subscriptions":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/GuestSubscription"},"maxItems":0,"minItems":0},"title":{"type":"string","format":"title case","description":"The title of the guest.\n\nExample values: \"Br\", \"Brigadier\", \"Capt\", \"Colonel\", \"Dame\", \"Dr\", \"Elder\", \"Fr\", \"General\", \"Hon\", \"Judge\", \"Lord\", \"Master\", \"Miss\", \"Mr\", \"Mrs\", \"Ms\", \"Mstr\", \"Prof\", \"Rabbi\", \"Rev\", \"Shaikha\", \"Sheikh\", \"Sir\", \"Sister\", \"Sr\"\n","example":"Mr"},"zipCode":{"type":"string","deprecated":true}},"required":["guestType"]}},"components/schemas/GuestBadRequestResponse":{"id":"components/schemas/GuestBadRequestResponse","kind":"json-schema","title":"GuestBadRequestResponse","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32","description":"The HTTP response status code.","example":400},"developerMessage":{"type":"string","description":"Error description for developers.","example":"Attribute guestType is invalid (not a valid value)."},"message":{"type":"string","description":"Error description.","example":"guestType: not a valid value"},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"https://support.sitecore.com"},"status":{"type":"integer","format":"int32","description":"The HTTP request status.","example":400}}}},"components/schemas/GuestCreate":{"id":"components/schemas/GuestCreate","kind":"json-schema","title":"GuestCreate","data":{"type":"object","properties":{"city":{"type":"string","format":"title case","description":"The guest's city.\n\nExample values: \"Dublin\", \"London\", \"Madrid\", \"Paris\"\n","example":"Dublin"},"country":{"type":"string","format":"2-letter ISO 3166-1 Alpha-2 country code","description":"The guest's country.\n\nExample values: \"IE\", \"GB\", \"ES\", \"FR\"","example":"IE"},"dateOfBirth":{"type":"string","format":"date-time","description":"The guest's date of birth. Validation: Date must be in the past.\n","example":"1991-01-01T16:17:16.000Z"},"email":{"type":"string","description":"The email address of the guest.\n","example":"john.doe@gmail.com"},"emails":{"type":"array","description":"All the email addresses of the guest.\n","example":["john.doe@gmail.com"],"items":{"type":"string"}},"firstName":{"type":"string","format":"title case","description":"The guest's first name.","example":"John"},"gender":{"type":"string","format":"lowercase","description":"The guest's gender.\n\nExample values: \"male\", \"female\", \"unknown\"\n","example":"male"},"guestType":{"type":"string","format":"lowercase","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The level of identity obtained. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"traveller\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only applicable to certain industries."},"children":[]}]}]}],"enum":["visitor","customer","traveller"],"example":"visitor"},"href":{"type":"string","description":"The URL of the guest.\n","example":"https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"},"identifiers":{"type":"array","description":"A list of identifiers for the guest.\n","items":{"$ref":"#/components/schemas/Identifier"}},"lastName":{"type":"string","format":"title case recommended","description":"The guest's last name.","example":"Doe"},"nationality":{"type":"string","format":"title case","description":"The guest's nationality.\n\nExample values: \"Irish\", \"British\", \"Spanish\", \"French\"\n","example":"Irish"},"passportExpiry":{"type":"string","format":"date-time","description":"The expiry date of the guest's passport.\n","example":"2025-01-01T00:00:00.000Z"},"passportNumber":{"type":"string","format":"uppercase","description":"The passport number of the guest.\n","example":"PZ4A9565"},"phoneNumbers":{"type":"array","description":"The phone numbers of the guest.\n","example":["+353161123345","+353161123346"],"items":{"type":"string"}},"postCode":{"type":"string","format":"uppercase","description":"The guest's zipcode.\n","example":"D2"},"ref":{"type":"string","description":"The Guest's reference.\n","example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03"},"state":{"type":"string","format":"title case","description":"The state (address) of the guest.\n","example":"Oregon"},"street":{"type":"array","format":"title case strings","description":"The street address of the guest.\n","example":["Ashford House","Tara Street","Dublin 2"],"items":{"type":"string"}},"title":{"type":"string","format":"title case","description":"The title of the guest.\n\nExample values: \"Br\", \"Brigadier\", \"Capt\", \"Colonel\", \"Dame\", \"Dr\", \"Elder\", \"Fr\", \"General\", \"Hon\", \"Judge\", \"Lord\", \"Master\", \"Miss\", \"Mr\", \"Mrs\", \"Ms\", \"Mstr\", \"Prof\", \"Rabbi\", \"Rev\", \"Shaikha\", \"Sheikh\", \"Sir\", \"Sister\", \"Sr\"\n","example":"Mr"}},"required":["guestType"]}},"components/schemas/GuestCreateResponse":{"id":"components/schemas/GuestCreateResponse","kind":"json-schema","title":"GuestCreateResponse","data":{"type":"object","properties":{"city":{"type":"string","format":"title case","description":"The guest's city.\n\nExample values: \"Dublin\", \"London\", \"Madrid\", \"Paris\"\n","example":"Dublin"},"country":{"type":"string","format":"2-letter ISO 3166-1 Alpha-2 country code","description":"The guest's country.\n\nExample values: \"IE\", \"GB\", \"ES\", \"FR\"","example":"IE"},"createdAt":{"type":"string","format":"date-time","description":"The date and time when the resource was created in Sitecore CDP.\n","example":"2024-01-01T16:17:16.000Z"},"dateOfBirth":{"type":"string","format":"date-time","description":"The guest's date of birth. Validation: Date must be in the past.\n","example":"1991-01-01T16:17:16.000Z"},"email":{"type":"string","description":"The email address of the guest.\n","example":"john.doe@gmail.com"},"emails":{"type":"array","description":"All the email addresses of the guest.\n","example":["john.doe@gmail.com"],"items":{"type":"string"}},"firstName":{"type":"string","format":"title case","description":"The guest's first name.","example":"John"},"firstSeen":{"type":"string","format":"date-time","description":"The first seen date for the guest.\n","example":"2024-01-01T16:17:16.000Z"},"gender":{"type":"string","format":"lowercase","description":"The guest's gender.\n\nExample values: \"male\", \"female\", \"unknown\"\n","example":"male"},"guestType":{"type":"string","format":"lowercase","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The level of identity obtained. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"traveller\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only applicable to certain industries."},"children":[]}]}]}],"enum":["visitor","customer","traveller"],"example":"visitor"},"href":{"type":"string","description":"The URL of the guest.\n","example":"https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"},"identifiers":{"type":"array","description":"A list of identifiers for the guest.\n","items":{"$ref":"#/components/schemas/Identifier"}},"lastName":{"type":"string","format":"title case recommended","description":"The guest's last name.","example":"Doe"},"lastSeen":{"type":"string","format":"date-time","description":"The last time the guest interacted with your brand. If the guest is currently online and is interacting with your brand, this returns the date and timestamp of when the current session started.\n","example":"2024-01-01T16:17:16.000Z"},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time when the resource was updated in Sitecore CDP.\n","example":"2024-01-01T16:17:16.000Z"},"nationality":{"type":"string","format":"title case","description":"The guest's nationality.\n\nExample values: \"Irish\", \"British\", \"Spanish\", \"French\"\n","example":"Irish"},"passportExpiry":{"type":"string","format":"date-time","description":"The expiry date of the guest's passport.\n","example":"2025-01-01T00:00:00.000Z"},"passportNumber":{"type":"string","format":"uppercase","description":"The passport number of the guest.\n","example":"PZ4A9565"},"phoneNumbers":{"type":"array","description":"The phone numbers of the guest.\n","example":["+353161123345","+353161123346"],"items":{"type":"string"}},"postCode":{"type":"string","format":"uppercase","description":"The guest's zipcode.\n","example":"D2"},"ref":{"type":"string","description":"The Guest's reference.\n","example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03"},"state":{"type":"string","format":"title case","description":"The state (address) of the guest.\n","example":"Oregon"},"street":{"type":"array","format":"title case strings","description":"The street address of the guest.\n","example":["Ashford House","Tara Street","Dublin 2"],"items":{"type":"string"}},"title":{"type":"string","format":"title case","description":"The title of the guest.\n\nExample values: \"Br\", \"Brigadier\", \"Capt\", \"Colonel\", \"Dame\", \"Dr\", \"Elder\", \"Fr\", \"General\", \"Hon\", \"Judge\", \"Lord\", \"Master\", \"Miss\", \"Mr\", \"Mrs\", \"Ms\", \"Mstr\", \"Prof\", \"Rabbi\", \"Rev\", \"Shaikha\", \"Sheikh\", \"Sir\", \"Sister\", \"Sr\"\n","example":"Mr"}}}},"components/schemas/GuestDataExtension":{"id":"components/schemas/GuestDataExtension","kind":"json-schema","title":"GuestDataExtension","data":{"type":"object","description":"The data extension object.","properties":{"createdAt":{"type":"string","format":"date-time","description":"The date and time when the resource was created in Sitecore CDP.","example":"2024-01-01T16:17:16.000Z"},"href":{"type":"string"},"key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must set this to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"default"},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time when the resource was last updated in Sitecore CDP.","example":"2024-01-01T16:17:16.000Z"},"ref":{"type":"string"}},"required":["key","name"]}},"components/schemas/GuestDataExtensionBadRequestResponse":{"id":"components/schemas/GuestDataExtensionBadRequestResponse","kind":"json-schema","title":"GuestDataExtensionBadRequestResponse","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32","description":"The HTTP response status code.","example":400},"developerMessage":{"type":"string","description":"Error description for developers.","example":"Attribute name is invalid (value must be one of ext,ext1,ext2,ext3,ext4,ext5)."},"message":{"type":"string","description":"Error description.","example":"name: value must be one of ext,ext1,ext2,ext3,ext4,ext5"},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"https://support.sitecore.com"},"status":{"type":"integer","format":"int32","description":"The HTTP request status.","example":400}}}},"components/schemas/GuestDataExtensionConflictResponse":{"id":"components/schemas/GuestDataExtensionConflictResponse","kind":"json-schema","title":"GuestDataExtensionConflictResponse","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32","description":"The HTTP response status code.","example":409},"developerMessage":{"type":"string","description":"Error description for developers.","example":409},"message":{"type":"string","description":"Error description.","example":"Data extension ext1 already exists."},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"https://support.sitecore.com"},"status":{"type":"integer","format":"int32","description":"The HTTP request status.","example":409}}}},"components/schemas/GuestDataExtensionCreateRequest":{"id":"components/schemas/GuestDataExtensionCreateRequest","kind":"json-schema","title":"GuestDataExtensionCreateRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the data extension.","enum":["ext","ext1","ext2","ext3","ext4","ext5"],"example":"ext1"},"{exampleKey1}":{"type":["string","boolean","integer","number"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key-value pair of your choice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"vipMember\": true"},"children":[]}]}]}],"example":"{exampleValue1}"},"{exampleKey2}":{"type":["string","boolean","integer","number"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key-value pair of your choice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"loyaltyTier\": \"level2\""},"children":[]}]}]}],"example":"{exampleValue2}"}},"required":["name"]}},"components/schemas/GuestDataExtensionNotFoundResponse":{"id":"components/schemas/GuestDataExtensionNotFoundResponse","kind":"json-schema","title":"GuestDataExtensionNotFoundResponse","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32","description":"The HTTP response status code.","example":404},"developerMessage":{"type":"string","description":"Error description for developers.","example":"Data extension ext2 for Guest ref ea9b4612-3488-47d9-beea-17404876f5d6 and client key {...} was not found for v2.1"},"message":{"type":"string","description":"Error description.","example":"The specified resource does not exist."},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"https://support.sitecore.com"},"status":{"type":"integer","format":"int32","description":"The HTTP request status.","example":404}}}},"components/schemas/GuestDataExtensionPatchRequest":{"id":"components/schemas/GuestDataExtensionPatchRequest","kind":"json-schema","title":"GuestDataExtensionPatchRequest","data":{"type":"object","properties":{"{exampleKey1}":{"type":["string","boolean","integer","number"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key-value pair of your choice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: `\"vipMember\": true``"},"children":[]}]}]}],"example":"{exampleValue1}"}}}},"components/schemas/GuestDataExtensionRequest":{"id":"components/schemas/GuestDataExtensionRequest","kind":"json-schema","title":"GuestDataExtensionRequest","data":{"type":"object","properties":{"{exampleKey1}":{"type":["string","boolean","integer","number"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key-value pair of your choice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"vipMember\": true"},"children":[]}]}]}],"example":"{exampleValue1}"},"{exampleKey2}":{"type":["string","boolean","integer","number"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key-value pair of your choice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"loyaltyTier\": \"level2\""},"children":[]}]}]}],"example":"{exampleValue2}"}}}},"components/schemas/GuestDataExtensionResponse":{"id":"components/schemas/GuestDataExtensionResponse","kind":"json-schema","title":"GuestDataExtensionResponse","data":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","description":"The date and time when the resource was created in Sitecore CDP.","example":"2024-01-01T16:17:16.000Z"},"guest":{"$ref":"#/components/schemas/GuestHref"},"href":{"type":"string","description":"The URL of the guest extension.\n","example":"https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03/ext1"},"key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must set this to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"default"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"default"},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time when the resource was last updated in Sitecore CDP.","example":"2024-01-01T16:17:16.000Z"},"name":{"type":"string","description":"The name of the data extension. You can only use a name once in a collection.","example":"ext"},"ref":{"type":"string","description":"Guest extension reference.\n","example":"6a5cb3c2-1a4a-56d8-8a01-1ede232b9db2"},"{exampleKey1}":{"type":["string","boolean","integer","number"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key-value pair in the data extension."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"vipMember\": true"},"children":[]}]}]}],"example":"{exampleValue1}"},"{exampleKey2}":{"type":["string","boolean","integer","number"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key-value pair in the data extension."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"loyaltyTier\": \"level2\""},"children":[]}]}]}],"example":"{exampleValue2}"}}}},"components/schemas/GuestDataExtensionUpdateBadRequestResponse":{"id":"components/schemas/GuestDataExtensionUpdateBadRequestResponse","kind":"json-schema","title":"GuestDataExtensionUpdateBadRequestResponse","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32","description":"The HTTP response status code.","example":400},"developerMessage":{"type":"string","description":"Error description for developers.","example":"JSON parse error [line: 7, column: 6]."},"message":{"type":"string","description":"Error description.","example":"Unable to parse JSON string"},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"https://support.sitecore.com"},"status":{"type":"integer","format":"int32","description":"The HTTP request status.","example":400}}}},"components/schemas/GuestExtensionLink":{"id":"components/schemas/GuestExtensionLink","kind":"json-schema","title":"GuestExtensionLink","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/guests/c6cf690f-8384-4734-ab2d-6caa53b6308c/extensions/ext"}}}},"components/schemas/GuestHref":{"id":"components/schemas/GuestHref","kind":"json-schema","title":"GuestHref","data":{"type":"object","properties":{"href":{"type":"string","description":"The URL of the guest.","example":"https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"}}}},"components/schemas/GuestLink":{"id":"components/schemas/GuestLink","kind":"json-schema","title":"GuestLink","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/guests/c6cf690f-8384-4734-ab2d-6caa53b6308c"}}}},"components/schemas/GuestNotFoundResponse":{"id":"components/schemas/GuestNotFoundResponse","kind":"json-schema","title":"GuestNotFoundResponse","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32","description":"The HTTP response status code.","example":404},"developerMessage":{"type":"string","description":"Error description for developers.","example":"Guest with ref f7aabbca-1c1b-4fc2-be72-3e16294a4f03a for client key {...} was not found"},"message":{"type":"string","description":"Error description.","example":"The specified resource does not exist."},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"https://support.sitecore.com"},"status":{"type":"integer","format":"int32","description":"The HTTP request status.","example":404}}}},"components/schemas/GuestPartialUpdateRequest":{"id":"components/schemas/GuestPartialUpdateRequest","kind":"json-schema","title":"GuestPartialUpdateRequest","data":{"type":"object","properties":{"guestType":{"type":"string","format":"lowercase","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The level of identity obtained. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"traveller\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only applicable to certain industries."},"children":[]}]}]}],"enum":["visitor","customer","traveller"],"example":"visitor"},"phoneNumbers":{"type":"array","description":"The phone numbers of the guest.\n","example":["+353161123345","+353161123346"],"items":{"type":"string"}}},"required":["guestType"]}},"components/schemas/GuestSubscription":{"id":"components/schemas/GuestSubscription","kind":"json-schema","title":"GuestSubscription","data":{"type":"object","properties":{"channel":{"type":"string","description":"The channel the guest used to subscribe.","example":"WEB"},"effectiveDate":{"type":"string","format":"date-time","description":"The date the subscription is effective from.","example":"2024-01-01T16:17:16.000Z"},"name":{"type":"string","description":"The subscription name.","example":"newsletter_subscription"},"pointOfSale":{"type":"string","description":"The point of sale the guest used to subscribe.","example":"myRetailsite/ireland"},"status":{"type":"string","description":"The subscription status.","enum":["UNKNOWN","PENDING","SUBSCRIBED","UNSUBSCRIBED"],"example":"SUBSCRIBED"}},"required":["channel","name","pointOfSale","status"]}},"components/schemas/GuestUpdateRequest":{"id":"components/schemas/GuestUpdateRequest","kind":"json-schema","title":"GuestUpdateRequest","data":{"type":"object","properties":{"city":{"type":"string","format":"title case","description":"The guest's city.\n\nExample values: \"Dublin\", \"London\", \"Madrid\", \"Paris\"\n","example":"Dublin"},"country":{"type":"string","format":"2-letter ISO 3166-1 Alpha-2 country code","description":"The guest's country.\n\nExample values: \"IE\", \"GB\", \"ES\", \"FR\"","example":"IE"},"dateOfBirth":{"type":"string","format":"date-time","description":"The guest's date of birth. Validation: Date must be in the past.\n","example":"1991-01-01T16:17:16.000Z"},"emails":{"type":"array","description":"All the email addresses of the guest.\n","example":["john.doe@gmail.com"],"items":{"type":"string"}},"firstName":{"type":"string","format":"title case","description":"The guest's first name.","example":"John"},"gender":{"type":"string","format":"lowercase","description":"The guest's gender.\n\nExample values: \"male\", \"female\", \"unknown\"\n","example":"male"},"guestType":{"type":"string","format":"lowercase","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The level of identity obtained. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"traveller\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is only applicable to certain industries."},"children":[]}]}]}],"enum":["visitor","customer","traveller"],"example":"visitor"},"identifiers":{"type":"array","description":"A list of identifiers for the guest.\n","items":{"$ref":"#/components/schemas/Identifier"}},"lastName":{"type":"string","format":"title case recommended","description":"The guest's last name.","example":"Doe"},"nationality":{"type":"string","format":"title case","description":"The guest's nationality.\n\nExample values: \"Irish\", \"British\", \"Spanish\", \"French\"\n","example":"Irish"},"passportExpiry":{"type":"string","format":"date-time","description":"The expiry date of the guest's passport.\n","example":"2025-01-01T00:00:00.000Z"},"passportNumber":{"type":"string","format":"uppercase","description":"The passport number of the guest.\n","example":"PZ4A9565"},"phoneNumbers":{"type":"array","description":"The phone numberss of the guest.\n","example":["+353161123345","+353161123346"],"items":{"type":"string","description":"The phone numberss of the guest.\n","example":"[\"+353161123345\",\"+353161123346\"]"}},"postCode":{"type":"string","format":"uppercase","description":"The guest's postcode.\n","example":"D2"},"state":{"type":"string","format":"title case","description":"The state (address) of the guest.\n","example":"Oregon"},"street":{"type":"array","format":"title case strings","description":"The street address of the guest.\n","example":["Ashford House","Tara Street","Dublin 2"],"items":{"type":"string"}},"title":{"type":"string","format":"title case","description":"The title of the guest.\n\nExample values: \"Br\", \"Brigadier\", \"Capt\", \"Colonel\", \"Dame\", \"Dr\", \"Elder\", \"Fr\", \"General\", \"Hon\", \"Judge\", \"Lord\", \"Master\", \"Miss\", \"Mr\", \"Mrs\", \"Ms\", \"Mstr\", \"Prof\", \"Rabbi\", \"Rev\", \"Shaikha\", \"Sheikh\", \"Sir\", \"Sister\", \"Sr\"\n","example":"Mr"}}}},"components/schemas/Identifier":{"id":"components/schemas/Identifier","kind":"json-schema","title":"Identifier","data":{"type":"object","description":"A list of identifiers for the guest.","properties":{"expiryDate":{"type":"string","format":"date-time","description":"The expiry date of the identifier.","example":"2025-01-01T16:17:16.000Z"},"id":{"type":"string","description":"The identifier ID.","example":"B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41"},"provider":{"type":"string","description":"The identifier provider.","example":"ProfileSystem"}},"required":["id","provider"]}},"components/schemas/Limit":{"id":"components/schemas/Limit","kind":"json-schema","title":"Limit","data":{"type":"object","default":10,"description":"Collection responses use offset pagination. This query parameter lets you adjust the maximum number of collection items to return for a single request.\n","example":40,"maximum":100,"minimum":10}},"components/schemas/Link":{"id":"components/schemas/Link","kind":"json-schema","title":"Link","data":{"type":"object","properties":{"href":{"type":"string"}}}},"components/schemas/Next":{"id":"components/schemas/Next","kind":"json-schema","title":"Next","data":{"type":"object","description":"The request's next list of guests URL.","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/guests?offset=0&limit=10"}}}},"components/schemas/Offset":{"id":"components/schemas/Offset","kind":"json-schema","title":"Offset","data":{"type":"object","default":0,"description":"Collection responses use offset pagination. The offset query parameter is used to exclude from a response the first N items of the entire resource collection.","example":10}},"components/schemas/RetrieveDataGuestExtensionsResponse":{"id":"components/schemas/RetrieveDataGuestExtensionsResponse","kind":"json-schema","title":"RetrieveDataGuestExtensionsResponse","data":{"type":"object","properties":{"href":{"type":"string","description":"Request's URL.","example":"https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03/extensions?offset=0&limit=10"},"items":{"type":"array","items":{"$ref":"#/components/schemas/GuestExtensionLink"}},"limit":{"type":"integer","format":"int32","description":"Request's limit.","example":10},"offset":{"type":"integer","format":"int32","description":"Request's offset.","example":0}}}},"components/schemas/RetrieveGuestsResponse":{"id":"components/schemas/RetrieveGuestsResponse","kind":"json-schema","title":"RetrieveGuestsResponse","data":{"type":"object","properties":{"First":{"$ref":"#/components/schemas/First","description":"The request's first list of guests URL."},"Next":{"$ref":"#/components/schemas/Next","description":"The request's next list of guests URL."},"href":{"type":"string","description":"The request's URL.","example":"https://api-engage-eu.sitecorecloud.io/v2.1/guests?offset=0&limit=10"},"items":{"type":"array","items":{"$ref":"#/components/schemas/GuestLink"}},"limit":{"type":"integer","format":"int32","description":"The request's limit.","example":10},"offset":{"type":"integer","format":"int32","description":"The request's offset.","example":0}}}},"components/schemas/UnauthorizedResponse":{"id":"components/schemas/UnauthorizedResponse","kind":"json-schema","title":"UnauthorizedResponse","data":{"type":"object","properties":{"code":{"type":"integer","format":"int32","description":"The HTTP response status code.","example":401},"message":{"type":"string","description":"Error description.","example":"Authentication credentials are required to access the resource. All requests must be authenticated."},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"https://support.sitecore.com"},"status":{"type":"string","format":"uppercase","description":"The HTTP request status.","example":"UNAUTHORIZED"}}}},"schema_840":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Offset","default":"0"},"id":"schema_840"},"schema_841":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Limit","default":"10"},"id":"schema_841"},"schema_842":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Expand","default":"false"},"id":"schema_842"},"schema_843":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can sort search results by specifying a sort query parameter and a corresponding sort value ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ASC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DESC"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" case sensitive) on a collection resource URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The example query parameter shows how to return a resource in ascending chronological order of when the resource was created and descending order of the resource label."},"children":[]}]}]}],"example":"createdAt::ASC|label::DESC'"},"id":"schema_843"},"schema_844":{"kind":"json-schema","data":{"type":"string","description":"The guest reference. This is a unique identifier of the guest record. If you don't know the guest reference, first retrieve guests.","example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03"},"id":"schema_844"},"schema_845":{"kind":"json-schema","data":{"type":"array","default":"","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can expand items in a collection by setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This eliminates the need to send multiple follow-up requests (one for the collection and another for each of its items). This also helps you check if the data you intend to create already exists."},"children":[]}]}]}],"example":true,"items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can expand items in a collection by setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This eliminates the need to send multiple follow-up requests (one for the collection and another for each of its items). This also helps you check if the data you intend to create already exists."},"children":[]}]}]}],"example":"true"},"properties":{"empty":{"type":"boolean"}}},"id":"schema_845"},"schema_846":{"kind":"json-schema","data":{"type":"string","description":"The name of the data extension. If you don't know this value, first retrieve the guest's collection of data extensions.","enum":["ext","ext1","ext2","ext3","ext4","ext5"],"example":"ext1"},"id":"schema_846"},"schema_847":{"kind":"json-schema","data":{"type":"string","description":"The name of the data extension. If you don't know this value, first retrieve the guest's collection of data extensions.","enum":["ext","ext1","ext2","ext3","ext4","ext5"],"example":"ext"},"id":"schema_847"},"schema_848":{"kind":"json-schema","data":{"type":"array","default":"","description":"The fields in the data extension object that you want to delete.","example":"vipMember|loyaltyTier","items":{"type":"string","description":"The fields in the data extension object that you want to delete.","example":"vipMember|loyaltyTier"},"properties":{"empty":{"type":"boolean"}}},"id":"schema_848"}},"exampleStore":{},"securitySchemeStore":{"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"},"BearerToken":{"id":"BearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"specType":"openapi"},"options":{"hideInfoMetadata":true,"sanitize":true,"sortRequiredPropsFirst":true,"corsProxyUrl":"https://cors.redoc.ly","mockServer":{"off":true,"position":"off"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/cdp/guest-rest-api/index.json?download"},{"url":"/_bundle/cdp/guest-rest-api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Guest API","description":"Use the Guest REST API to create, retrieve, update, and delete guest data in Sitecore CDP.\n\nThis REST API lets you interact with:\n   - The guest object. The guest object is the core entity of Sitecore CDP. It stores the personal data of a customer, and all relevant transactional and behavioral data is linked in a guest profile.\n   - The guest data extension object. A guest data extension is an object that lets you specify any key-value pairs you want. Guest data extensions are optional and enable your organization to capture more robust information about your guests.\n\nAfter capturing guest information, Sitecore CDP users can:\n   - View the captured data in the [guest profile](https://doc.sitecore.com/cdp/en/users/sitecore-cdp/view-a-guest-profile-in-sitecore-cdp.html).\n   - Use the captured data to [build segments of guests](https://doc.sitecore.com/cdp/en/users/sitecore-cdp/introduction-to-batch-segmentation.html).\n   - [Export audience data](https://doc.sitecore.com/cdp/en/users/sitecore-cdp/audience-export.html) to activate audiences outside Sitecore CDP.\n\nNote the following:\n   - To use this REST API, you must [authenticate](https://doc.sitecore.com/cdp/en/developers/api/authentication-and-authorization.html) your API requests.\n   - All API requests are made in your production environment.\n   - This reference documentation describes Sitecore CDP functionality for data model 2.1.\n\n For more information, see the [official Sitecore CDP developer documentation](https://doc.sitecore.com/cdp/en/developers/api/index-en.html).\n## Authentication \nThe Guest REST API uses basic authentication.  \nBasic authentication involves sending a user name and a password with every request.  \nTo find your user name and password, in Sitecore CDP, on the navigation pane, click **Settings** > **API access**:  \n - The user name is the **Client key**.  \n- The password is the **API token**.  \nYou must include the user name and password in every request you make. For example:  \n```  \ncurl -X GET '{baseURL}/v2/guests' \\  \n-u '{YOUR_USERNAME}:{YOUR_PASSWORD}' \\  \n-H 'Accept: application/json'  \n","product":"CDP"}},"baseSlug":"/cdp/guest-rest-api","routesMapping":{}}