Create join link

​

Request

curl -X POST https://api.interchange.io/api/v2/storefront/join-links \
  -H "Authorization: Bearer $SCOPE3_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "storefrontId": 4012,
    "approvalPolicy": "manual_approve",
    "slug": "northwind-advertisers",
    "maxUses": 250,
    "expiresAt": "2026-12-31T23:59:59Z"
  }'

{
  "storefrontId": 4012
}

​

Parameters

​

Response

{
  "id": "5571",
  "slug": "northwind-advertisers",
  "joinPath": "/join/northwind-advertisers",
  "sellerCustomerId": 318,
  "storefrontId": 4012,
  "role": "BUYER",
  "posture": "prepay",
  "approvalPolicy": "manual_approve",
  "active": true,
  "uses": 0,
  "maxUses": 250,
  "expiresAt": "2026-12-31T23:59:59.000Z",
  "revokedAt": null,
  "createdAt": "2026-06-14T18:22:10.441Z",
  "updatedAt": "2026-06-14T18:22:10.441Z"
}

​

Errors

• 400 VALIDATION_ERROR — missing storefrontId, or an invalid slug, approvalPolicy, expiresAt, or maxUses.
• 401 UNAUTHORIZED — missing or invalid API key.
• 403 CUSTOMER_ROLE_DENIED — the API key is not a seller account; only sellers manage join links.
• 403 ACCESS_DENIED — the storefrontId belongs to another organization.
• 404 NOT_FOUND — no storefront with this id exists.
• 409 CONFLICT — an active link with that slug already exists. Choose a different slug or disable the existing one.

​

Related