campaigns
developer-api
product-api

Patch Campaign

Partially update a campaign.

patch/v1/campaigns/{campaign_id}

Request

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

Path parameters

campaign_idstring required

Headers

x-api-keystring nullable

Request body

titlestring nullable
descriptionstring nullable
systemstring nullable
summarystring nullable
languagestring nullable
chat_tonestring nullable
campaign_tonestring nullable
entities_tonestring nullable
ai_image_genboolean nullable
publicboolean nullable
matureboolean nullable

Response

Successful Response

created_atstring date-time required
updated_atstring date-time nullable
idstring required
titlestring required
descriptionstring nullable
systemstring
summarystring nullable
languagestring
publicboolean
matureboolean
owner_idstring required
imagestring nullable
archivedboolean
archived_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.