---
title: "Connect an integration"
description: "Connect an integration. OAuth integrations (klaviyo, judgeme, smile, gorgias) return 201 with connect_url, a one-use link (15 minutes) to the dashboard panel where the merchant presses Connect and approves in the provide"
url: https://docs.stoqapp.com/v2-reference/account-integrations/connect-an-integration/
api: "API v2 reference"
method: POST
path: "/account/integrations/{id}/connect"
---

# Connect an integration

`POST https://app.stoqapp.com/api/v2/external/account/integrations/{id}/connect`

Connect an integration. OAuth integrations (klaviyo, judgeme, smile, gorgias) return 201 with connect_url, a one-use link (15 minutes) to the dashboard panel where the merchant presses Connect and approves in the provider. Show it to the user; do not open or fetch it. API-key integrations (postscript, omnisend, mailchimp) take api_key, check it with the provider where STOQ can (Postscript, Mailchimp) and save it. Over MCP or the in-app assistant they take no key and return 201 with key_url instead: API keys are entered by the merchant in STOQ. Show key_url to the user; do not ask for the key.

**Note:** Read [`GET /account/integrations/:id`](https://docs.stoqapp.com/v2-reference/account-integrations/retrieve-an-integration/) afterwards for the result. Switch integrations (shopify_flow, meta_pixel, split_order, shopify_customers) have nothing to connect: turn them on with [`PATCH /account/integrations`](https://docs.stoqapp.com/v2-reference/account-integrations/update-an-integration/). reconnect true replaces a connection or key that is already there. A new link replaces the last one; 5 links per integration an hour.

## Path parameters

- `id` (string, required)

## Headers

- `Idempotency-Key` (string): A fresh unique key for every write (a new UUID, say); reuse it only to retry that write. Keys are remembered for 1 hour: the same key and the same request within that hour returns the first result, with `Idempotent-Replayed: true`, without running again; the same key with a different method, path or body is refused (422 `idempotency_key_reused`); a retry while the first is still running gets 409 `idempotency_key_in_progress`. Keys are per store. Server errors and rate limits are not kept, so their retry runs.

## Request body

- `api_key` (string): e.g. `string`
- `list_id` (string): e.g. `string`
- `reconnect` (string): e.g. `string`
- `account` (integer): e.g. `5`

Rate limit: this call costs 2 points ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Example request

```sh
curl -X POST "https://app.stoqapp.com/api/v2/external/account/integrations/{id}/connect" \
  -H "X-Auth-Token: $STOQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": "string",
    "list_id": "string",
    "reconnect": "string",
    "account": 5
  }'
```

## 200

Success: the updated resource.

## 202

Accepted: async/bulk work was queued. Poll the returned job.

```json
{
  "job_id": "job_a1b2c3",
  "status_url": "/api/v2/external/jobs/job_a1b2c3"
}
```

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 404

The resource does not exist for this shop, or the action path is not registered.

```json
{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 409

An earlier request with the same Idempotency-Key is still running. Wait, then resend the same request with the same key.

```json
{
  "errors": [
    "A request with this Idempotency-Key is still running"
  ],
  "code": "idempotency_key_in_progress",
  "details": [
    {
      "code": "idempotency_key_in_progress",
      "message": "A request with this Idempotency-Key is still running",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```