BRbrandbooster
remy
remy

Update Campaign Endpoint

Changed on

Update one of this user's own campaigns. Global campaigns can't be edited here.

put/api/v1/remy/campaigns/{campaign_id}

Request

  • Base URL
    https://api.brandbooster.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.brandbooster.ai/api/v1/remy/campaigns/{campaign_id}
  • Auth
    HTTP bearer

Path parameters

campaign_idstring required

Request body

namestring nullable
brand_namestring nullable
product_namestring nullable
collab_type'Paid Reel' | 'Paid Story' | 'Paid Post' | 'Barter' | 'Affiliate'
briefstring nullable
user_instructionstring nullable
knowledge_basestring nullable
budget_minnumber nullable
budget_maxnumber nullable
currency'INR' | 'USD' | 'GBP' | 'EUR'
total_budgetnumber nullable
status'active' | 'paused' | 'completed' | 'archived'

Response

Successful Response

idstring required
scopestring required
user_idstring nullable
namestring required
brand_namestring nullable
product_namestring nullable
collab_typestring nullable
briefstring nullable
user_instructionstring nullable
knowledge_basestring nullable
budget_minnumber nullable
budget_maxnumber nullable
currencystring nullable
total_budgetnumber
total_spentnumber
statusstring required
autopilot_enabledboolean
created_atstring date-time nullable
updated_atstring date-time nullable

Changes

  • c7202552278dRevision changes
    • info

      added the optional property to the response with the status

  • fff247daebe7Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status