GEgetsales
workflow_sources

Update workflow source

Rename, toggle auto_add, repoint view_sid (type=view) or replace filter (type=filter) - a payload key that does not match the source's immutable type → 422. Takes effect next poll cycle; turning auto_add on enqueues an immediate sweep. Already-enrolled records are never touched - entry is one-way (removal = workflow-records exit). Use {auto_add:false} to stop new entries while journeys keep running (NOT workflows pause - that freezes dispatch). Archived parent → 409 conflict.

Contract:

  • MCP tool update_workflow_source, registry package mcp.playtables/workflow_sources, mount playtables.workflows.
  • Operation update, response envelope update.
  • Flags: none.
patch/api/workflow-sources/{sid}

Request

  • Base URL
    https://beta.getsales.io/playtables/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Path parameters

sidstring required

Workflow source sid (wf_sr_…).

Request body

event'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'

type=event only: replace the enrolling activity type.

namestring nullable

New label; null clears it.

auto_addboolean

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

view_sidstring

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.

active_limitinteger nullable

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.

coworkers_limitinteger nullable

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

Response

update success envelope.

successtrue required
operation'update' required
updated_fieldsstring[] required
previous_valuesobject required
kept_fieldsstring[]

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

Changes

No recorded changes to this operation across all 1 revision of this API.