Notes

List Customer Notes

Requires admin privileges

GET/api/customers/{customer_id}/notes

Path parameters

customer_id*integer (int64)

Query parameters

Response

200400

OK

Body

application/json

idinteger (int64)

reference_typeNoteReferenceType (enum)

businesscustomermembershipCardorderpoint_earnedsubscriptiontransactionreservationappointmentevent

reference_idinteger (int64)

typenullable string

detailsnullable string

created_onstring (date-time)

statusNoteStatus (enum)

openclosed

remindernullable string

user_idinteger (int64)

company_idinteger (int64)

customer_idinteger (int64)

confidentialboolean

priorityboolean

tagsnullable array of string

subjectnullable string

customerCustomerSummary (object)

userUser (object)

assigneesnullable array of NoteAssignee (object)

messagesnullable array of NoteMessage (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/customers/{customer_id}/notes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "reference_type": "",
    "type": "text",
    "details": "text",
    "created_on": "2024-10-06T20:35:16.983Z",
    "status": "",
    "reminder": "text",
    "confidential": false,
    "priority": false,
    "tags": [
      "text"
    ],
    "subject": "text",
    "customer": {
      "company_name": "text",
      "company_title": "text",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "full_name": "text",
      "locale": "text",
      "is_member": false,
      "was_member": false,
      "has_applied": false,
      "flag": "",
      "email": "[e-mail]",
      "mobile": {
        "country_code": "text",
        "number": "text",
        "full": "text"
      },
      "phone": {
        "country_code": "text",
        "number": "text",
        "full": "text"
      },
      "profile_photo": "text",
      "vip": false,
      "home_house_id": "text",
      "birthdate": "text",
      "anniversary_date": "text",
      "created_on": "2024-10-06T20:35:16.983Z"
    },
    "user": {
      "status": "active",
      "first_name": "text",
      "last_name": "text",
      "full_name": "text",
      "email": "text",
      "username": "text",
      "profile_photo": "text",
      "employee_id": "text",
      "mobile_number": "text",
      "business_location_id": "text",
      "enable2_fa": "text",
      "modified_on": "text",
      "created_by": "text",
      "role": "text"
    },
    "assignees": [
      {
        "status": "active",
        "created_on": "2024-10-06T20:35:16.983Z",
        "first_name": "text",
        "last_name": "text",
        "full_name": "text",
        "email": "text",
        "username": "text",
        "profile_photo": "text",
        "employee_id": "text",
        "mobile_number": "text",
        "business_location_id": "text",
        "enable2_fa": "text",
        "modified_on": "text",
        "created_by": "text",
        "role": "text"
      }
    ],
    "messages": [
      {
        "message": "text",
        "attachment": "text",
        "posted_by": {
          "status": "active",
          "first_name": "text",
          "last_name": "text",
          "full_name": "text",
          "email": "text",
          "username": "text",
          "profile_photo": "text",
          "employee_id": "text",
          "mobile_number": "text",
          "business_location_id": "text",
          "enable2_fa": "text",
          "modified_on": "text",
          "created_by": "text",
          "role": "text"
        },
        "created_on": "2024-10-06T20:35:16.983Z"
      }
    ]
  }
]

Create Customer Note

Requires admin privileges

POST/api/customers/{customer_id}/notes

Path parameters

customer_id*integer (int64)

Body

application/json

typenullable string

detailsnullable string

remindernullable string

statusnullable string

reference_typeNoteReferenceType (enum)

businesscustomermembershipCardorderpoint_earnedsubscriptiontransactionreservationappointmentevent

reference_idinteger (int64)

subjectnullable string

confidentialboolean

priorityboolean

tagsnullable array of string

assigneesnullable array of integer (int64)

Response

200400

OK

Body

application/json

idinteger (int64)

reference_typeNoteReferenceType (enum)

businesscustomermembershipCardorderpoint_earnedsubscriptiontransactionreservationappointmentevent

reference_idinteger (int64)

typenullable string

detailsnullable string

created_onstring (date-time)

statusNoteStatus (enum)

openclosed

remindernullable string

user_idinteger (int64)

company_idinteger (int64)

customer_idinteger (int64)

confidentialboolean

