API docs by Redocly

Giveaways API (2.0.0)

Download OpenAPI specification:Download

Responsible for managing giveaway campaigns and their members

Campaign

Creates an campaign

Authorizations:
Api-Token
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w
Request Body schema: application/json
required
name
required
string
description
required
string
image
required
string
startAt
required
string <date-time>
endAt
required
string <date-time>
campaignId
string
showFinePrint
boolean
hasDailyDrawing
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "New Campaign",
  • "description": "A new giveaway campaign!",
  • "image": "https://images.com/image",
  • "startAt": "2022-02-22",
  • "endAt": "2024-02-22",
  • "campaignId": "7018G000000F5wYQAS",
  • "showFinePrint": true,
  • "hasDailyDrawing": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Retrieves campaigns

Authorizations:
Api-Token
path Parameters
id
required
string
Example: 838dfbf6-d21d-11ec-a880-0242ac120005
query Parameters
page
integer
Example: page=1
perPage
integer
Example: perPage=25
filter
string
Example: filter=active
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w

Responses

Response samples

Content type
application/json
{
  • "links": {
    },
  • "data": [
    ],
  • "meta": {
    }
}

Retrieves a campaign

Authorizations:
Api-Token
path Parameters
id
required
string
Example: 838dfbf6-d21d-11ec-a880-0242ac120005
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Updates a campaign

Authorizations:
Api-Token
path Parameters
id
required
string
Example: 838dfbf6-d21d-11ec-a880-0242ac120005
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w
Request Body schema: application/json
required
name
string
description
string
image
string
startAt
string <date-time>
endAt
string <date-time>
campaignId
string
showFinePrint
boolean
hasDailyDrawing
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "New Campaign",
  • "description": "A new giveaway campaign!",
  • "image": "https://images.com/image",
  • "startAt": "2022-02-22",
  • "endAt": "2024-02-22",
  • "campaignId": "7018G000000F5wYQAS",
  • "showFinePrint": true,
  • "hasDailyDrawing": true
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Deletes a campaign

Authorizations:
Api-Token
path Parameters
id
required
string
Example: 838dfbf6-d21d-11ec-a880-0242ac120005
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Member

Adds a member to a campaign

Authorizations:
Api-Token
path Parameters
id
required
string
Example: 838dfbf6-d21d-11ec-a880-0242ac120005
header Parameters
Accept
required
string
Example: application\json
Content-Type
required
string
Example: application\json
Api-Token
required
string
Example: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHAiOiJsb2NhbCIsInVybCI6Imh0dHA6XC9cL2xvY2FsaG9zdDo4MDgwIiwianRpIjoiOWZjN2E1MjQtOTgzOC0xMWVkLTgzZjItMDI0MmFjMTUwMDA0IiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwODAiLCJpYXQiOjE2NzQxNjA0NDgsImV4cCI6NDgyOTgzNDA0OH0.BAPGm_fdnya7F9QmguXU5JvaBEccEPTH03V0zqYfR7w
Request Body schema: application/json
required
memberId
required
string

Responses

Request samples

Content type
application/json
{
  • "memberId": "001K000001ZhzcKIAR"
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}