Skip to content

Automations

21 operations. Authenticate with your secret API key (see Authentication); failures use the shape described in Errors. Example requests read $GIEP_API_URL, your deployment’s API host.

Tracked link from a message (redirect)

GET/public/r/{token}

Signed per message and link. Marks the message clicked (first click only) and answers 302 to the URL recorded when the message was sent; it never redirects anywhere else. Unknown or tampered links answer 404.

Authentication
None (public route)
Permission
Not stated
Idempotency-Key
Not used
Success
200

Path parameters

  • tokenstringrequired

Responses

  • 200Success
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X GET "$GIEP_API_URL/public/r/string"
// JSON object. The OpenAPI document does not list its fields.

Unsubscribe from marketing messages (signed link from the message; POST only)

POST/public/unsubscribe/{token}

Writes a withdrawn marketing consent record for the channel of that message and counts the unsubscribe on that message. Unknown or tampered links answer 404.

Authentication
None (public route)
Permission
Not stated
Idempotency-Key
Not used
Success
200

Path parameters

  • tokenstringrequired

Responses

  • 200Success
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X POST "$GIEP_API_URL/public/unsubscribe/string"
// JSON object. The OpenAPI document does not list its fields.

Automation rules with run statistics

GET/v1/automations

Every rule with its status, trigger, activeVersion (the number of the active version, null for a draft that was never activated) and counts of runs, completed and failed.

Authentication
API key (Bearer)
Permission
customer:read
Idempotency-Key
Not used
Success
200

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X GET "$GIEP_API_URL/v1/automations" \
  -H "Authorization: Bearer $GIEP_API_KEY"
// JSON object. The OpenAPI document does not list its fields.

Create a rule: WHEN event IF conditions THEN actions (draft version 1)

POST/v1/automations

