Creating account, job, and policy notes

Notes must be created from an existing account, job, policy, or activity using one of the following endpoints:

  • POST account/v1/accounts/{accountId}/notes
  • POST job/v1/jobs/{jobId}/notes
  • POST policy/v1/policies/{policyId}/notes
  • POST common/v1/activities/{activityId}/notes

Be aware that PolicyCenter supports notes attached to other objects as well, such as PolicyPeriods. However, as of the current release, Cloud API does not yet support the ability to create notes for parent objects beyond accounts, jobs, policies, and activities.

The only field required for a note is body, which stores the note's text. You can optionally specify these fields:

Field Datatype Description Default
confidential Boolean Whether the note is confidential false
securityType Typekey (a value from the NoteSecurityType typelist) The note's security type NULL
subject string The note's subject NULL
topic Typekey (a value from the NoteTopicType typelist) The note's topic type general

Minimal notes

The following is an example of creating a note for account pc:10.

POST /account/v1/accounts/pc:10/notes

{
  "data": {
    "attributes": {
        "body": "The insured's last name, Cahill, is pronounced 'KAH-hill', not 'KAY-hill'." 
    }
  }
}

Notes with additional details

The following is an example of creating a detailed note for account pc:10.

POST /account/v1/accounts/pc:10/notes

{
  "data": {
    "attributes": {
        "body": "The insured's last name, Cahill, is pronounced 'KAH-hill', not 'KAY-hill'." ,
        "confidential": false,
        "securityType": {
          "code": "unrestricted"
        },
        "subject": "Pronunciation note",
        "topic": {
          "code": "general"
        }
    }
  }
}

Notes for an activity

The following is an example of creating a note for activity xc:22.

POST /common/v1/activities/xc:22/notes

{
  "data": {
    "attributes": {
        "body": "This activity was completed during a telephone call with the insured on 11/17." 
    }
  }
}