Theme switcher

Create note on conversation

Header Parameters

Authorizationstring Required

Query Parameters

user_emailstring

Email address of the inbox user to whom the Gmail Thread ID in conversation_id belongs. Required only when conversation_id is a Gmail Thread ID from that user’s own mailbox. If not passed, the Gmail Thread ID is treated as the shared mailbox’s thread ID.

Path Parameters

inboxIdinteger Required

ID of the shared inbox the conversation belongs to.

conversationIdinteger Required

Unique identifier of the conversation, which can be either a Hiver Conversation ID or a Gmail Thread ID.

Body Parameters

contentstring

Note body. Plain text, emoji, and a safe subset of HTML. Required if attachment is not sent.

mentionsarray

Emails of teammates to @mention.

notify_allboolean

Notifies every inbox member and surfaces @all in the notes.

parent_note_idstring

ID of a note in the same conversation to reply to (threaded).

attachmentsfile

File that needs to be attached to the note. Required if content is not sent.

Response

201
Object

Note created successfully

Response Attributes

dataobject
Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?