Campaign Users

Campaign user management

Get campaign users

get

https://rewards.decentraland.orghttps://rewards.decentraland.zonehttp://localhost:8000

/api/campaigns/{campaign_id}/users

Retrieve users associated with a campaign

Path parameters

campaign_idstring · uuidRequired

Campaign ID

Responses

200

Campaign users

application/json

okbooleanOptionalExample: true

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/api/campaigns/{campaign_id}/users

HTTPcURLJavaScriptPython

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

{
  "ok": true,
  "data": [
    {
      "campaign_id": "123e4567-e89b-12d3-a456-426614174000",
      "user": "0x1234567890123456789012345678901234567890",
      "role": "owner",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}

Create campaign users

post

https://rewards.decentraland.orghttps://rewards.decentraland.zonehttp://localhost:8000

/api/campaigns/{campaign_id}/users

Add users to a campaign

Path parameters

campaign_idstring · uuidRequired

Campaign ID

Body

application/json

Responses

201

Campaign users created successfully

application/json

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}/users

HTTPcURLJavaScriptPython

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

{
  "users": [
    {
      "user": "0x1234567890123456789012345678901234567890",
      "role": "owner"
    }
  ]
}

{
  "ok": true,
  "data": [
    {
      "campaign_id": "123e4567-e89b-12d3-a456-426614174000",
      "user": "0x1234567890123456789012345678901234567890",
      "role": "owner",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}

Get campaign user

get

https://rewards.decentraland.orghttps://rewards.decentraland.zonehttp://localhost:8000

/api/campaigns/{campaign_id}/users/{user_id}

Retrieve a specific user from a campaign

Path parameters

campaign_idstring · uuidRequired

Campaign ID

user_idstringRequired

User ID

Responses

200

Campaign user

application/json

okbooleanOptionalExample: true

401

Unauthorized

application/json

404

Not found

application/json

500

Internal server error

application/json

get

/api/campaigns/{campaign_id}/users/{user_id}

HTTPcURLJavaScriptPython

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

{
  "ok": true,
  "data": {
    "campaign_id": "123e4567-e89b-12d3-a456-426614174000",
    "user": "0x1234567890123456789012345678901234567890",
    "role": "owner",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}

Remove campaign user

delete

https://rewards.decentraland.orghttps://rewards.decentraland.zonehttp://localhost:8000

/api/campaigns/{campaign_id}/users/{user_id}

Remove a user from a campaign

Path parameters

campaign_idstring · uuidRequired

Campaign ID

user_idstringRequired

User ID

Responses

200

Campaign user removed 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}/users/{user_id}

HTTPcURLJavaScriptPython

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

{
  "ok": true
}

Update campaign user

patch

https://rewards.decentraland.orghttps://rewards.decentraland.zonehttp://localhost:8000

/api/campaigns/{campaign_id}/users/{user_id}

Update user role in a campaign

Path parameters

campaign_idstring · uuidRequired

Campaign ID

user_idstringRequired

User ID

Body

application/json

rolestring · enumRequired

User role in the campaign

Example: ownerPossible values:

Responses

200

Campaign user 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}/users/{user_id}

HTTPcURLJavaScriptPython

PATCH /api/campaigns/{campaign_id}/users/{user_id} HTTP/1.1
Host: rewards.decentraland.org
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "role": "owner"
}

{
  "ok": true,
  "data": {
    "campaign_id": "123e4567-e89b-12d3-a456-426614174000",
    "user": "0x1234567890123456789012345678901234567890",
    "role": "owner",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z"
  }
}