Upcoming Release

Create a note for a specific account.

POST /accounts/{account_id}/notes

A note to be added to the account.

Path parameters

Body

Add a Note to an account

  • message string Required

    The contents of the note.

Responses

  • 200

    New Note Created

    Hide response attributes Show response attributes object
    • note_id string Required

      A Canopy-generated ID for the note.

    • account_id string Required

      A Canopy-generated ID for the account.

    • author object

      The API User who authored the note

      Hide author attributes Show author attributes object
      • api_user_id string Required

        The unique ID in Canopy for this API user

      • organization_name string Required

        The organization to which the API user belongs.

      • name_first string Required

        The first name of the API user.

      • name_last string Required

        The last name of the API user.

      • email string(email) Required

        The email address of this API User

      • phone string | null

        Phone number of the API user

      • role integer Required

        The role of this user in the API

    • message string

      The contents of the note.

    • created_date string(date-time) Required

      The date and time the note was created.
  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 422

    Invalid input

  • 429

    Too many requests.

  • default

    Unexpected Error.

POST /accounts/{account_id}/notes 
curl \
 -X POST https://sandbox-api.canopyservicing.com/accounts/31mNprzLd2bKl6koVna68ARM/notes \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"message":"Attempted to call back customer, but no response."}'
Request example 
{
  "message": "Attempted to call back customer, but no response."
}
Request examples 
{
  "message": "Attempted to call back customer, but no response."
}
Response examples (200) 
{
  "note_id": "31mNprzLd2bKl6koVna68ARM",
  "account_id": "31mNprzLd2bKl6koVna68ARM",
  "author": {
    "api_user_id": "dc3d83c5-b31e-48eb-80e7-38f12ac1a6e5",
    "organization_name": "Lever Card 3000",
    "name_first": "Analise",
    "name_last": "Goldberg",
    "email": "marissa@globex.com",
    "phone": "1-123-456-7890",
    "role": 1
  },
  "message": "Attempted to call back customer, but no response.",
  "created_date": "2023-05-04T09:42:00+00:00"
}
Response examples (200) 
{
  "note_id": "31mNprzLd2bKl6koVna68ARM",
  "account_id": "31mNprzLd2bKl6koVna68ARM",
  "author": {
    "api_user_id": "dc3d83c5-b31e-48eb-80e7-38f12ac1a6e5",
    "organization_name": "Lever Card 3000",
    "name_first": "Analise",
    "name_last": "Goldberg",
    "email": "marissa@globex.com",
    "phone": "1-123-456-7890",
    "role": 1
  },
  "message": "Attempted to call back customer, but no response.",
  "created_date": "2025-05-04T09:42:00Z"
}