Menu

Notes

2 endpoints in the Mattering Sales API.

GETPOST notes/ User APIService tier

List notes, or create one with POST. derived from route

URL

  • User APIhttps://sales.mattering.io/api/user/v1/notes/
  • Service tierhttps://sales.mattering.io/api/internal/notes/

Query parameters

NameDefault
created_afternone
created_beforenone
sortnone
updated_afternone
updated_beforenone

Body keys (JSON)

KeyRequiredDefault
business_idoptional or conditionalnone
contact_idoptional or conditionalnone
contentoptional or conditionalnone
is_privateoptional or conditionalnone
tagsoptional or conditionalnone
titleoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Pagination

Accepts limit and offset. The response meta carries total, returned, has_more and next_offset.

Responses

200 data and meta envelope

{
  "data": {
    "notes": [
      {
        "...": "..."
      }
    ]
  },
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "returned": 0,
    "has_more": true,
    "next_offset": 0
  }
}

201 data and meta envelope

{
  "data": {
    "note": {
      "...": "..."
    }
  },
  "meta": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "returned": 0,
    "has_more": true,
    "next_offset": 0
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400anchor_mismatch
400invalid_json
400missing_field
400tags_must_be_list
404business_not_found
404contact_not_found

Example

curl -X POST "https://sales.mattering.io/api/user/v1/notes/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "business_id": "...",
  "contact_id": "...",
  "content": "...",
  "is_private": "...",
  "tags": "...",
  "title": "..."
}'

Source: CRMCore/timeline_api.py (timeline_api.notes)

GETPATCHDELETE notes/{note_id}/ User APIService tier

Read, update or delete one of the notes by id. derived from route

This read is not paginated. It returns at most 80 rows and does not report a total, so a result of exactly 80 may be truncated.

URL

  • User APIhttps://sales.mattering.io/api/user/v1/notes/{note_id}/
  • Service tierhttps://sales.mattering.io/api/internal/notes/{note_id}/

Path parameters

NameType
note_iduuid

Body keys (JSON)

KeyRequiredDefault
contentoptional or conditionalnone
is_privateoptional or conditionalnone
tagsoptional or conditionalnone
titleoptional or conditionalnone

Keys the view reads. A key not in this list is ignored by the view, silently. Where a key is required only for some actions (for example the action dispatch), the description above says which.

Responses

200 data and meta envelope

{
  "data": {
    "id": "...",
    "deleted": true
  }
}

200 data and meta envelope

{
  "data": {
    "note": {
      "...": "..."
    }
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Errors

StatusCode
400invalid_json
400missing_field
400tags_must_be_list
404not_found

Example

curl -X PATCH "https://sales.mattering.io/api/user/v1/notes/NOTE_ID/" \
  -H "Authorization: Bearer $MATTERING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "...",
  "is_private": "...",
  "tags": "...",
  "title": "..."
}'

Source: CRMCore/timeline_api.py (timeline_api.note_detail)

All Sales resources
Start Free Explore our Products