Jobs

Map up to 20,000 inputs to places as a job

Submits postcodes, official codes and place ids (1 to 20000) to be resolved to places with their stored signals, and returns a job at once (HTTP 202). Poll GET /v1/jobs/:id for status and read the result in pages from GET /v1/jobs/:id/rows. With portfolio_id, every resolved input is added to that portfolio with its place_id. Metered by resolved row when the job completes. Up to 1,000 inputs can instead resolve synchronously at POST /v1/places/map.

post/v1/jobs/portfolio-map

Request

  • Base URL: https://api.onegoodarea.com
  • URL: https://api.onegoodarea.com/v1/jobs/portfolio-map
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

inputsstring[] required
portfolio_idstring

Response

Default Response

notesstring[] required

Changes

No recorded changes to this operation across all 2 revisions of this API.