POST
/
api
/
public
/
apps
/
identify
curl --request POST \
  --url http://localhost:3001/api/public/apps/identify \
  --header 'Content-Type: application/json' \
  --header 'PublicWriteKey: <api-key>' \
  --header 'authorization: <authorization>' \
  --data '{
  "messageId": "23d04926-78e5-4ebc-853f-f26c84ff629e",
  "timestamp": "2024-04-22T07:00:00.000Z",
  "context": {
    "ip": "192.0.2.1"
  },
  "traits": {
    "name": "Michael Scott",
    "items": [
      {
        "id": 1,
        "name": "Paper"
      },
      {
        "id": 2,
        "name": "Stapler"
      }
    ]
  },
  "userId": "1043"
}'
"<string>"

The following is an example of an identify body.

example body
{
  "userId": "532",
  "traits": {
    "email": "[email protected]"
  },
  "messageId": "6f5f436d-8534-4070-8023-d18f8b78ed39"
}

Authorizations

​
PublicWriteKey
string
header
required

Authorization header for the request, in the format Bearer <token>. Find your token at https://app.dittofeed.com/dashboard/settings#write-key.

Headers

​
authorization
string
required

Authorization header for the request, in the format Bearer <token>. Find your token at https://app.dittofeed.com/dashboard/settings#write-key.

Body

application/json
​
messageId
string
required

Unique identifier for the message, used as an idempotency key for safe retries. Can provide a UUID.

Examples:

"23d04926-78e5-4ebc-853f-f26c84ff629e"

​
userId
string
required

Unique identifier for the user. Should be the id of the user in your system. Only applicable to logged in users.

Examples:

"1043"

"user-123"

"0a58e5e4-c753-477e-a6c4-f9b0e3396b9b"

​
timestamp
string

ISO 8601 formatted timestamp of when the event occurred. If not provided, the current server time will be used.

Examples:

"2024-04-22T07:00:00.000Z"

​
context
object

Provides metadata about the user submitting the event and the context in which the event occurred.

Examples:
{ "ip": "192.0.2.1" }
​
traits
object

Free-form dictionary of traits of the user, like email or name. Can contain arbitrary JSON values.

Examples:
{
  "name": "Michael Scott",
  "items": [
    { "id": 1, "name": "Paper" },
    { "id": 2, "name": "Stapler" }
  ]
}

Response

204
application/json

An empty String