Leave an internal note on a thread
add_noteLeaves a note on a thread for the people who work it: shown on the thread screen beside the messages, marked as internal, and in "notes" of get_conversation. It never reaches the correspondent: it is not sent, not quoted in a reply and not part of the mail. It is where the context goes when you hand a thread to a colleague, what you found, what was agreed, why you stopped. It does not change the status of the thread nor its place in the list. It is signed with the name of the person this connection acts for, when it acts for one. Up to 10000 characters. It can carry files for the team in "attachments" (a specification, a quote to prepare), named exactly as for reply_to_conversation; they stay with the note, are listed in its "files" by get_conversation and are never sent. To leave the same note on several threads, give conversation_id the list of their ids, in ONE call rather than one call per thread: the answer then lists in "results" the outcome of each thread in the order given ("ok", with its "result" or its "error") and counts "succeeded" and "failed". Each thread passes exactly the checks it would alone, so one refused or out of reach ("not found") leaves the others done, and the call is an error only when none succeeded.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | The text of the note, plain text, up to 10000 characters. | |
| attachments | No | Files for the team, joined to the note, up to 10 and 7 MiB in total. Each one is named EITHER by "upload_id", a file already pushed to a slot from create_attachment_upload, OR inline by "filename" and "content_base64". They are never sent to anyone. | |
| conversation_id | Yes | The id of the conversation, as list_conversations gives it, or a list of up to 50 ids to do the same to every one of them in a single call. |