COcoevera
Note

Notes.update

Changes fields of the Note record with the given id; fields left out keep their values.

patch/entities/Notes/{id}

Request

Path parameters

idstring uuid required

Id of the Note record to update.

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

account_idstring uuid

Id of the account the note is attached to.

contact_idstring uuid

Id of the contact the note is attached to.

custom_entity_idstring uuid

Id of the custom entity record the note is attached to.

lead_oppty_idstring uuid

Id of the lead or opportunity the note is attached to.

notestring

Free-form text body of the note (sanitized HTML allowed).

owner_idstring uuid

Id of the note author.

project_idstring uuid

Id of the project the note is attached to.

quote_idstring uuid

Id of the quote the note is attached to.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "account_id": "01234567-abcd-dcba-ffff-000000000000",
  "contact_id": "01234567-abcd-dcba-ffff-000000000000",
  "custom_entity_id": "01234567-abcd-dcba-ffff-000000000000",
  "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
  "note": "string",
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "project_id": "01234567-abcd-dcba-ffff-000000000000",
  "quote_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

The changed Note record.

successboolean

True when the request succeeded; false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account_id": "01234567-abcd-dcba-ffff-000000000000",
    "contact_id": "01234567-abcd-dcba-ffff-000000000000",
    "custom_entity_id": "01234567-abcd-dcba-ffff-000000000000",
    "lead_oppty_id": "01234567-abcd-dcba-ffff-000000000000",
    "note": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "project_id": "01234567-abcd-dcba-ffff-000000000000",
    "quote_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.