v1

latestOpenAPI 3.0.32026-07-24368.6 KB

Submit bulk topic file or list

Submit a list of topic_ids via JSON or upload a CSV file.

S3 member delivery:

  • JSON requests: set deliver_to_s3: true in the body.
  • CSV uploads: optionally pass ?deliver_to_s3=true as a query parameter.

Delivery occurs only if your organization has a valid S3 destination configured.

post/bulk

Query parameters

deliver_to_s3boolean

Optional per-request toggle for CSV/multipart submissions. If also set in JSON, the JSON body value wins.

Request body

topic_idsstring[] required
callback_urlstring uri
deliver_to_s3boolean

Per-request S3 delivery toggle. If true, results are copied to your org's configured S3 under outgoing/apis/market_pulse/<process_id>/.... This ORs with the org-level setting.

Response

Accepted

process_idstring uuid required
status_urlstring uri

Poll this endpoint for status.

state'QUEUED' | 'RUNNING' | 'COMPLETE' | 'FAILED'

Example response

{
  "status_url": "https://api.5x5api.com/topic/bulk/930a0113-12fe-483b-a385-45e5ed0da486",
  "state": "QUEUED"
}