Campaigns

>>>

POST /api/admin/v1/campaigns
Create Campaign

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "success": true
}

Params

Param name Description
name
required

Validations:

  • Must be a String
hex_code
optional

Validations:

  • Must be a String
details
optional

Validations:

  • Must be a String
cover_image_s3_key
optional

Validations:

  • Must be a String
logo_s3_key
optional

Validations:

  • Must be a String
video_url
optional

Validations:

  • Must be a String
date_from
optional

Validations:

  • Must be a DateTime
date_to
optional

Validations:

  • Must be a DateTime
goal_amount
optional

Validations:

  • Must be a Integer
available_sums
optional

Validations:

  • Must be an array of any type
status
optional

Validations:

  • Must be a String
sponsorship_opportunity
optional

Validations:

  • Must be a String
workspace_id
required

Validations:

  • Must be a Integer
>>>

GET /api/admin/v1/campaigns/:id
Show Campaign

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "id": ID,
  "name": "NAME CAMPAIGN",
  "hex_code": "HEX CODE",
  "details": "DESCRIPTION",
  "cover_image_s3_key": "IMAGE URL",
  "logo_s3_key": "LOGO URL",
  "video_url": "VIDEO URL",
  "date_from": "2023-05-30T00:00:00.000Z",
  "date_to": "2024-05-30T00:00:00.000Z",
  "goal_amount": 1000,
  "available_sums": [
    50,
    75,
    100,
    250,
    500
  ],
  "prices": [
    {
      "value": 50,
      "price_id": "price_1NYVcMAxd7UNEmWNvN6hIIeq"
    },
    {
      "value": 75,
      "price_id": "price_1NYVcNAxd7UNEmWNiRBKBWQV"
    },
    {
      "value": 100,
      "price_id": "price_1NYVcNAxd7UNEmWN1V1EeWKi"
    },
    {
      "value": 250,
      "price_id": "price_1NYVcNAxd7UNEmWNCa26ZaoV"
    },
    {
      "value": 500,
      "price_id": "price_1NYVcOAxd7UNEmWNi7XNhi4J"
    }
  ],
  "price_id": "price_1NYVcOAxd7UNEmWN1rUMNm5x",
  "sponsorship_opportunity": "<p>Lorem Ipsum is simply dummy text of the printing and typesetting industry.</p>",
  "workspace_id": 1023,
  "workspace_name": "Workspace",
  "tax_deductible": false,
  "tax_id": null,
  "multi_sport": false,
  "disable_sponsor": false,
  "sponsors_exist": true
  "sports": [
    {
      "id": 1,
      "title": "Sport Football",
      "details": "Lorem ipsum detatils",
      "full_description": "Lorem ipsum full description",
      "image_s3_key": null,
      "cover_image_s3_key": "test.jpg",
      "video_url": "https://youtube.com"
    }...,
  ]
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer
>>>

PUT /api/admin/v1/campaigns/:id
Update Campaign

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "success": true
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer
campaigns
required

Validations:

  • Must be a Hash
campaigns[name]
required

Validations:

  • Must be a String
campaigns[hex_code]
optional

Validations:

  • Must be a String
campaigns[details]
optional

Validations:

  • Must be a String
campaigns[cover_image_s3_key]
optional

Validations:

  • Must be a String
campaigns[logo_s3_key]
optional

Validations:

  • Must be a String
campaigns[video_url]
optional

Validations:

  • Must be a String
campaigns[date_from]
optional

Validations:

  • Must be a DateTime
campaigns[date_to]
optional

Validations:

  • Must be a DateTime
campaigns[goal_amount]
optional

Validations:

  • Must be a Integer
campaigns[available_sums]
optional

Validations:

  • Must be an array of any type
campaigns[status]
optional

Validations:

  • Must be a String
campaigns[sponsorship_opportunity]
optional

Validations:

  • Must be a String
campaigns[workspace_id]
required

Validations:

  • Must be a Integer
>>>

DELETE /api/admin/v1/campaigns/:id
Delete Campaign

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  "success": true
}

Params

Param name Description
id
required

Validations:

  • Must be a Integer