> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/brand-api-reference/reference/notes/models.md).

# Models

## The Note object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Notes","version":"v14"},"components":{"schemas":{"Note":{"type":"object","properties":{"Id":{"type":"integer","description":"The unique identifier for the note."},"MediaId":{"type":"integer","description":"The unique identifier of the partner this note is about."},"MediaName":{"type":"string","description":"The display name of the partner this note is about."},"Creator":{"type":"string","description":"The name of the user who created the note."},"CreationDate":{"type":"string","format":"date-time","description":"The date and time the note was created."},"ModificationDate":{"type":"string","format":"date-time","description":"The date and time the note was last modified."},"Content":{"type":"string","description":"The plaintext content of the note."},"Type":{"type":"string","description":"The interaction type for this note.","enum":["EMAIL","IM","NONE","PHONE"]},"Attachments":{"type":"array","description":"URIs of file attachments associated with the note.","items":{"type":"string","format":"uri-reference"}},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to this note in the impact.com API."}}}}}}
```

## The NoteCreate object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Notes","version":"v14"},"components":{"schemas":{"NoteCreate":{"type":"object","required":["MediaId"],"properties":{"MediaId":{"type":"integer","description":"The partner account ID this note is for."},"Content":{"type":"string","description":"The plaintext content of the note. Optional if an Attachment is provided."},"Attachment":{"type":"string","format":"binary","description":"An image file to upload as an attachment. Optional if Content is provided."},"Type":{"type":"string","description":"The interaction type for this note.","enum":["EMAIL","IM","NONE","PHONE"],"default":"NONE"}}}}}}
```

## The NoteUpdate object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Notes","version":"v14"},"components":{"schemas":{"NoteUpdate":{"type":"object","properties":{"Content":{"type":"string","description":"The new plaintext content for the note."},"Type":{"type":"string","description":"The interaction type for this note.","enum":["EMAIL","IM","NONE","PHONE"]},"AttachmentsAdd":{"type":"string","format":"binary","description":"An image file to add as a new attachment."},"AttachmentsRemove":{"type":"string","description":"The filename (e.g., 'crm_7654321_...') of the attachment to remove."}}}}}}
```

## The SuccessUriResponse object

```json
{"openapi":"3.1.0","info":{"title":"Brand API - Notes","version":"v14"},"components":{"schemas":{"SuccessUriResponse":{"type":"object","properties":{"Status":{"type":"string","description":"Indicates whether the operation was successful."},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to the affected note."}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://integrations.impact.com/brand-api-reference/reference/notes/models.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.