Skip to main content
DELETE /api/v2/storefront/join-links/{linkId} Soft-revokes a join link. The link is marked inactive (active: false, revokedAt set) and stops admitting new signups. Buyers who already joined keep their accounts — disabling a link only closes the door to new entrants.

​
Request

curl -X DELETE https://api.interchange.io/api/v2/storefront/join-links/5571 \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

​
Parameters

FieldTypeRequiredNotes
linkIdstring (path)YesThe join link id. Must be a positive integer belonging to your organization.

​
Response

200 OK confirming the revocation: 
{
  "disabled": true,
  "id": "5571"
}

​
Errors

  • 400 VALIDATION_ERROR — linkId is not a positive integer.
  • 401 UNAUTHORIZED — missing or invalid API key.
  • 403 CUSTOMER_ROLE_DENIED — the API key is not a seller account; only sellers manage join links.
  • 404 NOT_FOUND — no active link with this id on your organization’s storefronts.
See Errors for the full error contract.

Join-link tasks

All operations

List join links

Find a link’s id

Create join link

Mint a replacement link

Errors

Shared error contract