Create a campaign

POST 
/api/campaign

Create a new campaign with the provided information

Request

application/json

Body

required

name stringrequired

The name of the campaign.

influencer_id uuidrequired

The id of the influencer.

details stringrequired

The details of the campaign.

image urlrequired

Optional main image of the campaign

images object[]
An array of images associated with the campaign. Image URLs should be obtained by uploading images using the /api/image method.
Array [
url urlrequired
The URL of the campaign image/video.
caption stringrequired
The caption of the campaign image/video.
]
videos object[]
An array of videos associated with the campaign. Video URLs should be obtained by uploading videos using the /api/video method.
Array [
url urlrequired
The URL of the campaign image/video.
caption stringrequired
The caption of the campaign image/video.
]
budget objectrequired

Amount object

value stringrequired

The value of the amount.

currency stringrequired

The currency of the amount.

product_id uuidrequired

The id of the product.

company_id uuidrequired

The unique identifier of the company.

categories CampaignCategory[]required

Possible values: [art_and_design, automobiles, beauty, beverages, books_and_literature, career_and_business, children_toys_and_games, diy, e_commerce, education, events_and_entertainment, fashion, finance_and_insurance, food, gardening_and_outdoor, health_and_fitness, hobbies_and_crafts, home_and_living, home_appliences, legal_services, mobile_games, news, non_profit_and_charity, office_supplies, parenting_and_family_products, personal_development, pets, photography, podcasts, real_estate, social_media_tools, sports_and_outdoor_activities, streaming, subscription_box, technology, travel, video_games, wedding]

The categories of the campaign.

restrictions CampaignRestriction[]required

Possible values: [eco_friendly, no_animal_testing, halal, kosher, vegan, vegetarian, lgbtq, diverse_leadership]

The restrictions of the campaign.

Responses

200

Created campaign

application/json

Schema

Schema

id uuidrequired

The unique identifier of the campaign.

name stringrequired

The name of the campaign.

influencer_id uuidrequired

The id of the influencer.

image urlrequired

Optional main image of the campaign

company_id uuidrequired

The unique identifier of the company.

details stringrequired

The details of the campaign.

images object[]required
An array of images associated with the campaign.
Array [
id uuidrequired
The unique identifier of the campaign media.
campaign_id uuidrequired
The unique identifier of the campaign.
url urlrequired
The URL of the campaign media.
status CampaignMediaStatusrequired
Possible values: [waiting_user_approval, approved, declined]
Campaign media status
caption stringrequired
The caption of the campaign media.
]
videos object[]required
An array of videos associated with the campaign.
Array [
id uuidrequired
The unique identifier of the campaign media.
campaign_id uuidrequired
The unique identifier of the campaign.
url urlrequired
The URL of the campaign media.
status CampaignMediaStatusrequired
Possible values: [waiting_user_approval, approved, declined]
Campaign media status
caption stringrequired
The caption of the campaign media.
]
budget objectrequired

Amount object

value stringrequired

The value of the amount.

currency stringrequired

The currency of the amount.

product_id uuidrequired

The id of the product.

status CampaignStatusrequired

Possible values: [created, running, completed, stopped]

Campaign status

categories CampaignCategory[]required

Possible values: [art_and_design, automobiles, beauty, beverages, books_and_literature, career_and_business, children_toys_and_games, diy, e_commerce, education, events_and_entertainment, fashion, finance_and_insurance, food, gardening_and_outdoor, health_and_fitness, hobbies_and_crafts, home_and_living, home_appliences, legal_services, mobile_games, news, non_profit_and_charity, office_supplies, parenting_and_family_products, personal_development, pets, photography, podcasts, real_estate, social_media_tools, sports_and_outdoor_activities, streaming, subscription_box, technology, travel, video_games, wedding]

The categories of the campaign.

restrictions CampaignRestriction[]required

Possible values: [eco_friendly, no_animal_testing, halal, kosher, vegan, vegetarian, lgbtq, diverse_leadership]

The restrictions of the campaign.

start_time_utc date-timerequired

The start time of the campaign.

end_time_utc date-timerequired

The end time of the campaign.

Example (from schema)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "influencer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "image": "string",
  "company_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "details": "string",
  "images": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "campaign_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "url": "string",
      "status": "waiting_user_approval",
      "caption": "string"
    }
  ],
  "videos": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "campaign_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "url": "string",
      "status": "waiting_user_approval",
      "caption": "string"
    }
  ],
  "budget": {
    "value": "string",
    "currency": "string"
  },
  "product_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "created",
  "categories": [
    "art_and_design"
  ],
  "restrictions": [
    "eco_friendly"
  ],
  "start_time_utc": "2024-09-13T10:30:55.752Z",
  "end_time_utc": "2024-09-13T10:30:55.753Z"
}

402

You have insufficient funds to create a campaign. Please top up your balance.

422

Influencer / Company / Product not found.

application/json

Schema

Schema

code int32required

The error code

message stringrequired

A human-readable error message

Example (from schema)

{
  "code": 0,
  "message": "string"
}

default

Unexpected error

application/json

Schema

Schema

code int32required

The error code

message stringrequired

A human-readable error message

Example (from schema)

{
  "code": 0,
  "message": "string"
}

Loading...