A Singapore Government Agency Website

Campaigns

Overview

A Campaign is an initiative that contains a set of objectives and rules, and is used to track the activities performed by participants. Each campaign runs independently of others.

Create a Campaign


  1. From your tenant’s campaigns page, click Create Campaign.
  2. Fill in the campaign details:
    • Campaign Name
    • Description (Optional)
    • Campaign Owner
  3. Click Save and Continue to create the campaign.

Managing Campaign Admins

Campaign Admins are users who have administrative privileges to manage specific campaigns within your tenant.

Add a Campaign Admin

  1. From your campaign page, click Campaign Admins from the left sidebar, then click Add Campaign Admin.
  2. Fill in the admin details:
    • Email Address
    • Role
  3. Click Save and Add to grant the user access to this campaign.

Remove a Campaign Admin

  1. From your campaign page, click Campaign Admins from the left sidebar.
  2. Search for the user by email.
  3. Click the Dustbin icon in the Action column.
  4. Click Yes, Remove to revoke their admin access.

Note: If you are the Campaign Owner and want to be removed as an admin:
1. You must first transfer ownership to another trusted admin.
2. Once ownership is transferred, the new owner can then remove you as a regular Campaign Admin using the steps above.

Edit Campaign Admin Role

You can modify the role of existing Campaign Admins to adjust their permissions and responsibilities within the campaign.

  1. From your campaign page, click Campaign Admins from the left sidebar.
  2. Search for the user by email.
  3. Click the ⫶ icon in the Action column, then select Edit Role.
  4. Choose the new role from the dropdown menu.
  5. Click Save Changes to update their role.

Transfer Campaign Ownership

When to Transfer Ownership

  • You are leaving your role and want to pass campaign responsibility to another team member.

How to Transfer Ownership

  1. From your campaign page, click Campaign Admins from the left sidebar.
  2. Search for the user by email.
  3. Click the ⫶ icon in the Action column, then select Transfer Ownership.
  4. Click Yes, Confirm to transfer ownership.

Important
- Only the current owner can perform a transfer.
- If the owner has already left and cannot transfer ownership, first ask a Tenant Admin to help transfer the campaign ownership.
- If no Tenant Admin is available, contact us to update campaign ownership.

Managing API Keys

API Keys are authentication credentials used to enable system-to-system integration with the GovRewards Campaign APIs. These keys allow external applications to securely access and interact with your campaign and related resources programmatically.

Create an API Key

Creating an API key enables external systems to authenticate and access your campaign APIs. You can set specific permissions and configure the expiry date for enhanced security.

  1. Navigate to your campaign page.
  2. From the left sidebar, click More > API Keys.
  3. Click Generate API Key.
  4. Configure your API key:
    • Name: Enter a descriptive name for the API key to help identify its purpose.
    • Permissions: Select the required access level:
      • gov.rewards/campaign.read - Read-only access to campaign information
      • gov.rewards/campaign.write - Write access (automatically includes read access)
    • Expiry Date: Set the expiration date (maximum of 1 year from creation)
  5. Click Generate to create the API key.

Important: A CSV file containing your API key will be automatically downloaded. Store this file securely, as the API key cannot be retrieved from the system once generated.

Chat with me!
Bot Launcher