/jobnote/create
The action creates a job note for a work order.
Request
| Field | Description | Type | Required |
|---|---|---|---|
note_type | Note type. It wo if it is a work order note and prop if it is a property note | string | Yes |
send_to_users | List of PPW users to send the job note to. Each item in the list is a user_id. | array | No |
send_to_emails | List of email addresses to send to the job note to. | array | No |
reminder_date | Job note reminder date. Accepted formats: MM/DD/YYYY, YYYY-MM-DD, YYYYMMDD | string | No |
reminder_time | Job note reminder time. For a liste of accepted times, see /jobnote/reminder/times | string | No |
note_text | Job note body | string | Yes |
group_permissions | List of user groups that will have permission to view the job note. See /user/group/list | array | Yes |
For send_to_users field to get the user_id for a PPW user use the
/user/search action.
If group_permissions is not provided and the “Default Note group
permissions” app setting is set, the default note group permissions
will be set on the new note.
If reminder_date is specified, then reminder_time is required. The
reminder_time must be US Central time.
Example:
{
"report_id": 40945,
"note_type": "wo",
"send_to_emails": [],
"send_to_users": [45592],
"reminder_date": "2024-08-01",
"reminder_time": "133000",
"note_text": "Performed deep cleaning on 5 rooms of carpet. Stains were treated and removed successfully. Client expressed satisfaction with the results and requested a follow-up cleaning in 6 months.",
"group_permissions": [3651, 3654]
}
curl -H 'Content-Type: application/json' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-d '{"report_id":40945,"note_type":"wo","send_to_emails":[],"send_to_users":[45592],"reminder_DATE":"2024-08-01","reminder_time":"133000","note_text":"Performed deep cleaning on 5 rooms of carpet. Stains were treated and removed successfully. Client expressed satisfaction with the results and requested a follow-up cleaning in 6 months.","group_permissions":[3651,3654]}' \
https://ppw.web/svc/jobnote/create
Response
| Field | Description | Type |
|---|---|---|
note_id | Unique identifier for the job note | number |
Example successful response:
{
"note_id": 239
}
Errors
| Error Type | Description | Status Code |
|---|---|---|
invalid_report_id | Unique work order identifier is invalid | 400 |
note_type_required | Job note type is required | 400 |
invalid_note_type | Job note type is invalid | 400 |
note_text_required | Job note text is required | 400 |
invalid_send_to_users | send_to_users field is invalid | 400 |
invalid_send_to_emails | send_to_emails field is invalid | 400 |
invalid_reminder_date | Reminder date is invalid | 400 |
reminder_time_required | Reminder time is required | 400 |
invalid_reminder_time | Reminder time is invalid | 400 |
group_permissions_required | Group permissions is required | 400 |
invalid_group_permission | group_permissions is invalid | 400 |
note_create_error | Error creating job note | 400 |