---
title: "Map up to 20,000 inputs to places as a job"
method: POST
path: "/v1/jobs/portfolio-map"
tags: ["Jobs"]
---

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

`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

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.

## Request body

- object
  - `inputs` string[], required
  - `portfolio_id` string

## Response `202`

Default Response

- object
  - `job` object, required
    - `id` string, required
    - `kind` 'portfolio_map', required
    - `status` 'queued' | 'running' | 'succeeded' | 'failed', required
    - `attempts` integer, required
    - `progress` object, required
      - `total` integer, required
      - `done` integer, required
    - `summary` object, required
      - `count` integer, required
      - `resolved` integer, required
      - `ambiguous` integer, required
      - `not_found` integer, required
      - `with_signals` integer, required
      - `without_signals` integer, required
      - `portfolio` object, required
        - `id` string, required
        - `added` integer, required
        - `updated` integer, required
    - `error` string, required
    - `created_at` string, date-time, required
    - `started_at` string, date-time, required
    - `finished_at` string, date-time, required
  - `notes` string[], required
  - `meta` object, required
    - `engine_version` string, required
    - `generated_at` string, required

## Other responses

- `400`: Default Response
- `401`: Default Response
- `403`: Default Response
- `404`: Default Response
- `413`: Default Response
- `429`: Default Response
- `500`: Default Response

---

[API](https://skmtc.dev/onegoodarea/apis/onegoodarea-api.md) · [All operations](https://skmtc.dev/onegoodarea/apis/onegoodarea-api/llms.txt) · [OpenAPI document](https://skmtc.dev/onegoodarea/apis/onegoodarea-api/revisions/b318d28b3412?raw)