Create a profile | Documentation

curl -L \
  -X POST \
  -H 'Content-Type: application/json' \
  'https://experience.ninetailed.co/v2/organizations/{organizationId}/environments/{environmentSlug}/profiles' \
  -d '{"events":[{"channel":"web","context":{"app":{"name":"Ninetailed Analytics SDK","version":"1.0.0"},"library":{"name":"Ninetailed Analytics SDK","version":"1.0.0"},"userAgent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.114 Safari/537.36","campaign":{},"locale":"en-US","page":{"path":"/","query":{"utm_campaign":"example_campaign","utm_content":"example_content"},"referrer":"","search":"?utm_campaign=example_campaign&utm_content=example_content","url":"https://example.com/?utm_campaign=example_campaign&utm_content=example_content"}},"messageId":"abcd1234-efgh-5678-90ab-cdef11122222","type":"page","properties":{"title":"Sample Page","url":"https://example.com/?utm_campaign=example_campaign&utm_content=example_content","path":"/","hash":"","search":"?utm_campaign=example_campaign&utm_content=example_content","width":"1920","height":"1080","query":{"utm_campaign":"example_campaign","utm_content":"example_content"},"referrer":""}}]}'

{
  "data": {
    "profile": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "stableId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "random": 0.42,
      "audiences": [],
      "traits": {},
      "location": {
        "city": "Berlin",
        "region": "Berlin",
        "country": "Germany",
        "countryCode": "DE",
        "continent": "EU",
        "timezone": "Europe/Berlin"
      },
      "session": {
        "id": "sess-1234",
        "isReturningVisitor": false,
        "landingPage": {
          "path": "/",
          "url": "https://example.com/?utm_campaign=example_campaign&utm_content=example_content",
          "query": {
            "utm_campaign": "example_campaign",
            "utm_content": "example_content"
          },
          "referrer": "",
          "search": "?utm_campaign=example_campaign&utm_content=example_content"
        },
        "count": 1,
        "activeSessionLength": 0,
        "averageSessionLength": 0
      }
    },
    "experiences": [
      {
        "experienceId": "exp-1",
        "variantIndex": 0,
        "variants": {
          "entryA": "entryA"
        }
      }
    ],
    "changes": []
  },
  "error": null,
  "message": "ok"
}

Creates or updates a profile and returns it with selected experience variants. The organizationId is the Client ID from Settings → SDK Keys → Optimization.

Path parameters

environmentSlugstringRequiredDefaults to main

The slug of the environment of the profile to retrieve

organizationIdstringRequired

The ID of the organization of the profile to retrieve

Query parameters

localestringOptionalDefaults to en

An ISO 639-1 language code used for experience evaluation.

typeenumOptional

Set to preflight to evaluate experiences without persisting state. Useful for SSR/ESR.

Allowed values:

Request

This endpoint expects an object.

eventslist of objectsOptional

Response

Successful response

Errors

400

Bad Request Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error