Conditions use the same evaluator as segments over event.* fields, aggregate.status (the live status of the event's checkout session, payment, order or subscription) and customer facts. Actions: send_message (optional couponCode: an active discount code, {{coupon}}), wait, notify_merchant, add_tag, send_card_update_link, webhook (endpointId of one of your webhook endpoints; signed with its secret, sent at most once) and pause_routing_suggestion (a notice to your team; routing is never changed); no money-moving action exists. exitConditions (optional) are re-checked before every step and end the run when they hold (journeys). Audited.

Authentication
API key (Bearer)
Permission
automation:manage
Idempotency-Key
Required
Success
201

Headers

  • Idempotency-Keystringrequired

    Required with an API key (SELL-033): 8-255 characters of A-Z a-z 0-9 _ - : . The same key with the same request returns the stored response without running it again; with a different request 422 idempotency_key_reused; while the first is still running 409 request_in_progress. Signed-in workspace sessions may omit it.

    min 8 chars · max 255 chars · pattern ^[A-Za-z0-9_:.-]+$

Request body · application/jsonrequired

  • namestringrequired
    min 1 chars · max 80 chars
  • triggerstringrequired
    pattern ^[a-z_]+\.[a-z_]+$
  • conditionsone ofrequirednullable
    4 variants (one of)

    Option 1

    • allarray<one of>required
      max 50 items
      4 variants (one of)

      Option 1

      • allarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 2

      • anyarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 3

      • notone ofrequired

      Option 4

      • factstringrequired
        min 1 chars · max 40 chars
      • opstringrequired
        One ofeqneqgtgteltlteinnincontainsexists
      • valueone of

    Option 2

    • anyarray<one of>required
      max 50 items
      4 variants (one of)

      Option 1

      • allarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 2

      • anyarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 3

      • notone ofrequired

      Option 4

      • factstringrequired
        min 1 chars · max 40 chars
      • opstringrequired
        One ofeqneqgtgteltlteinnincontainsexists
      • valueone of

    Option 3

    • notone ofrequired

    Option 4

    • factstringrequired
      min 1 chars · max 40 chars
    • opstringrequired
      One ofeqneqgtgteltlteinnincontainsexists
    • valueone of
  • actionsarray<one of>required
    min 1 items · max 10 items
    7 variants (one of)

    type: "send_message"

    • typestringrequired
      Alwayssend_message
    • templateIdstring · uuidrequired
    • couponCodestring
      min 1 chars · max 64 chars

    type: "wait"

    • typestringrequired
      Alwayswait
    • minutesintegerrequired
      min 1 · max 43200

    type: "notify_merchant"

    • typestringrequired
      Alwaysnotify_merchant
    • subjectstringrequired
      min 1 chars · max 150 chars
    • bodystringrequired
      min 1 chars · max 2000 chars

    type: "add_tag"

    • typestringrequired
      Alwaysadd_tag
    • tagstringrequired
      min 1 chars · max 40 chars

    type: "send_card_update_link"

    • typestringrequired
      Alwayssend_card_update_link

    type: "webhook"

    • typestringrequired
      Alwayswebhook
    • endpointIdstring · uuidrequired

    type: "pause_routing_suggestion"

    • typestringrequired
      Alwayspause_routing_suggestion
  • exitConditionsone ofnullable
    4 variants (one of)

    Option 1

    • allarray<one of>required
      max 50 items
      4 variants (one of)

      Option 1

      • allarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 2

      • anyarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 3

      • notone ofrequired

      Option 4

      • factstringrequired
        min 1 chars · max 40 chars
      • opstringrequired
        One ofeqneqgtgteltlteinnincontainsexists
      • valueone of

    Option 2

    • anyarray<one of>required
      max 50 items
      4 variants (one of)

      Option 1

      • allarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 2

      • anyarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 3

      • notone ofrequired

      Option 4

      • factstringrequired
        min 1 chars · max 40 chars
      • opstringrequired
        One ofeqneqgtgteltlteinnincontainsexists
      • valueone of

    Option 3

    • notone ofrequired

    Option 4

    • factstringrequired
      min 1 chars · max 40 chars
    • opstringrequired
      One ofeqneqgtgteltlteinnincontainsexists
    • valueone of

Responses

  • 201Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 422Validation failed (invalid_request) Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 201 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X POST "$GIEP_API_URL/v1/automations" \
  -H "Authorization: Bearer $GIEP_API_KEY" \
  -H "Idempotency-Key: order-1042-automations-v1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "trigger": "string",
  "conditions": {
    "all": []
  },
  "actions": [
    {
      "type": "send_message",
      "templateId": "8146aba6-2f2e-43f6-a775-f3514-5cb"
    }
  ]
}'
// JSON object. The OpenAPI document does not list its fields.

A rule with its versions, recent runs, deliveries and recovered checkouts

GET/v1/automations/{id}

Versions are immutable (with their exitConditions); runs show each step outcome; deliveries carry the consent record each send relied on as consent {purpose, state, at} (null when none was needed), the template version and the funnel times. recovered and recoveredRevenue (per currency, minor units): abandoned checkouts paid after one of the rule's recovery messages was sent.

Authentication
API key (Bearer)
Permission
customer:read
Idempotency-Key
Not used
Success
200

Path parameters

  • idstringrequired

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X GET "$GIEP_API_URL/v1/automations/03d6a9b4-664b-427c-a0b5-feb0-372" \
  -H "Authorization: Bearer $GIEP_API_KEY"
// JSON object. The OpenAPI document does not list its fields.

Pause a rule

POST/v1/automations/{id}/pause

Pending runs stop before their next step; activating a version resumes the rule. Audited.

Authentication
API key (Bearer)
Permission
automation:manage
Idempotency-Key
Required
Success
200

Path parameters

  • idstringrequired

Headers

  • Idempotency-Keystringrequired

    Required with an API key (SELL-033): 8-255 characters of A-Z a-z 0-9 _ - : . The same key with the same request returns the stored response without running it again; with a different request 422 idempotency_key_reused; while the first is still running 409 request_in_progress. Signed-in workspace sessions may omit it.

    min 8 chars · max 255 chars · pattern ^[A-Za-z0-9_:.-]+$

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X POST "$GIEP_API_URL/v1/automations/03d6a9b4-664b-427c-a0b5-feb0-372/pause" \
  -H "Authorization: Bearer $GIEP_API_KEY" \
  -H "Idempotency-Key: order-1042-pause-v1"
