Skip to main content
POST
Create stoplist entries

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Body

application/json

Request body of create_stoplist_entry.

identifier_type
enum<string>
required

The kind of ALL values in the call: ln_member_id (digits, or a profile, Sales Navigator or Recruiter URN, bare or in a URL), email, domain (the company and everyone by email domain), ln_nickname (profile slug/URL), company_ln_nickname (page slug/URL).

Available options:
ln_member_id,
email,
domain,
ln_nickname,
company_ln_nickname
values
string[]
required

1..500 identifiers, normalized server-side: ln_member_id to the base-10 id (a known URN decodes, a slug is a per-index 422); email trimmed and lowercased; domain to the bare host (punycode); a nickname kind to its lowercased slug (a URL reduces to it).

Required array length: 1 - 500 elements
Required string length: 1 - 511
source
enum<string>

Say the batch was read out of a file: csv_import. Omit it for a typed or pasted list (the server stamps manual, or api for an API-token actor). The only value a caller may name; it changes how rows read back in search and counts, never how values match.

Available options:
csv_import

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
items
object[]
required

One element per distinct normalized value, in input order (in-batch duplicates collapse).

created_count
integer
required

New rows inserted by this call.

Required range: x >= 0
already_listed_count
integer
required

Values that were already live on the list (existing rows returned, nothing re-inserted).

Required range: x >= 0
meta
object
required