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

Workflow source sid (wf_sr_…).

Required string length: 18
Pattern: ^wf_sr_

Body

application/json

Request body of update_workflow_source.

event
enum<string>

type=event only: replace the enrolling activity type.

Available options:
linkedin_connection_request_accepted,
linkedin_message_replied,
linkedin_inmail_replied,
email_replied,
email_opened,
email_link_clicked,
linkedin_invitation_received,
linkedin_followed,
website_visited,
website_key_page_visited,
website_form_submitted
name
string | null

New label; null clears it.

Required string length: 1 - 255
auto_add
boolean

Poller toggle. Turning it on enqueues an immediate sweep; true on a manual source → 422.

view_sid
string

Repoint a type=view source at another live view (pt_vw_…). Sent on a non-view source → 422; cannot be nulled - a view source always points at a view.

Required string length: 18
Pattern: ^pt_vw_
filter
object

Full replace of a type=filter source's AST (not a merge). Sent on a non-filter source → 422. The next cycle honors it; already-enrolled records untouched.

active_limit
integer | null

Enrollment throttle: max simultaneous in-flight records from this source; null clears it (unlimited). Lowering below current in-flight evicts no one - new entries just wait.

Required range: x >= 1
coworkers_limit
integer | null

Enrollment throttle: max simultaneous in-flight records from this source per company; null clears it (unlimited).

Required range: x >= 1

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.