Campaign tools - Claimr

These tools let the assistant find your organizations and campaigns, create and update campaigns, and change campaign-wide settings. The Access column shows the permission area and level each tool needs. See Permission areas.

Context and organizations

Tool	What it does	Access
`claimr_create_context`	Starts a context that remembers the organization, campaign, group, quest, and task you’re working on.	None
`claimr_get_organizations`	Lists the organizations you belong to.	None

Campaigns

Tool	What it does	Access
`claimr_get_campaigns`	Lists the campaigns of an organization.	Campaigns: read
`claimr_get_campaign`	Gets a campaign’s details by slug or ID.	Campaigns: read
`claimr_create_campaign`	Creates a campaign by name, with an optional image.	Organization: write
`claimr_update_campaign`	Changes a campaign’s name, image, XP name, and XP icon.	Campaigns: write

Creating a campaign is an organization-level action, so it needs Organization write access, not Campaigns.

Campaign settings

Tool	What it does	Access
`claimr_get_leaderboard_settings`	Shows whether the referral XP and referral count leaderboards are on, whether the leaderboard is frozen, and which tasks a participant must complete to appear on it.	Campaigns: read
`claimr_set_leaderboard_settings`	Changes the leaderboard settings.	Campaigns: write
`claimr_get_referral_settings`	Shows how much XP a referrer earns and what a referred participant must do before the referral counts.	Campaigns: read
`claimr_set_referral_settings`	Changes the referral rewards. Pay the referrer a share of the referred participant’s XP, or a flat amount per referral.	Campaigns: write
`claimr_get_campaign_limits`	Shows the campaign’s schedule, the maximum number of participants, and the XP participants start with.	Campaigns: read
`claimr_set_campaign_limits`	Changes the schedule and entry limits.	Campaigns: write
`claimr_get_login_requirements`	Shows which social logins participants need, whether they’re mandatory, whether a Claimr account is needed to view the campaign, and which chains wallets can connect on.	Campaigns: read
`claimr_set_login_requirements`	Changes the login and network requirements.	Campaigns: write

Related pages: General campaign settings, Referral settings, Leaderboard, Campaign sign-in options.

Descriptions

Descriptions are the long, formatted texts shown on a campaign, its intro and referral pages, groups, quests, tasks, tournaments, and completion pop-ups.

Tool	What it does	Access
`claimr_get_description`	Reads a description as plain text.	Read access to the area of the item
`claimr_set_description`	Writes a description. Writing a pop-up description also turns the pop-up on.	Write access to the area of the item
`claimr_clear_description`	Removes a description, or only one translation of it. Clearing a pop-up description also turns the pop-up off.	Write access to the area of the item

The area depends on what the description belongs to: Campaigns for campaigns and groups, Quests for quests and tasks, Tournaments for tournaments.

Descriptions are read and written as plain text. Writing a new description replaces any formatting, images, or links added in the panel.

Images

Tool	What it does	Access
`claimr_update_image`	Replaces an uploaded image in place, for example to shrink a large quest image. When the format stays the same, the image URL doesn’t change and every item using it updates.	Campaigns: write
`claimr_delete_image`	Permanently deletes an uploaded image. Refuses while a quest, task, tier, team, item, pre-quest, or the campaign still uses it.	Campaigns: write