Skip to content

Client API

Subscribe to back-in-stock alerts from a browser

POSThttps://email.growthdept.ai/client/back-in-stock-subscriptions

As POST /api/back-in-stock-subscriptions, by public key. The profile is required.

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_back_in_stock_subscription 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: 3 fields
    • typestringrequired

      back-in-stock-subscription
    • attributesobjectrequired

      attributes: 2 fields
      • channelsarray of stringsrequired

      • profileobjectrequired

        profile: 1 field
        • dataobjectrequired

          data: 3 fields
          • typestringrequired

            profile
          • idstring

          • attributesobjectrequired

            attributes: 3 fields
            • emailstringcan be null

            • phone_numberstringcan be null

            • external_idstringcan be null

    • relationshipsobjectrequired

      relationships: 1 field
      • variantobjectrequired

        variant: 1 field
        • dataobjectrequired

          data: 2 fields
          • typestringrequired

            catalog-variant
          • 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

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