Jobs

Import up to 1,000 contacts asynchronously

Async job pattern: accepts the items, returns 202 Accepted immediately with a job id and statusUrl (also sent as the Location header), and processes the import in the background. Poll GET /api/v1/jobs/{id} until status is completed or failed; the job result carries created/failed counts and up to 50 per-item errors. Items behave exactly like single POST /api/v1/contacts requests.

post/api/v1/imports/contacts

Request

  • Base URL: https://api.agendaforge.app
  • URL: https://api.agendaforge.app/api/v1/imports/contacts
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Headers

Idempotency-Keystring

Optional key for safe retries, retained for 24 hours. Repeating the same request on the same endpoint returns the original response and sets Idempotent-Replay: true. Reusing the key on a different endpoint returns 409.

Request body

Response

The job was accepted. Poll statusUrl (also in the Location header) for progress.

jobIdstring required

Opaque job id.

type'contacts_import' required
status'pending' required
totalinteger required

Items accepted for processing.

statusUrlstring uri required

Poll this URL (GET, same authentication) for progress.

Changes

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