// JSON object. The OpenAPI document does not list its fields.

Create a new (draft) version of a rule

POST/v1/automations/{id}/versions

Immutable once created; activate it after a dry run. Audited.

Authentication
API key (Bearer)
Permission
automation:manage
Idempotency-Key
Required
Success
201

Path parameters

  • idstringrequired

Headers

  • Idempotency-Keystringrequired

    Required with an API key (SELL-033): 8-255 characters of A-Z a-z 0-9 _ - : . The same key with the same request returns the stored response without running it again; with a different request 422 idempotency_key_reused; while the first is still running 409 request_in_progress. Signed-in workspace sessions may omit it.

    min 8 chars · max 255 chars · pattern ^[A-Za-z0-9_:.-]+$

Request body · application/jsonrequired

  • conditionsone ofrequirednullable
    4 variants (one of)

    Option 1

    • allarray<one of>required
      max 50 items
      4 variants (one of)

      Option 1

      • allarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 2

      • anyarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 3

      • notone ofrequired

      Option 4

      • factstringrequired
        min 1 chars · max 40 chars
      • opstringrequired
        One ofeqneqgtgteltlteinnincontainsexists
      • valueone of

    Option 2

    • anyarray<one of>required
      max 50 items
      4 variants (one of)

      Option 1

      • allarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 2

      • anyarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 3

      • notone ofrequired

      Option 4

      • factstringrequired
        min 1 chars · max 40 chars
      • opstringrequired
        One ofeqneqgtgteltlteinnincontainsexists
      • valueone of

    Option 3

    • notone ofrequired

    Option 4

    • factstringrequired
      min 1 chars · max 40 chars
    • opstringrequired
      One ofeqneqgtgteltlteinnincontainsexists
    • valueone of
  • actionsarray<one of>required
    min 1 items · max 10 items
    7 variants (one of)

    type: "send_message"

    • typestringrequired
      Alwayssend_message
    • templateIdstring · uuidrequired
    • couponCodestring
      min 1 chars · max 64 chars

    type: "wait"

    • typestringrequired
      Alwayswait
    • minutesintegerrequired
      min 1 · max 43200

    type: "notify_merchant"

    • typestringrequired
      Alwaysnotify_merchant
    • subjectstringrequired
      min 1 chars · max 150 chars
    • bodystringrequired
      min 1 chars · max 2000 chars

    type: "add_tag"

    • typestringrequired
      Alwaysadd_tag
    • tagstringrequired
      min 1 chars · max 40 chars

    type: "send_card_update_link"

    • typestringrequired
      Alwayssend_card_update_link

    type: "webhook"

    • typestringrequired
      Alwayswebhook
    • endpointIdstring · uuidrequired

    type: "pause_routing_suggestion"

    • typestringrequired
      Alwayspause_routing_suggestion
  • exitConditionsone ofnullable
    4 variants (one of)

    Option 1

    • allarray<one of>required
      max 50 items
      4 variants (one of)

      Option 1

      • allarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 2

      • anyarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 3

      • notone ofrequired

      Option 4

      • factstringrequired
        min 1 chars · max 40 chars
      • opstringrequired
        One ofeqneqgtgteltlteinnincontainsexists
      • valueone of

    Option 2

    • anyarray<one of>required
      max 50 items
      4 variants (one of)

      Option 1

      • allarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 2

      • anyarray<one of>required
        max 50 items
        4 variants (one of)

        Option 1

        • allarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 2

        • anyarray<one of>required
          max 50 items
          4 variants (one of)

          Option 1

          • allarray<one of>required
            max 50 items

          Option 2

          • anyarray<one of>required
            max 50 items

          Option 3

          • notone ofrequired

          Option 4

          • factstringrequired
            min 1 chars · max 40 chars
          • opstringrequired
            One ofeqneqgtgteltlteinnincontainsexists
          • valueone of

        Option 3

        • notone ofrequired

        Option 4

        • factstringrequired
          min 1 chars · max 40 chars
        • opstringrequired
          One ofeqneqgtgteltlteinnincontainsexists
        • valueone of

      Option 3

      • notone ofrequired

      Option 4

      • factstringrequired
        min 1 chars · max 40 chars
      • opstringrequired
        One ofeqneqgtgteltlteinnincontainsexists
      • valueone of

    Option 3

    • notone ofrequired

    Option 4

    • factstringrequired
      min 1 chars · max 40 chars
    • opstringrequired
      One ofeqneqgtgteltlteinnincontainsexists
    • valueone of

