Skip to main content
PATCH
Update 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

Data source sid (ds_sc_…).

Required string length: 18
Pattern: ^ds_sc_

Body

application/json

Request body of update_data_source.

name
string

New display name (1..255).

Required string length: 1 - 255
status
enum<string>

User transitions only: pause / resume, and failed to active (re-arms the collect clock after a config fix). Anything else is 422 invalid_transition; completed is system-set.

Available options:
active,
paused
field_mapping
object[] | null

Full-replace of the mapping; affects pending + retried rows only, never already-promoted ones.

payload
object

Merged into the stored payload, only the keys the kind lets a caller change: ai_search {prompt}, sender_search {repeat, url}, post_engagement {repeat, window, relevance, collect}, find_people {per_company_limit, prompt}, webhook {records_path}; else 422.

tag_sids
string[] | null

Full-replace of the tag array; applies to future promotions.

Required string length: 18
Pattern: ^cr_tg_
on_duplicate
enum<string>

New duplicate-person policy for the rows promoted from now on.

Available options:
skip,
move
add_tags_to_duplicate
boolean

Merge tag_sids onto matched duplicates from now on.

qualify
object | null

The whole {on, criterion} block, or null to switch the check off; applies to rows not yet promoted.

sender_profile_sid
string | null

Reassign the sender profile of a sender_search or a post_engagement (ub_sp_): the checks run again (linkedin_account_missing, sales_nav_required, recruiter_required, recruiter_signed_out). Those two kinds must keep one; any other kind keeps it null.

Required string length: 18
Pattern: ^ub_sp_

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.