API DocsKnowledge BaseSystem StatusContact SupportContact Sales
API Documentation

Set Custom Properties

post
https://e-{networkId}.adzerk.net/udb/{networkId}/custom

With this you can tie Custom Properties to a specific UserKey using key/value pairs. For instance, {"Key":"Value"} could be {"favoriteColor": "blue"}. Note that each call to set custom properties will replace any existing custom properties.

❗️

The max size of a custom data object in a UserDB record is 8 KB.

❗️

We recommend using either camelCase or snake_case custom property keys as these work well with Zerkel. However kebab-case should be avoided. Also, symbol prefixes (like $, %, :, etc.) should not be used.

👍

Note that the user key supplied in the user object will override a user key set via the azk cookie.

Path Params
int32
required

Your account (network) ID

Query Params
string

Appends one or more key/value pairs to be shipped to UserDB logs. In the format ?property:Key1=Value&property:Key2=Value etc.

integer

Optional. Sets the user's incrementality group (1–100) as part of this request; use group=null to clear it, or omit to leave it unchanged. Invalid values reject the entire request.

Body Params
string
required

This is a JSON object that can be anything since it's custom data. For instance, {"favoriteColor": "blue"}.

Response

Updated 6 days ago

Language
URL
LoadingLoading…
Response
Choose an example:
text/plain

Updated 6 days ago