Responses

  • 201Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 422Validation failed (invalid_request) Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 201 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X POST "$GIEP_API_URL/v1/automations/03d6a9b4-664b-427c-a0b5-feb0-372/versions" \
  -H "Authorization: Bearer $GIEP_API_KEY" \
  -H "Idempotency-Key: order-1042-versions-v1" \
  -H "Content-Type: application/json" \
  -d '{
  "conditions": {
    "all": []
  },
  "actions": [
    {
      "type": "send_message",
      "templateId": "8146aba6-2f2e-43f6-a775-f3514-5cb"
    }
  ]
}'
// JSON object. The OpenAPI document does not list its fields.

Activate a version (also the rollback path)

POST/v1/automations/{id}/versions/{versionId}/activate

Refused with 409 dry_run_required for a version that was never dry-run. Audited.

Authentication
API key (Bearer)
Permission
automation:manage
Idempotency-Key
Required
Success
200

Path parameters

  • idstringrequired
  • versionIdstringrequired

Headers

  • Idempotency-Keystringrequired

    Required with an API key (SELL-033): 8-255 characters of A-Z a-z 0-9 _ - : . The same key with the same request returns the stored response without running it again; with a different request 422 idempotency_key_reused; while the first is still running 409 request_in_progress. Signed-in workspace sessions may omit it.

    min 8 chars · max 255 chars · pattern ^[A-Za-z0-9_:.-]+$

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X POST "$GIEP_API_URL/v1/automations/03d6a9b4-664b-427c-a0b5-feb0-372/versions/string/activate" \
  -H "Authorization: Bearer $GIEP_API_KEY" \
  -H "Idempotency-Key: order-1042-activate-v1"
// JSON object. The OpenAPI document does not list its fields.

Dry run a version over the last 30 days of matching events (nothing is sent)

POST/v1/automations/{id}/versions/{versionId}/dry-run

Returns scanned and matched counts and a sample; required before activation (AUT-001). Audited.

Authentication
API key (Bearer)
Permission
automation:manage
Idempotency-Key
Required
Success
200

Path parameters

  • idstringrequired
  • versionIdstringrequired

Headers

  • Idempotency-Keystringrequired

    Required with an API key (SELL-033): 8-255 characters of A-Z a-z 0-9 _ - : . The same key with the same request returns the stored response without running it again; with a different request 422 idempotency_key_reused; while the first is still running 409 request_in_progress. Signed-in workspace sessions may omit it.

    min 8 chars · max 255 chars · pattern ^[A-Za-z0-9_:.-]+$

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X POST "$GIEP_API_URL/v1/automations/03d6a9b4-664b-427c-a0b5-feb0-372/versions/string/dry-run" \
  -H "Authorization: Bearer $GIEP_API_KEY" \
  -H "Idempotency-Key: order-1042-dry-run-v1"
// JSON object. The OpenAPI document does not list its fields.

Automation runs across rules, newest first, cursor-paged

GET/v1/automations/runs

Filter by ruleId and status (pending, running, completed, failed, cancelled). Each item carries the rule name, the version number and the step log. Pass nextCursor back as cursor for the next page; null means the end. Needs customer:read.

