Sign in

Join

POST https://{organization}.myguper.com/api/register/membership

Records a person joining (or rejoining) a tier program.

Most memberships are created automatically by the tag hook: assigning a person a tag that is listed in tag_tier_filter triggers a join. This endpoint covers cases where the membership must be created manually (e.g. admin action, data import, special enrollment flow).

Idempotent:

  • If no row exists → INSERT, history joined.
  • If row exists and is active (leftAt IS NULL) → no-op.
  • If row exists and was closed (leftAt IS NOT NULL) → clears leftAt, updates joinedAt, history rejoined.

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.

Request body

Content-Type: application/json

{
    "person": 4131293,
    "tierConfig": 1,
    "joinedAt": "2026-05-27T10:00:00-03:00",                    // optional
    "source": "manual",                                         // optional
    "sourceRef": "admin:42"                                     // optional
}

Responses

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