> For the complete documentation index, see [llms.txt](https://docs.coda.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.coda.co/codashop-and-distribution/integration-guides/usersync-api-request.md).

# UserSync API Request

Overview

The UserSync API is the backbone of Coda’s [**Personalized Sales**](https://docs.coda.co/codashop-and-distribution/personalized-sales.md) feature. It is triggered when a user logs into the shop or submits their game/user ID. The API performs two key functions:

* **User Verification & Enrichment:** It verifies the user and retrieves key identity details such as their in‑app nickname, ensuring the experience is personal and familiar.&#x20;
* **Data Synchronization:** It synchronizes in‑app user activity, purchase history, and segmentation data with Coda, enabling both pre‑defined and dynamic personalized sales.&#x20;

By leveraging the UserSync API, partners can effortlessly align their in‑app personalization logic with out‑of‑app sales channels, leading to enhanced user engagement, improved conversion rates, and ultimately increased revenue.

The expected response time for a UserSync API request is 3 seconds.

<figure><img src="https://611292228-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fl56STCN5yoV1K1MhVEvU%2Fuploads%2FB8RJgRxFiNY2UtTCIB1e%2Fgamer%20id1.png?alt=media&amp;token=03d74bd3-3c7d-49ac-98a9-82b0968b68d4" alt=""><figcaption><p>User Verify Request</p></figcaption></figure>

<figure><img src="https://611292228-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fl56STCN5yoV1K1MhVEvU%2Fuploads%2FKOZ4MHodtErtpmGrMq17%2Fgamer%20id2.png?alt=media&amp;token=f7562e5c-fbe2-465f-bea1-b6cf971fc019" alt=""><figcaption><p>User Verify Response</p></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.coda.co/codashop-and-distribution/integration-guides/usersync-api-request.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