Authentication
API key (Bearer)
Permission
customer:read
Idempotency-Key
Not used
Success
200

Query parameters

  • ruleIdstring · uuid
  • statusstring
    One ofpendingrunningcompletedfailedcancelled
  • cursorstring
    max 100 chars
  • limitinteger
    Default 50min 1 · max 100

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 422Validation failed (invalid_request) Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X GET "$GIEP_API_URL/v1/automations/runs" \
  -H "Authorization: Bearer $GIEP_API_KEY"
// JSON object. The OpenAPI document does not list its fields.

Message templates

GET/v1/automations/templates/messages

Email (and SMS/WhatsApp where configured) templates with purpose transactional or marketing and their version.

Authentication
API key (Bearer)
Permission
customer:read
Idempotency-Key
Not used
Success
200

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X GET "$GIEP_API_URL/v1/automations/templates/messages" \
  -H "Authorization: Bearer $GIEP_API_KEY"
// JSON object. The OpenAPI document does not list its fields.

Create a message template

POST/v1/automations/templates/messages

Placeholders from a whitelist only ({{customer_name}}, {{customer_email}}, {{store_name}}, {{amount}}, {{checkout_url}}, {{coupon}}, {{unsubscribe_url}}); a rule may only use the ones its trigger fills (checked when the rule version is saved; campaigns: customer_name, customer_email, unsubscribe_url). Values are substituted at send time; email also gets an HTML part with every character escaped. Email needs a subject. Saving creates immutable version 1. Audited.

Authentication
API key (Bearer)
Permission
automation:manage
Idempotency-Key
Required
Success
201

Headers

  • Idempotency-Keystringrequired

    Required with an API key (SELL-033): 8-255 characters of A-Z a-z 0-9 _ - : . The same key with the same request returns the stored response without running it again; with a different request 422 idempotency_key_reused; while the first is still running 409 request_in_progress. Signed-in workspace sessions may omit it.

    min 8 chars · max 255 chars · pattern ^[A-Za-z0-9_:.-]+$

Request body · application/jsonrequired

  • namestringrequired
    min 1 chars · max 80 chars
  • channelstringrequired
    One ofemailsmswhatsapp
  • purposestringrequired
    One oftransactionalmarketing
  • subjectstring
    max 200 chars
  • bodystringrequired
    min 1 chars · max 10000 chars

Responses

  • 201Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 422Validation failed (invalid_request) Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 201 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X POST "$GIEP_API_URL/v1/automations/templates/messages" \
  -H "Authorization: Bearer $GIEP_API_KEY" \
  -H "Idempotency-Key: order-1042-messages-v1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "channel": "email",
  "purpose": "transactional",
  "body": "string"
}'
// JSON object. The OpenAPI document does not list its fields.

Edit a message template (new version number)

PATCH/v1/automations/templates/messages/{id}

Same placeholder whitelist as creation. Every save is a new immutable version; deliveries record the version they rendered. Audited.

Authentication
API key (Bearer)
Permission
automation:manage
Idempotency-Key
Required
Success
200

Path parameters

  • idstringrequired

Headers

  • Idempotency-Keystringrequired

    Required with an API key (SELL-033): 8-255 characters of A-Z a-z 0-9 _ - : . The same key with the same request returns the stored response without running it again; with a different request 422 idempotency_key_reused; while the first is still running 409 request_in_progress. Signed-in workspace sessions may omit it.

    min 8 chars · max 255 chars · pattern ^[A-Za-z0-9_:.-]+$

Request body · application/jsonrequired

  • namestring
    min 1 chars · max 80 chars
  • subjectstring
    max 200 chars
  • bodystring
    min 1 chars · max 10000 chars

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 422Validation failed (invalid_request) Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X PATCH "$GIEP_API_URL/v1/automations/templates/messages/03d6a9b4-664b-427c-a0b5-feb0-372" \
  -H "Authorization: Bearer $GIEP_API_KEY" \
  -H "Idempotency-Key: order-1042-messages-v1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "subject": "string",
  "body": "string"
}'
// JSON object. The OpenAPI document does not list its fields.

