Entrar

Sair

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

Encerra uma membership ativa setando leftAt.

A maioria das saídas acontece automaticamente: remover uma tag listada em tag_tier_filter dispara um leave via o hook. Este endpoint cobre saídas manuais ou programáticas (opt-out via admin, encerramento de conta, fluxo especial).

Idempotente:

  • Sem linha, ou linha já com leftAt → no-op.
  • Linha ativa → UPDATE seta leftAt, history left.

A linha não é deletada — fica preservada para que o histórico continue consultável.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

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

Cabeçalhos

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.

Parâmetros do caminho

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

Corpo da requisição

Content-Type: application/json

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

Respostas

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