Skip to main content
POST
Add companies to data source

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.

Path Parameters

sid
string
required

The find_people source (ds_sc_) whose stored filter walks the companies; any other kind is 422. One that failed plan_failed carries no plan and plans again on its description.

Required string length: 18
Pattern: ^ds_sc_

Body

application/json

Request body of add_companies_to_data_source.

company_sids
string[]

Companies to search at (cr_co_…, from the companies grid); duplicates and sids already queued are ignored. Required unless company_filter is given.

Required array length: 1 - 500 elements
Required string length: 18
Pattern: ^cr_co_
company_filter
object

An account filter resolved at the call, instead of (or with) company_sids: the search_companies filter object as is (the silent accounts of this table, never a list of sids). Past 500 matches the call is 422 rule max; matches already queued are skipped.

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
object | null
required
result
object
required
meta
object
required