Skip to content

Update Deal Note

PUT
/deals/{deal_id}/notes/{note_id}

Rewrite a note.

content is a full REPLACEMENT, not a patch, and mentioned_users is who is mentioned AFTER the edit - omitting someone removes their mention. Send the whole state you want, not the delta.

Authorizations

Parameters

Path Parameters

deal_id
required

Deal id.

string

Deal id.

note_id
required

Note id.

string

Note id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Rewrite a note’s body and its mentions.

object
content
required

Full replacement body - this is not a patch.

string
mentioned_users

Who is mentioned AFTER the edit. Omitting someone removes their mention, because the list replaces rather than adds.

Array<object>
object
email
Any of:
string
id
required
string
name
Any of:
string

Responses

200

Successful Response

object
data
required

Whatever the operation returns, carried through whole.

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
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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