Link Search Menu Expand Document

Updated Fri Mar 5th 2021, 12:17 UTC

Create

POST /contacts/:contact/notes

A Contact Note is a note that can be added by User to a Contact

Examples

Create a Contact Note

Request

POST /contacts/DQeeO69/notes

Body

{
  "content": "Awesome note!"
}
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X POST /contacts/DQeeO69/notes
     -d '{json: "body"}' 

Response

Status

201

Response Type

ContactNote

Example
{
  "@type": "ContactNote",
  "id": "/contact_notes/RN5QNG",
  "@context": "/contexts/ContactNote.jsonld",
  "content": "Life is a fragile thing, Har. One minute you're chewin' on a burger, the next minute you're dead meat.",
  "createdAt": "2018-10-31T16:17:10.914Z",
  "updatedAt": "2018-10-31T16:17:10.914Z",
  "user": {
    "@type": "User",
    "@context": "/contexts/User.jsonld",
    "id": "/users/wqyODPA",
    "name": "Chuck Norris",
    "firstName": "Chuck",
    "lastName": "Norris",
    "email": "chuck@textus.example",
    "avatar": null,
    "automatedActor": false,
    "hasPassword": false,
    "discarded": false,
    "settings": {
      "notifications": {
        "email": true
      },
      "customSettings": {}
    },
    "memberships": "/users/wqyODPA/memberships"
  },
  "contact": "/contacts/DQeeO69"
}

© 2021 TextUs