The versions of a message template, newest first (immutable)

GET/v1/automations/templates/messages/{id}/versions

Each saved subject and body with its version number, author and time.

Authentication
API key (Bearer)
Permission
customer:read
Idempotency-Key
Not used
Success
200

Path parameters

  • idstringrequired

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X GET "$GIEP_API_URL/v1/automations/templates/messages/03d6a9b4-664b-427c-a0b5-feb0-372/versions" \
  -H "Authorization: Bearer $GIEP_API_KEY"
// JSON object. The OpenAPI document does not list its fields.

Rule templates (failed renewal, renewal reminder, abandoned checkout, processor degraded, loyal customers)

GET/v1/automations/templates/rules

Starting points; the merchant chooses message templates, dry-runs and activates like any rule.

Authentication
API key (Bearer)
Permission
customer:read
Idempotency-Key
Not used
Success
200

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X GET "$GIEP_API_URL/v1/automations/templates/rules" \
  -H "Authorization: Bearer $GIEP_API_KEY"
// JSON object. The OpenAPI document does not list its fields.

Campaigns with their template and segment names

GET/v1/campaigns

One-off or scheduled sends of a marketing template to a segment, newest first, with status draft, scheduled, sending, sent or cancelled.

Authentication
API key (Bearer)
Permission
customer:read
Idempotency-Key
Not used
Success
200

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X GET "$GIEP_API_URL/v1/campaigns" \
  -H "Authorization: Bearer $GIEP_API_KEY"
// JSON object. The OpenAPI document does not list its fields.

Create a campaign (draft)

POST/v1/campaigns

The template must be a marketing template and the segment a live one of this merchant. Nothing is sent until the campaign is scheduled. Needs automation:manage. Audited.

Authentication
API key (Bearer)
Permission
automation:manage
Idempotency-Key
Required
Success
201

Headers

  • Idempotency-Keystringrequired

    Required with an API key (SELL-033): 8-255 characters of A-Z a-z 0-9 _ - : . The same key with the same request returns the stored response without running it again; with a different request 422 idempotency_key_reused; while the first is still running 409 request_in_progress. Signed-in workspace sessions may omit it.

    min 8 chars · max 255 chars · pattern ^[A-Za-z0-9_:.-]+$

Request body · application/jsonrequired

  • namestringrequired
    min 1 chars · max 80 chars
  • templateIdstring · uuidrequired
  • segmentIdstring · uuidrequired

Responses

  • 201Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 422Validation failed (invalid_request) Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 201 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X POST "$GIEP_API_URL/v1/campaigns" \
  -H "Authorization: Bearer $GIEP_API_KEY" \
  -H "Idempotency-Key: order-1042-campaigns-v1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "templateId": "8146aba6-2f2e-43f6-a775-f3514-5cb",
  "segmentId": "243b225b-98f5-4a9f-a423-3c660c6f"
}'
// JSON object. The OpenAPI document does not list its fields.

A campaign with its delivery counts and results

GET/v1/campaigns/{id}

Counts of message deliveries by status (sent, delivered, bounced, complained, failed, skipped, unknown), the skip reasons (no_consent, suppressed, frequency_cap, ...), how many frozen recipients are still pending, and metrics: sent, delivered, opened, clicked, bounced, unsubscribed, and the recipients' paid orders created within 7 days after the message (attributedOrders, attributedRevenue per currency in minor units).

Authentication
API key (Bearer)
Permission
customer:read
Idempotency-Key
Not used
Success
200

Path parameters

  • idstringrequired

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X GET "$GIEP_API_URL/v1/campaigns/03d6a9b4-664b-427c-a0b5-feb0-372" \
  -H "Authorization: Bearer $GIEP_API_KEY"
// JSON object. The OpenAPI document does not list its fields.

Cancel a campaign that has not finished

POST/v1/campaigns/{id}/cancel

