Unlock (save) records for the workspace

Saves companies or contacts for the workspace. A record costs the
unlock price ONCE per workspace: a record that is already saved costs
nothing and stays saved. Send the record_id values of the preview
search (1 to 100). A record id with no data is not_found and costs
nothing.

Too few credits: 402 credits_exhausted and nothing is saved. Read
the saved records with the preview search (saved rows come back in
full) or with GET /v1/records/saved.

The record unlock covers the signals, the LinkedIn URL and the
profile. The contact email is an add-on (addons: ["email"]), bought
once per contact. No data, no charge: a contact with no email in our
data answers no_data for the add-on and costs nothing for it. Where
the stale-email rule is on for the workspace, an email at a company
the person left counts as no email (no_data, no charge). No
phone add-on exists (no phone data). dry_run: true prices the
request without charging or saving. Idempotency-Key makes a retry
return the first answer (409 when the key comes with another body).

Credit cost: the unlock price (default 2) per newly saved record,
plus the email price (default 3) per newly unlocked email.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
Allowed:
record_ids
array of strings
required
length between 1 and 100

The record_id values of the preview search. A company id is its domain.

record_ids*
addons
array of strings

Contacts only. email is sold; phone answers 400 addon_not_available (no phone data).

addons
Allowed:
boolean
Defaults to false

true = price the request only (no charge, no write).

Headers
string
length between 1 and 255

1-255 printable ASCII characters, per workspace, kept 24 hours. Ignored on a dry run.

Responses

404

The workspace is not in the rollout (the route does not exist for it).

409

idempotency_key_reused (the key came with another body) or idempotency_key_in_progress (the first request still runs; Retry-After: 2). Nothing charged.

503

unlock_unavailable, unlock_failed or unlock_busy: nothing was saved and no credits were charged. Retry.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json