Skip to main content
PATCH
Updates mutable Target metadata. Query criteria, kind, and the Target’s member rows cannot be changed here.

Request

string
required
Target UUID.
The JSON body is an object with no required properties and no unknown top-level properties:
boolean
Optional. If omitted, retains the current value. true admits future discovered members as watching and immediately promotes existing proposed members. false changes future discovery to proposed; it does not demote existing watching members or undo previous admissions. excluded members stay excluded.
string
Optional display name, 1–80 characters before trimming. The service trims a non-empty value. A whitespace-only value passes the JSON length check but falls back to the existing title. If omitted, the current title is retained.
An empty {} is valid, but when auto_admit is already true it can still promote currently proposed members and synchronize generated lists. It is not guaranteed to have no side effects.

Response

200 OK returns { "data": Target }, including counts, stored query, allocation fields, and the latest job summary. See Get target for the complete schema. job.id, job.phase, job.error, and linkedin_url are nullable; the other documented Target fields are non-null.

Examples

Lifecycle, side effects, and retry safety

The update writes auto_admit and title. Renaming also renames the default list associated with the Target. Turning auto_admit on synchronously promotes currently proposed members and synchronizes lists. Turning it off is not a rollback of prior admissions. This PATCH does not itself enqueue enrichment for the members it promotes; use the member-status operation or later worker processing for that work. Promotion is not an enrichment-completion signal. Do not blindly replay a timed-out PATCH. A retry may rename a list or promote members after the first request already succeeded. Re-read the Target and compare name/auto_admit first. The operation has no idempotency key.

Errors and recovery

  • 400 invalid_request: invalid JSON, wrong type, or a string outside the declared length. Fix the body.
  • 401 unauthorized, 402 payment_required: fix API key or organization access.
  • 404 not_found: the Target is not in the authenticated organization. Do not retry unchanged.
  • 429/5xx: for a known-safe read, back off; for an uncertain update, reconcile with Get target before retrying.

Next