You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/endpoints/post-identity-map-v2.md
+10-4Lines changed: 10 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,15 +23,20 @@ This documentation is for version 2 of this endpoint, which is not the latest ve
23
23
If you're using an earlier version, we recommend that you upgrade as soon as possible, to take advantage of improvements. For migration guidance, see [Migration from v2 Identity Map](post-identity-map.md#migration-from-v2-identity-map). For deprecation information, see [Deprecation Schedule: Endpoint Versions](../ref-info/deprecation-schedule.md#endpoint-versions).
24
24
:::
25
25
26
-
## Batch Size and Request Parallelization Requirements
26
+
## Batch Size Requirements
27
27
28
28
Here's what you need to know:
29
29
30
30
- The maximum request size is 1MB.
31
-
- To map a large number of email addresses, phone numbers, or their respective hashes, send them in *sequential* batches with a maximum batch size of 5,000 items per batch.
32
-
- Unless you are using a <Linkhref="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>, do not send batches in parallel. In other words, use a single HTTP connection and send batches of hashed or unhashed <Linkhref="../ref-info/glossary-uid#gl-dii">directly identifying information (DII)</Link> values consecutively, without creating multiple parallel connections.
31
+
- To map a large number of email addresses, phone numbers, or their respective hashes, send them in batches with a maximum of 5,000 items per batch.
33
32
- Be sure to store mappings of email addresses, phone numbers, or their respective hashes.<br/>Not storing mappings could increase processing time drastically when you have to map millions of email addresses or phone numbers. Recalculating only those mappings that actually need to be updated, however, reduces the total processing time because only about 1/365th of raw UID2s need to be updated daily. See also [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) and [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers).
34
33
34
+
## Rate Limiting
35
+
36
+
To ensure fair usage and platform stability, the `POST /identity/map` endpoint enforces rate limits to safeguard against bursts of incoming traffic. If you send many requests in quick succession, you might receive `429` error responses.
37
+
38
+
To handle rate limit errors gracefully, we recommend implementing [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) with random jitter when retrying requests. To maximize throughput within the limit, use the maximum batch size of 5,000 items per request rather than sending many small requests.
39
+
35
40
## Request Format
36
41
37
42
`POST '{environment}/v2/identity/map'`
@@ -203,5 +208,6 @@ The following table lists the `status` property values and their HTTP status cod
203
208
|`success`| 200 | The request was successful. The response will be encrypted. |
204
209
|`client_error`| 400 | The request had missing or invalid parameters.|
205
210
|`unauthorized`| 401 | The request did not include a bearer token, included an invalid bearer token, or included a bearer token unauthorized to perform the requested operation. |
211
+
| N/A | 429 | Too many requests to this endpoint. Wait and retry using exponential backoff. |
206
212
207
-
If the `status` value is anything other than `success`, the `message` field provides additional information about the issue.
213
+
If the `status` value is anything other than `success`, the `message` field provides additional information about the issue. Note: 429 responses do not include a JSON response body.
Copy file name to clipboardExpand all lines: docs/endpoints/post-identity-map.md
+13-3Lines changed: 13 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,15 +23,20 @@ This documentation is for the latest version of this endpoint, version 3.
23
23
24
24
If needed, documentation is also available for the previous version: see [POST /identity/map (v2)](post-identity-map-v2.md).
25
25
26
-
## Batch Size and Request Parallelization Requirements
26
+
## Batch Size Requirements
27
27
28
28
Here's what you need to know:
29
29
30
30
- The maximum request size is 1MB.
31
-
- To map a large number of email addresses, phone numbers, or their respective hashes, send them in *sequential* batches with a maximum batch size of 5,000 items per batch.
32
-
- Unless you are using a <Linkhref="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>, do not send batches in parallel. In other words, use a single HTTP connection and send batches of hashed or unhashed <Linkhref="../ref-info/glossary-uid#gl-dii">directly identifying information (DII)</Link> values consecutively, without creating multiple parallel connections.
31
+
- To map a large number of email addresses, phone numbers, or their respective hashes, send them in batches with a maximum of 5,000 items per batch.
33
32
- Be sure to store mappings of email addresses, phone numbers, or their respective hashes.<br/>Not storing mappings could increase processing time drastically when you have to map millions of email addresses or phone numbers. Recalculating only those mappings that actually need to be updated, however, reduces the total processing time because only about 1/365th of UID2s need to be updated daily. See also [Advertiser/Data Provider Integration Overview](../guides/integration-advertiser-dataprovider-overview.md) and [FAQs for Advertisers and Data Providers](../getting-started/gs-faqs.md#faqs-for-advertisers-and-data-providers).
34
33
34
+
## Rate Limiting
35
+
36
+
To ensure fair usage and platform stability, the `POST /identity/map` endpoint enforces rate limits to safeguard against bursts of incoming traffic. If you send many requests in quick succession, you might receive `429` error responses.
37
+
38
+
To handle rate limit errors gracefully, we recommend implementing [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff) with random jitter when retrying requests. To maximize throughput within the limit, use the maximum batch size of 5,000 items per request rather than sending many small requests.
39
+
35
40
## Request Format
36
41
37
42
`POST '{environment}/v3/identity/map'`
@@ -197,9 +202,14 @@ The following table lists the `status` property values and their HTTP status cod
197
202
|`success`| 200 | The request was successful. The response will be encrypted. |
198
203
|`client_error`| 400 | The request had missing or invalid parameters. |
199
204
|`unauthorized`| 401 | The request did not include a bearer token, included an invalid bearer token, or included a bearer token unauthorized to perform the requested operation. |
205
+
| N/A | 429 | Too many requests to this endpoint. Wait and retry using exponential backoff. |
200
206
201
207
If the `status` value is anything other than `success`, the `message` field provides additional information about the issue.
202
208
209
+
:::note
210
+
429 responses do not include a JSON response body.
211
+
:::
212
+
203
213
## Migration from v2 Identity Map
204
214
205
215
The following sections provide general information and guidance for migrating to version 3 from earlier versions, including:
Copy file name to clipboardExpand all lines: docs/getting-started/gs-faqs.md
-4Lines changed: 0 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -219,10 +219,6 @@ The system should follow the [email normalization rules](gs-normalization-encodi
219
219
220
220
Yes. Not storing mappings might increase processing time drastically when you have to map millions of email addresses or phone numbers. Recalculating only those mappings that actually need to be updated, however, reduces the total processing time because only about 1/365th of raw UID2s need to be updated daily.
221
221
222
-
:::important
223
-
Unless you are using a <Linkhref="../ref-info/glossary-uid#gl-private-operator">Private Operator</Link>, you must map email addresses, phone numbers, or hashes consecutively, using a single HTTP connection, with a maximum batch size of 5,000 items per batch. In other words, do your mapping without creating multiple parallel connections.
224
-
:::
225
-
226
222
#### How should I handle user opt-outs?
227
223
228
224
When a user opts out of UID2-based targeted advertising through the [Transparency and Control Portal](https://www.transparentadvertising.com/), the opt-out signal is sent to DSPs and publishers, who handle opt-outs at bid time. We recommend that advertisers and data providers regularly check whether a user has opted out, via the [POST /identity/map](../endpoints/post-identity-map.md) endpoint.
Copy file name to clipboardExpand all lines: docs/ref-info/updates-doc.md
+17Lines changed: 17 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,23 @@ Use the Tags toolbar to view a subset of documentation updates.
24
24
25
25
The following documents were released in the first quarter of 2026.
26
26
27
+
<CustomTagsContainertags="Endpoints">
28
+
29
+
### Rate Limiting and Parallel Request Updates for POST /identity/map
30
+
31
+
April 1, 2026
32
+
33
+
The [POST /identity/map](../endpoints/post-identity-map.md) endpoint documentation has been updated with the following changes:
34
+
35
+
- Added a new [Rate Limiting](../endpoints/post-identity-map.md#rate-limiting) section documenting that the endpoint enforces rate limits to safeguard against bursts of incoming traffic.
36
+
- Removed the previous recommendation to send batches sequentially over a single HTTP connection.
37
+
38
+
These changes apply to both [v2](../endpoints/post-identity-map-v2.md) and [v3](../endpoints/post-identity-map.md) endpoints.
0 commit comments