Allowed from draft, scheduled or sending; recipients not yet processed are never sent. Needs automation:manage. Audited.

Authentication
API key (Bearer)
Permission
automation:manage
Idempotency-Key
Required
Success
200

Path parameters

  • idstringrequired

Headers

  • Idempotency-Keystringrequired

    Required with an API key (SELL-033): 8-255 characters of A-Z a-z 0-9 _ - : . The same key with the same request returns the stored response without running it again; with a different request 422 idempotency_key_reused; while the first is still running 409 request_in_progress. Signed-in workspace sessions may omit it.

    min 8 chars · max 255 chars · pattern ^[A-Za-z0-9_:.-]+$

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X POST "$GIEP_API_URL/v1/campaigns/03d6a9b4-664b-427c-a0b5-feb0-372/cancel" \
  -H "Authorization: Bearer $GIEP_API_KEY" \
  -H "Idempotency-Key: order-1042-cancel-v1"
// JSON object. The OpenAPI document does not list its fields.

Dry-run count: audience size and how many would be eligible (nothing is sent)

POST/v1/campaigns/{id}/dry-run

Evaluates the segment now and applies the send path checks for contact, suppression and marketing consent; the frequency cap depends on send time and is not predicted. Needs automation:manage.

Authentication
API key (Bearer)
Permission
automation:manage
Idempotency-Key
Required
Success
200

Path parameters

  • idstringrequired

Headers

  • Idempotency-Keystringrequired

    Required with an API key (SELL-033): 8-255 characters of A-Z a-z 0-9 _ - : . The same key with the same request returns the stored response without running it again; with a different request 422 idempotency_key_reused; while the first is still running 409 request_in_progress. Signed-in workspace sessions may omit it.

    min 8 chars · max 255 chars · pattern ^[A-Za-z0-9_:.-]+$

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X POST "$GIEP_API_URL/v1/campaigns/03d6a9b4-664b-427c-a0b5-feb0-372/dry-run" \
  -H "Authorization: Bearer $GIEP_API_KEY" \
  -H "Idempotency-Key: order-1042-dry-run-v1"
// JSON object. The OpenAPI document does not list its fields.

Send a draft campaign now or at a scheduled time

POST/v1/campaigns/{id}/send

Moves a draft to scheduled. The audience is frozen when sending starts; each recipient goes through the same consent, quiet-hours, frequency-cap, suppression and at-most-once delivery path as automation messages, keyed per campaign and customer. Needs automation:manage. Audited.

Authentication
API key (Bearer)
Permission
automation:manage
Idempotency-Key
Required
Success
200

Path parameters

  • idstringrequired

Headers

  • Idempotency-Keystringrequired

    Required with an API key (SELL-033): 8-255 characters of A-Z a-z 0-9 _ - : . The same key with the same request returns the stored response without running it again; with a different request 422 idempotency_key_reused; while the first is still running 409 request_in_progress. Signed-in workspace sessions may omit it.

    min 8 chars · max 255 chars · pattern ^[A-Za-z0-9_:.-]+$

Request body · application/jsonrequired

  • scheduledAtstring · date-time
    pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$

Responses

  • 200Success
  • 401Missing or invalid credentials Body is an error object with code and message.
  • 403Role not permitted Body is an error object with code and message.
  • 422Validation failed (invalid_request) Body is an error object with code and message.
  • 429Rate limited (rate_limited); see Retry-After Body is an error object with code and message.

The 200 response is a JSON object. The OpenAPI document does not describe its fields.

Request · cURL
curl -X POST "$GIEP_API_URL/v1/campaigns/03d6a9b4-664b-427c-a0b5-feb0-372/send" \
  -H "Authorization: Bearer $GIEP_API_KEY" \
  -H "Idempotency-Key: order-1042-send-v1" \
  -H "Content-Type: application/json" \
  -d '{
  "scheduledAt": "2026-10-26T12:00:00.000Z"
}'
// JSON object. The OpenAPI document does not list its fields.
Automations · API reference · GIEP