Campaign Keys

Campaign key management operations

Get campaign keys by key

get

/api/campaigns/keys

Retrieve campaign keys by key value

Responses

200

Campaign keys

application/json

okbooleanOptionalExample: true

500

Internal server error

application/json

get/api/campaigns/keys

GET /api/campaigns/keys HTTP/1.1
Host: rewards.decentraland.org
Accept: */*

{
  "ok": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "campaign_id": "123e4567-e89b-12d3-a456-426614174000",
      "campaign_key": "eyJpZ...tm6QE=",
      "enabled": true,
      "active_since": "2024-01-01T00:00:00Z",
      "active_until": "2024-12-31T23:59:59Z",
      "requires_authentication": false,
      "requires_captcha": false,
      "requires_catalyst": false,
      "requires_position": "*",
      "assign_target": "0x1234567890123456789012345678901234567890",
      "assign_value": "1",
      "assign_group": "premium",
      "assign_limit": 100,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}

Get campaign keys

get

/api/campaigns/{campaign_id}/keys

Retrieve all keys for a specific campaign. campaign_key is only included for roles allowed to see campaign keys; it is omitted for any other role, such as viewer.

Path parameters

campaign_idstring · uuidRequired

Campaign ID

Responses

200

Campaign keys

application/json

okbooleanOptionalExample: true

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/api/campaigns/{campaign_id}/keys

GET /api/campaigns/{campaign_id}/keys HTTP/1.1
Host: rewards.decentraland.org
Accept: */*

{
  "ok": true,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "campaign_id": "123e4567-e89b-12d3-a456-426614174000",
      "campaign_key": "eyJpZ...tm6QE=",
      "enabled": true,
      "active_since": "2024-01-01T00:00:00Z",
      "active_until": "2024-12-31T23:59:59Z",
      "requires_authentication": false,
      "requires_captcha": false,
      "requires_catalyst": false,
      "requires_position": "*",
      "assign_target": "0x1234567890123456789012345678901234567890",
      "assign_value": "1",
      "assign_group": "premium",
      "assign_limit": 100,
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}

Create campaign key

post

/api/campaigns/{campaign_id}/keys

Create a new key for a campaign

Path parameters

campaign_idstring · uuidRequired

Campaign ID

Body

keystring · min: 1Required

Campaign key value

Example: summer2024

enabledbooleanOptional

Whether the key is enabled

Default: trueExample: true

active_sincestring · date-time · nullableOptional

Key activation time

Example: 2024-01-01T00:00:00Z

active_untilstring · date-time · nullableOptional

Key expiration time

Example: 2024-12-31T23:59:59Z

requires_authenticationbooleanOptional

Whether the key requires user authentication

Default: falseExample: false

requires_captchabooleanOptional

Whether the key requires captcha verification

Default: falseExample: false

requires_catalystbooleanOptional

Whether the key requires catalyst verification

Default: falseExample: false

requires_positionstring · nullableOptional

Required position for catalyst verification

Example: *

assign_targetstring · address · nullableOptional

Target contract for reward assignment

Example: 0x1234567890123456789012345678901234567890

assign_valuestring · nullableOptional

Value for reward assignment

Example: 1

assign_groupstring · nullableOptional

Group for reward assignment

Example: premium

assign_limitnumber · nullableOptional

Assignment limit for the key

Example: 100

Responses

201

Campaign key created successfully

application/json

okbooleanOptionalExample: true

400

Bad request

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

post/api/campaigns/{campaign_id}/keys

POST /api/campaigns/{campaign_id}/keys HTTP/1.1
Host: rewards.decentraland.org
Content-Type: application/json
Accept: */*
Content-Length: 342

{
  "key": "summer2024",
  "enabled": true,
  "active_since": "2024-01-01T00:00:00Z",
  "active_until": "2024-12-31T23:59:59Z",
  "requires_authentication": false,
  "requires_captcha": false,
  "requires_catalyst": false,
  "requires_position": "*",
  "assign_target": "0x1234567890123456789012345678901234567890",
  "assign_value": "1",
  "assign_group": "premium",
  "assign_limit": 100
}

{
  "ok": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "campaign_id": "123e4567-e89b-12d3-a456-426614174000",
    "campaign_key": "eyJpZ...tm6QE=",
    "enabled": true,
    "active_since": "2024-01-01T00:00:00Z",
    "active_until": "2024-12-31T23:59:59Z",
    "requires_authentication": false,
    "requires_captcha": false,
    "requires_catalyst": false,
    "requires_position": "*",
    "assign_target": "0x1234567890123456789012345678901234567890",
    "assign_value": "1",
    "assign_group": "premium",
    "assign_limit": 100,
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}

Get campaign key details

get

/api/campaigns/{campaign_id}/keys/{campaign_key_id}

Retrieve detailed information about a specific campaign key. campaign_key is only included for roles allowed to see campaign keys; it is omitted for any other role, such as viewer.

Path parameters

campaign_idstring · uuidRequired

Campaign ID

campaign_key_idstring · uuidRequired

Campaign Key ID

Responses

200

Campaign key details

application/json

okbooleanOptionalExample: true

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get/api/campaigns/{campaign_id}/keys/{campaign_key_id}

GET /api/campaigns/{campaign_id}/keys/{campaign_key_id} HTTP/1.1
Host: rewards.decentraland.org
Accept: */*

