guided-workflow

Start Target Audience Job

Start asynchronous target audience generation and return job tracking info.

post/api/guided-workflow/generate-target-audience/job

Request

  • Base URL: https://api.usepomo.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.usepomo.ai/api/guided-workflow/generate-target-audience/job
  • Auth: HTTP bearer

Query parameters

force_refreshboolean

Force regeneration of target audiences

Request body

user_promptstring nullable

Optional user prompt to guide target audience generation

product_offering_idstring uuid nullable

Product offering ID (UUID). Omit/null for company-wide targeting

product_offering_namestring nullable

Product offering name for reference

pinned_audiencesobject[] nullable

List of audience objects to keep; generator will refresh remaining slots

locationsobject[] nullable

Structured campaign scope locations to use when generating local audiences

target_locationsobject[] nullable

Deprecated alias for locations

user_provided_locationsboolean

Whether the user explicitly selected campaign scope locations

Response

Successful Response

job_idstring required

Unique job identifier

statusstring required

Initial job status (typically 'running')

stream_urlstring required

SSE endpoint for real-time progress

poll_urlstring required

HTTP endpoint for polling status

Example response

{
  "job_id": "987fcdeb-51a2-43f7-9876-543210987654",
  "poll_url": "/api/chat/agentic/jobs/987fcdeb-51a2-43f7-9876-543210987654",
  "status": "running",
  "stream_url": "/api/chat/agentic/jobs/987fcdeb-51a2-43f7-9876-543210987654/stream"
}

Changes

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