Query EUID | Marketing Automation REST API

Use this API to query the EUID of an existing user by a configured user identifier. This API only reads existing user data. It does not create a user or generate a new EUID when no match is found. The API applies a per-project rate limit of 1,000 requests per minute; exceeding the limit returns HTTP 429 with error code 55110.

Invocation Address

POST /v1/user/euid

Invocation Verification

The EngageLab REST API uses HTTP Basic Authentication. Add the following value to the HTTP header:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

This code block in the floating window

The base64_auth_string is generated as base64(api_key:api_secret).

Request Example

Request Header

> POST /v1/user/euid > Content-Type: application/json > Authorization: Basic ${base64_auth_string}

              
              > POST /v1/user/euid
> Content-Type: application/json
> Authorization: Basic ${base64_auth_string}

This code block in the floating window

Request Body

{ "identity_name": "user_id", "identity_values": ["user-1", "user-2"] }

              
              {
    "identity_name": "user_id",
    "identity_values": ["user-1", "user-2"]
}

This code block in the floating window

Request Parameters

Field	Type	Required	Description
identity_name	String	Yes	Name of a user identifier configured in the project.
identity_values	Array	Yes	Identifier values. Supports 1 to 100 values; each value can contain up to 256 characters.

Response Parameters

Field	Type	Description
code	Int	0 indicates success, including a response containing unmatched values.
message	String	Result description.
data	Array	EUID results in the same order as the requested values.
identity_value	String	The requested identifier value.
euid	Long	The existing EUID, or `null` when no user matches.
error_code	Int	0 for a successful lookup. An unmatched value also returns 0 because no user creation is performed.

Successful Query

{ "code": 0, "message": "success", "data": [ { "identity_value": "user-1", "euid": 10362473, "error_code": 0 }, { "identity_value": "user-not-found", "euid": null, "error_code": 0 } ] }

              
              {
    "code": 0,
    "message": "success",
    "data": [
        {
            "identity_value": "user-1",
            "euid": 10362473,
            "error_code": 0
        },
        {
            "identity_value": "user-not-found",
            "euid": null,
            "error_code": 0
        }
    ]
}

This code block in the floating window

Error Codes

Code	Description
40050	Interface authentication failed.
55004	Business parameters are invalid.
55101	The number of user identifiers exceeds 100.
55105	An identifier value exceeds 256 characters.
55106	The identifier name is not configured in the project.
55107	The identifier name or value is empty.
55110	The request rate limit is exceeded (up to 1,000 requests per minute per project).