{
  "ok": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "campaign_id": "123e4567-e89b-12d3-a456-426614174000",
    "campaign_key": "eyJpZ...tm6QE=",
    "enabled": true,
    "active_since": "2024-01-01T00:00:00Z",
    "active_until": "2024-12-31T23:59:59Z",
    "requires_authentication": false,
    "requires_captcha": false,
    "requires_catalyst": false,
    "requires_position": "*",
    "assign_target": "0x1234567890123456789012345678901234567890",
    "assign_value": "1",
    "assign_group": "premium",
    "assign_limit": 100,
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}

Delete campaign key

delete

/api/campaigns/{campaign_id}/keys/{campaign_key_id}

Delete a campaign key

Path parameters

campaign_idstring · uuidRequired

Campaign ID

campaign_key_idstring · uuidRequired

Campaign Key ID

Responses

200

Campaign key deleted successfully

application/json

okbooleanOptionalExample: true

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

delete/api/campaigns/{campaign_id}/keys/{campaign_key_id}

DELETE /api/campaigns/{campaign_id}/keys/{campaign_key_id} HTTP/1.1
Host: rewards.decentraland.org
Accept: */*

{
  "ok": true
}

Update campaign key

patch

/api/campaigns/{campaign_id}/keys/{campaign_key_id}

Update campaign key configuration

Path parameters

campaign_idstring · uuidRequired

Campaign ID

campaign_key_idstring · uuidRequired

Campaign Key ID

Body

keystring · min: 1Optional

Campaign key value

Example: summer2024

enabledbooleanOptional

Whether the key is enabled

Example: true

active_sincestring · date-time · nullableOptional

Key activation time

Example: 2024-01-01T00:00:00Z

active_untilstring · date-time · nullableOptional

Key expiration time

Example: 2024-12-31T23:59:59Z

requires_authenticationbooleanOptional

Whether the key requires user authentication

Example: false

requires_captchabooleanOptional

Whether the key requires captcha verification

Example: false

requires_catalystbooleanOptional

Whether the key requires catalyst verification

Example: false

requires_positionstring · nullableOptional

Required position for catalyst verification

Example: *

assign_targetstring · address · nullableOptional

Target contract for reward assignment

Example: 0x1234567890123456789012345678901234567890

assign_valuestring · nullableOptional

Value for reward assignment

Example: 1

assign_groupstring · nullableOptional

Group for reward assignment

Example: premium

assign_limitnumber · nullableOptional

Assignment limit for the key

Example: 100

Responses

200

Campaign key updated successfully

application/json

okbooleanOptionalExample: true

400

Bad request

application/json

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

patch/api/campaigns/{campaign_id}/keys/{campaign_key_id}

PATCH /api/campaigns/{campaign_id}/keys/{campaign_key_id} HTTP/1.1
Host: rewards.decentraland.org
Content-Type: application/json
Accept: */*
Content-Length: 342

{
  "key": "summer2024",
  "enabled": true,
  "active_since": "2024-01-01T00:00:00Z",
  "active_until": "2024-12-31T23:59:59Z",
  "requires_authentication": false,
  "requires_captcha": false,
  "requires_catalyst": false,
  "requires_position": "*",
  "assign_target": "0x1234567890123456789012345678901234567890",
  "assign_value": "1",
  "assign_group": "premium",
  "assign_limit": 100
}

{
  "ok": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "campaign_id": "123e4567-e89b-12d3-a456-426614174000",
    "campaign_key": "eyJpZ...tm6QE=",
    "enabled": true,
    "active_since": "2024-01-01T00:00:00Z",
    "active_until": "2024-12-31T23:59:59Z",
    "requires_authentication": false,
    "requires_captcha": false,
    "requires_catalyst": false,
    "requires_position": "*",
    "assign_target": "0x1234567890123456789012345678901234567890",
    "assign_value": "1",
    "assign_group": "premium",
    "assign_limit": 100,
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}