Search the docs

Find a page, a section, or an endpoint.

Sign inGet started

tenants

Every tenants endpoint, generated from the API's own schemas.

Offboard one of your customers

post/api/v1/tenants/{id}/suspend

Suspends every address carrying that `tenant_id`. **Suspends, never deletes** — the mail, the threads and the grants all stay, and each address emits `identity.suspended`. Deleting them is still one call each. Idempotent: it changes what is active and reports how many, so a retry is safe. It reaches only addresses you could have suspended one at a time.

Parameters

  • idstringrequired

    Your own tenant id, URL-encoded.

Responses

  • 200What changed.
  • 401No API key, or one that is not valid.
  • 404No such resource, **or** one belonging to another account. The two are deliberately indistinguishable: a different answer would enumerate what exists.
  • 429Rate limited. `X-RateLimit-Reset` says when to retry.
bash
curl https://pidgeon.ai/api/v1/tenants/{id}/suspend \
  -X POST \
  -H "Authorization: Bearer $PIDGEON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Generated · public/openapi.json