priorityboolean

tagsnullable array of string

subjectnullable string

customerCustomerSummary (object)

userUser (object)

assigneesnullable array of NoteAssignee (object)

messagesnullable array of NoteMessage (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/customers/{customer_id}/notes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

[
  {
    "reference_type": "",
    "type": "text",
    "details": "text",
    "created_on": "2024-10-06T20:35:16.983Z",
    "status": "",
    "reminder": "text",
    "confidential": false,
    "priority": false,
    "tags": [
      "text"
    ],
    "subject": "text",
    "customer": {
      "company_name": "text",
      "company_title": "text",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "full_name": "text",
      "locale": "text",
      "is_member": false,
      "was_member": false,
      "has_applied": false,
      "flag": "",
      "email": "[e-mail]",
      "mobile": {
        "country_code": "text",
        "number": "text",
        "full": "text"
      },
      "phone": {
        "country_code": "text",
        "number": "text",
        "full": "text"
      },
      "profile_photo": "text",
      "vip": false,
      "home_house_id": "text",
      "birthdate": "text",
      "anniversary_date": "text",
      "created_on": "2024-10-06T20:35:16.983Z"
    },
    "user": {
      "status": "active",
      "first_name": "text",
      "last_name": "text",
      "full_name": "text",
      "email": "text",
      "username": "text",
      "profile_photo": "text",
      "employee_id": "text",
      "mobile_number": "text",
      "business_location_id": "text",
      "enable2_fa": "text",
      "modified_on": "text",
      "created_by": "text",
      "role": "text"
    },
    "assignees": [
      {
        "status": "active",
        "created_on": "2024-10-06T20:35:16.983Z",
        "first_name": "text",
        "last_name": "text",
        "full_name": "text",
        "email": "text",
        "username": "text",
        "profile_photo": "text",
        "employee_id": "text",
        "mobile_number": "text",
        "business_location_id": "text",
        "enable2_fa": "text",
        "modified_on": "text",
        "created_by": "text",
        "role": "text"
      }
    ],
    "messages": [
      {
        "message": "text",
        "attachment": "text",
        "posted_by": {
          "status": "active",
          "first_name": "text",
          "last_name": "text",
          "full_name": "text",
          "email": "text",
          "username": "text",
          "profile_photo": "text",
          "employee_id": "text",
          "mobile_number": "text",
          "business_location_id": "text",
          "enable2_fa": "text",
          "modified_on": "text",
          "created_by": "text",
          "role": "text"
        },
        "created_on": "2024-10-06T20:35:16.983Z"
      }
    ]
  }
]

Get Customer Note

Requires admin privileges

GET/api/customers/notes/{note_id}

Path parameters

note_id*integer (int64)

Response

200400

OK

Body

application/json

idinteger (int64)

reference_typeNoteReferenceType (enum)

businesscustomermembershipCardorderpoint_earnedsubscriptiontransactionreservationappointmentevent

reference_idinteger (int64)

typenullable string

detailsnullable string

created_onstring (date-time)

statusNoteStatus (enum)

openclosed

remindernullable string

user_idinteger (int64)

company_idinteger (int64)

customer_idinteger (int64)

confidentialboolean

priorityboolean

tagsnullable array of string

subjectnullable string

customerCustomerSummary (object)

userUser (object)

assigneesnullable array of NoteAssignee (object)

messagesnullable array of NoteMessage (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/customers/notes/{note_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "reference_type": "",
  "type": "text",
  "details": "text",
  "created_on": "2024-10-06T20:35:16.983Z",
  "status": "",
  "reminder": "text",
  "confidential": false,
  "priority": false,
  "tags": [
    "text"
  ],
  "subject": "text",
  "customer": {
    "company_name": "text",
    "company_title": "text",
    "first_name": "text",
    "middle_name": "text",
    "last_name": "text",
    "full_name": "text",
    "locale": "text",
    "is_member": false,
    "was_member": false,
    "has_applied": false,
    "flag": "",
    "email": "[e-mail]",
    "mobile": {
      "country_code": "text",
      "number": "text",
      "full": "text"
    },
    "phone": {
      "country_code": "text",
      "number": "text",
      "full": "text"
    },
    "profile_photo": "text",
    "vip": false,
    "home_house_id": "text",
    "birthdate": "text",
    "anniversary_date": "text",
    "created_on": "2024-10-06T20:35:16.983Z"
  },
  "user": {
    "status": "active",
    "first_name": "text",
    "last_name": "text",
    "full_name": "text",
    "email": "text",
    "username": "text",
    "profile_photo": "text",
    "employee_id": "text",
    "mobile_number": "text",
    "business_location_id": "text",
    "enable2_fa": "text",
    "modified_on": "text",
    "created_by": "text",
    "role": "text"
  },
  "assignees": [
    {
      "status": "active",
      "created_on": "2024-10-06T20:35:16.983Z",
      "first_name": "text",
      "last_name": "text",
      "full_name": "text",
      "email": "text",
      "username": "text",
      "profile_photo": "text",
      "employee_id": "text",
      "mobile_number": "text",
      "business_location_id": "text",
      "enable2_fa": "text",
      "modified_on": "text",
      "created_by": "text",
      "role": "text"
    }
  ],
  "messages": [
    {
      "message": "text",
      "attachment": "text",
      "posted_by": {
        "status": "active",
        "first_name": "text",
        "last_name": "text",
        "full_name": "text",
        "email": "text",
        "username": "text",
        "profile_photo": "text",
        "employee_id": "text",
        "mobile_number": "text",
        "business_location_id": "text",
        "enable2_fa": "text",
        "modified_on": "text",
        "created_by": "text",
        "role": "text"
      },
      "created_on": "2024-10-06T20:35:16.983Z"
    }
  ]
}

Update Customer Note

Requires admin privileges

PATCH/api/customers/notes/{note_id}

Path parameters

note_id*integer (int64)

Body

application/json

typenullable string

remindernullable string

customer_idnullable string

subjectnullable string

detailsnullable string

statusnullable string

reference_typenullable string

reference_idnullable string

confidentialnullable string

prioritynullable string

tagsnullable array of string

Response

200400

OK

Body

application/json

idinteger (int64)

reference_typeNoteReferenceType (enum)

businesscustomermembershipCardorderpoint_earnedsubscriptiontransactionreservationappointmentevent

reference_idinteger (int64)

typenullable string

detailsnullable string

created_onstring (date-time)

statusNoteStatus (enum)

openclosed

remindernullable string

user_idinteger (int64)

company_idinteger (int64)

customer_idinteger (int64)

confidentialboolean

priorityboolean

tagsnullable array of string

subjectnullable string

customerCustomerSummary (object)

userUser (object)

assigneesnullable array of NoteAssignee (object)

messagesnullable array of NoteMessage (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/customers/notes/{note_id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

{
  "reference_type": "",
  "type": "text",
  "details": "text",
  "created_on": "2024-10-06T20:35:16.983Z",
  "status": "",
  "reminder": "text",
  "confidential": false,
  "priority": false,
  "tags": [
    "text"
  ],
  "subject": "text",
  "customer": {
    "company_name": "text",
    "company_title": "text",
    "first_name": "text",
    "middle_name": "text",
    "last_name": "text",
    "full_name": "text",
    "locale": "text",
    "is_member": false,
    "was_member": false,
    "has_applied": false,
    "flag": "",
    "email": "[e-mail]",
    "mobile": {
      "country_code": "text",
      "number": "text",
      "full": "text"
    },
    "phone": {
      "country_code": "text",
      "number": "text",
      "full": "text"
    },
    "profile_photo": "text",
    "vip": false,
    "home_house_id": "text",
    "birthdate": "text",
    "anniversary_date": "text",
    "created_on": "2024-10-06T20:35:16.983Z"
  },
  "user": {
    "status": "active",
    "first_name": "text",
    "last_name": "text",
    "full_name": "text",
    "email": "text",
    "username": "text",
    "profile_photo": "text",
    "employee_id": "text",
    "mobile_number": "text",
    "business_location_id": "text",
    "enable2_fa": "text",
    "modified_on": "text",
    "created_by": "text",
    "role": "text"
  },
  "assignees": [
    {
      "status": "active",
      "created_on": "2024-10-06T20:35:16.983Z",
      "first_name": "text",
      "last_name": "text",
      "full_name": "text",
      "email": "text",
      "username": "text",
      "profile_photo": "text",
      "employee_id": "text",
      "mobile_number": "text",
      "business_location_id": "text",
      "enable2_fa": "text",
      "modified_on": "text",
      "created_by": "text",
      "role": "text"
    }
  ],
  "messages": [
    {
      "message": "text",
      "attachment": "text",
      "posted_by": {
        "status": "active",
        "first_name": "text",
        "last_name": "text",
        "full_name": "text",
        "email": "text",
        "username": "text",
        "profile_photo": "text",
        "employee_id": "text",
        "mobile_number": "text",
        "business_location_id": "text",
        "enable2_fa": "text",
        "modified_on": "text",
        "created_by": "text",
        "role": "text"
      },
      "created_on": "2024-10-06T20:35:16.983Z"
    }
  ]
}

List all Notes

Requires admin privileges

GET/api/customers/notes

Query parameters

Response

200400

OK

Body

application/json

idinteger (int64)

reference_typeNoteReferenceType (enum)

businesscustomermembershipCardorderpoint_earnedsubscriptiontransactionreservationappointmentevent

reference_idinteger (int64)

typenullable string

detailsnullable string

created_onstring (date-time)

statusNoteStatus (enum)

openclosed

remindernullable string

user_idinteger (int64)

company_idinteger (int64)

customer_idinteger (int64)

confidentialboolean

priorityboolean

tagsnullable array of string

subjectnullable string

customerCustomerSummary (object)

userUser (object)

assigneesnullable array of NoteAssignee (object)

messagesnullable array of NoteMessage (object)

Request

JavaScriptCurlPython

const response = await fetch('/api/customers/notes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

[
  {
    "reference_type": "",
    "type": "text",
    "details": "text",
    "created_on": "2024-10-06T20:35:16.983Z",
    "status": "",
    "reminder": "text",
    "confidential": false,
    "priority": false,
    "tags": [
      "text"
    ],
    "subject": "text",
    "customer": {
      "company_name": "text",
      "company_title": "text",
      "first_name": "text",
      "middle_name": "text",
      "last_name": "text",
      "full_name": "text",
      "locale": "text",
      "is_member": false,
      "was_member": false,
      "has_applied": false,
      "flag": "",
      "email": "[e-mail]",
      "mobile": {
        "country_code": "text",
        "number": "text",
        "full": "text"
      },
      "phone": {
        "country_code": "text",
        "number": "text",
        "full": "text"
      },
      "profile_photo": "text",
      "vip": false,
      "home_house_id": "text",
      "birthdate": "text",
      "anniversary_date": "text",
      "created_on": "2024-10-06T20:35:16.983Z"
    },
    "user": {
      "status": "active",
      "first_name": "text",
      "last_name": "text",
      "full_name": "text",
      "email": "text",
      "username": "text",
      "profile_photo": "text",
      "employee_id": "text",
      "mobile_number": "text",
      "business_location_id": "text",
      "enable2_fa": "text",
      "modified_on": "text",
      "created_by": "text",
      "role": "text"
    },
    "assignees": [
      {
        "status": "active",
        "created_on": "2024-10-06T20:35:16.983Z",
        "first_name": "text",
        "last_name": "text",
        "full_name": "text",
        "email": "text",
        "username": "text",
        "profile_photo": "text",
        "employee_id": "text",
        "mobile_number": "text",
        "business_location_id": "text",
        "enable2_fa": "text",
        "modified_on": "text",
        "created_by": "text",
        "role": "text"
      }
    ],
    "messages": [
      {
        "message": "text",
        "attachment": "text",
        "posted_by": {
          "status": "active",
          "first_name": "text",
          "last_name": "text",
          "full_name": "text",
          "email": "text",
          "username": "text",
          "profile_photo": "text",
          "employee_id": "text",
          "mobile_number": "text",
          "business_location_id": "text",
          "enable2_fa": "text",
          "modified_on": "text",
          "created_by": "text",
          "role": "text"
        },
        "created_on": "2024-10-06T20:35:16.983Z"
      }
    ]
  }
]