public-api

Manage Publisher Shortlist Public

Read or change the brand's outreach publisher shortlist.

  • action='list': every publisher on the board with its status.
  • action='add': save a publisher (domain required). With a research_id from /discover-publishers, also pass article_idea, rationale and proposed_route to save the publishing idea with its evidence.
  • action='remove': take a shortlisted publisher off the board. Publishers already contacted, won, or holding tracked articles are kept.

Requires editor access for add and remove, and access to a paid brand.

post/publisher-shortlist/manage

Request

  • Base URL: https://api.trakkr.ai
  • URL: https://api.trakkr.ai/publisher-shortlist/manage
  • Auth: HTTP bearer

Request body

brand_idstring uuid required
action'list' | 'add' | 'remove' required
domainstring nullable
research_idstring uuid nullable
article_ideastring nullable
rationalestring nullable
proposed_routestring nullable

Response

Successful Response

actionstring nullable
domainstring nullable
shortlistobject[] nullable
countsobject nullable
already_on_shortlistboolean nullable
placement_plan_savedboolean nullable
removedboolean nullable
notestring nullable

Changes

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