Skip to content

Client API

Create or update a profile from a browser

POSThttps://email.growthdept.ai/client/profiles

Creates or updates the profile named by its identifiers. Answers 202 with no body.

The request body can be up to 5 MB.

Rate limits

Burst: 350/s

Steady: 3500/m

Tier XL. See rate limits for how requests are counted.

Authentication

The account's public key in company_id. No private key and no scopes.

Operation id

create_client_profile The same operation as in Klaviyo's API. OpenAPI document

Query parameters

stringrequired

The account's public key.

Body

Send application/vnd.api+json or application/json.

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      profile
    • idstring

    • attributesobjectrequired

      attributes: 13 fields
      • emailstringcan be null

      • phone_numberstringcan be null

      • external_idstringcan be null

      • first_namestringcan be null

      • last_namestringcan be null

      • organizationstringcan be null

      • localestringcan be null

      • titlestringcan be null

      • imagestringcan be null

      • locationobject

        location: 10 fields
        • address1stringcan be null

        • address2stringcan be null

        • citystringcan be null

        • countrystringcan be null

        • latitudestring or numbercan be null

        • longitudestring or numbercan be null

        • regionstringcan be null

        • zipstringcan be null

        • timezonestringcan be null

        • ipstringcan be null

      • propertiesobject

      • anonymous_idstringcan be null

      • _kxstringcan be null

    • relationshipsobject

    • metaobject

      meta: 2 fields
      • patch_propertiesobject

        patch_properties: 3 fields
        • appendobject

        • unappendobject

        • unsetobject

      • patch_identifiersobject

        patch_identifiers: 2 fields
        • appendobject

        • unappendobject

Edit the example. The code samples use what you type here.

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

202Success

No body.

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject