Skip to content

Update Deal Automations

PUT
/profile/deal-automations

Configure the calendar-driven deal automations.

Read dry_run before turning anything on: with it set, the automation reports what it WOULD do and creates nothing. auto_close_deal_on_acceptance is the one to be most careful with - it moves a deal to closed without a human in the loop.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors user_profile.DealAutomationsUpdateRequest.

sync_interval_minutes is closed to SYNC_INTERVAL_CHOICES. The app’s own validator raises a ValueError for anything else, which - raised while the proxy builds the app model - would escape as a 500.

object
pipelines
Any of:
object
key
additional properties

Mirrors user_profile.PipelineAutomationBlock.

dry_run is the safety switch: with it on, the automation reports what it WOULD do and creates nothing.

object
auto_advance_deal_on_quote_send
boolean
auto_close_deal_on_acceptance
boolean
auto_draft_quote
boolean
dry_run
boolean
enabled
boolean
generate_scope_of_work
boolean
title_keywords

Meeting-title keywords that count. At most 10; each is trimmed to 100 characters and duplicates are dropped case-insensitively.

Array<string>
<= 10 items
sync_interval_minutes
Any of:
integer

Responses

200

Successful Response

object
data
required

An open envelope for a single role, team, member or account record.

Open on purpose. The app’s own response models on this surface grow with the product - RoleResponse gained rep_limits and manages_role_slugs, TeamResponse gained channel counts and a campaign count - and a pinned mirror would SILENTLY DROP whatever it had not caught up on. A dropped permission in a role read is the worst possible kind of stale: it reads as “they do not have it”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string