v1

latestOpenAPI 3.1.02026-07-26950137.9 KB

Create a Campaign Item

Submit a JSON object with the campaign item URL in the request body.

Returns the newly created Campaign Item as a JSON object in the response body.

post/backstage/api/1.0/{account_id}/campaigns/{campaign_id}/items/

Path parameters

account_idstring required

An alphabetic ID. See Get Account Details.

campaign_idstring required

A numeric ID.

Request body

RAW_BODYstring json required

A JSON object with the campaign item URL.

Response

200

idstring

campaign_idstring

typestring

urlstring

{"stackTrail":"paths:/backstage/api/1.0/{account_id}/campaigns/{campaign_id}/items/:post:responses:200:content:application/json:schema:properties:thumbnail_url","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/backstage/api/1.0/{account_id}/campaigns/{campaign_id}/items/:post:responses:200:content:application/json:schema:properties:title","oasType":"schema","type":"unknown"}

approval_statestring

is_activeboolean

statusstring

Example response

{
  "id": "1",
  "campaign_id": "1234",
  "type": "ITEM",
  "url": "http://news.example.com/demo_article.html",
  "approval_state": "PENDING",
  "is_active": true,
  "status": "CRAWLING"
}