Sign in

v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB
Contact Notes

Add note

Create a new note on a contact.

Required scope: contacts:write

post/contacts/{contact_id}/notes

Path parameters

contact_idstring required

The contact ID. Alternatively, you can supply the contact's source and handle as a resource alias.

Request body

author_idstring required

ID of teammate creating the note

bodystring required

Content of the note

Response

A contact note

bodystring required

Content of the note

created_atnumber

The timestamp when the note was created

Example response

{
  "_links": {
    "related": {
      "author": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a",
      "owner": "https://yourCompany.api.frontapp.com/teammates/tea_e35u"
    }
  },
  "author": {
    "_links": {
      "self": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a",
      "related": {
        "inboxes": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a/inboxes",
        "conversations": "https://yourCompany.api.frontapp.com/teammates/tea_6r55a/conversations",
        "botSource": "https://yourCompany.api.frontapp.com/rules/rul_6r55a"
      }
    },
    "id": "tea_6r55a",
    "email": "michael.scott@dundermifflin.com",
    "username": "PrisonMike",
    "first_name": "Michael",
    "last_name": "Scott",
    "is_admin": true,
    "custom_fields": {
      "city": "London, UK",
      "isVIP": true,
      "renewal_date": 1525417200,
      "sla_time": 90,
      "owner": "leela@planet-express.com",
      "replyTo": "inb_55c8c149",
      "Job Title": "firefighter"
    }
  },
  "body": "Mrs. Allen is our most important client … because every client is our most important client.",
  "created_at": 1701806790.536
}