Sign in

Update

PUT https://{organization}.myguper.com/api/loyalty/campaign

Updates an existing campaign. Only id is strictly required — every other field present in Create campaign can also appear here and is partially merged into the record (only the keys you send are updated).

When the campaign trigger is audience-list, the paired CampaignAudience record is re-synchronized: toggling isActive flips its status between running and standby.

For member-event campaigns, eventType is the field that decides which lifecycle event fires the campaign (membership_joined or tier_achieved). To filter by a specific tier level on tier_achieved, attach a campaign_rule with code 17 (see Campaign rules).

Try-it values populated from environment ACME (Demo)


Authentication

Token

Send your user token in the x-guper-authorization header. Endpoints that support a Public mode (e.g. acúmulo and resgate previews) accept the same request without the header — Private mode adds customer data and a confirmation token to the response.

Headers

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

Request body

Content-Type: application/json

{
    "id": 1,
    "name": "My Campaign",                                      // optional
    "displayName": "<displayName>",                             // optional
    "isActive": false,                                          // optional
    "isDraft": false,                                           // optional
    "aliquot": 0,                                               // optional
    "aliquotType": 0,                                           // optional
    "dateRangeStart": "<dateRangeStart>",                       // optional
    "dateRangeEnd": "<dateRangeEnd>",                           // optional
    "initAt": "<initAt>",                                       // optional
    "finishAt": "<finishAt>"                                    // optional
}

Responses

Copied to clipboard