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
- Call the Create Campaign API
- From your tenant’s campaigns page, click
Create Campaign. - Fill in the campaign details:
- Campaign Name
- Description (Optional)
- Campaign Owner
- Click
Save and Continueto 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
- From your campaign page, click
Campaign Adminsfrom the left sidebar, then clickAdd Campaign Admin. - Fill in the admin details:
- Email Address
- Role
- Click
Save and Addto grant the user access to this campaign.
Remove a Campaign Admin
- From your campaign page, click
Campaign Adminsfrom the left sidebar. - Search for the user by email.
- Click the Dustbin icon in the Action column.
- Click
Yes, Removeto 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.
- From your campaign page, click
Campaign Adminsfrom the left sidebar. - Search for the user by email.
- Click the
⫶icon in the Action column, then selectEdit Role. - Choose the new role from the dropdown menu.
- Click
Save Changesto 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
- From your campaign page, click
Campaign Adminsfrom the left sidebar. - Search for the user by email.
- Click the
⫶icon in the Action column, then selectTransfer Ownership. - Click
Yes, Confirmto 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.
- Navigate to your campaign page.
- From the left sidebar, click More > API Keys.
- Click Generate API Key.
- 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 informationgov.rewards/campaign.write- Write access (automatically includes read access)
- Expiry Date: Set the expiration date (maximum of 1 year from creation)
- 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.