Sign in

Leave

DELETE https://{organization}.myguper.com/api/register/membership/{personId}/{tierConfig}

Closes an active membership by setting leftAt.

Most "leaves" happen automatically: removing a person tag that is listed in tag_tier_filter triggers a leave via the tag hook. This endpoint covers manual or programmatic leaves (admin opt-out, account closure, special workflow).

Idempotent:

  • No row, or row already has leftAt → no-op.
  • Active row → UPDATE sets leftAt, history left.

The membership row is kept (not deleted) so the historical timeline remains queryable.

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header.

Headers

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Path parameters

Name Type Description
personId * integer Internal Guper person ID.
tierConfig * integer Tier program id (`tier_config.id`).

Request body

Content-Type: application/json

{
    "leftAt": "2026-05-27T10:00:00-03:00",                      // optional
    "source": "manual",                                         // optional
    "sourceRef": "admin:42"                                     // optional
}

Responses

{ "action": "left" }
Copied to clipboard