Skip to content

Profiles API

Merge profiles

POSThttps://email.growthdept.ai/api/profile-merge

The request body can be up to 5 MB.

Rate limits

Burst: 10/s

Steady: 150/m

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

Scopes

profiles:write

Operation id

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

Query parameters

array of strings

Attributes of profile resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

Body

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

object

  • dataobjectrequired

    data: 3 fields
    • typestringrequired

      profile-merge
    • idstringrequired

    • relationshipsobjectrequired

      relationships: 1 field
      • profilesobjectrequired

        profiles: 1 field
        • dataarray of objectsrequired

          data: 2 fields
          • typestringrequired

            profile
          • idstringrequired

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

201Success

Response body

object

  • dataobjectrequired

    data: 3 fields
    • typestringrequired

      profile
    • idstringrequired

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

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