Skip to content

API Documentation

ConceptsThe Worklayer platformAuthenticationRate Limits

MemberThe Member ResourceCreate a memberRetrieve a memberRetrieve a member by external IDRetrieve a list of membersUpdate a memberAccept terms for a member

JobsThe Job ResourceRetrieve a job by short IDThe job creation flowThe Info Gathering ChecklistCreate a job from a templateRetrieve questionnaireSubmit questionnaire answersRequest a specific ProRequest a previous ProAssign a supporting clientRemove a supporting clientSubmit a jobRetrieve a list of your jobsList job documentsDelete a jobRetrieve a job checklistComplete info gathering for a jobRequest cancellationRequest reopen

Relationship ManagerRelationship Manager ResourceRetrieve a job relationship manager

Job ProgressionsApprove a draftReject a draftMark job as ready to file

ConsultationsThe Consultation Resource

Scope Change RequestsChange job scopeList consultation service itemsCreate job scope change requestApprove a job scope changeReject a job scope change

Job NotesThe Job Note ResourceCreate a job noteGet a job noteList job notes

Job TemplatesThe Job Template ResourceRetrieve available job templates

Personal ProfilesThe Personal Profile ResourceRetrieve a personal profileSave a personal profileProvide a personal profile to a jobRetrieve a personal profile for a job

Spousal ProfilesThe Spousal Profile ResourceRetrieve a spousal profileSave a spousal profileProvide a spousal profile to a jobRetrieve a spousal profile for a job

Dependent ProfilesThe Dependent Profile ResourceList dependent profilesRetrieve a dependent profileCreate a dependent profileUpdate a dependent profileDelist a dependent profileProvide a dependent profile to a jobRemove a dependent profile from a jobRetrieve dependent profiles for a job

Business ProfilesThe Business Profile ResourceList business profilesCreate a business profileUpdate a business profileRetrieve a business profileRetrieve a business profile for a jobDelist a business profileProvide a business profile to a job

Tax Refund MethodsThe Tax Refund Method ResourceList tax refund methodsCreate a tax refund methodRetrieve a tax refund methodRetrieve a tax refund method for a jobUpdate a tax refund methodDelist a tax refund methodProvide a personal refund methodProvide a business refund method

DocumentsThe Document ResourceCreate a documentGet a documentDownload a documentDelete a document

Document TypesThe Document Type ResourceList document types

MessagesThe Message ResourceSend a messageList messagesGet unread count

OCRStart OCR processingGet OCR results

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob DetailsWaitlist

PortalPortal embedding

GuidesFilteringPostman Collection

Creating a Job Note

Create an internal note on a job in your workspace.

The create job note endpoint allows you to add a new job note to a job in your workspace.

By default, the note is attributed to the caller. Use author_user_id to attribute it to a different user, and recipient_user_ids to notify participants on the job.

Endpoint

Method	Url
`POST`	`/v1.0/jobs/{job_id}/notes`

Request Parameters

body

•

string

required

The note's text content. Must not exceed 2,000 characters.

author_user_id

•

string

The ID of the user the note is attributed to. The user must be permitted to author notes on the job. Defaults to the user making the request when omitted. This value is returned as created_by_user_id on the job note resource.

recipient_user_ids

•

list

The IDs of the users to notify of the note. Each user must be a participant on the job, such as an assigned Pro or the job's relationship manager. Omit this property to create the note without notifying anyone.

Sample Request

bashCopied
1curl -X POST 'https://api.worklayer.com/v1.0/jobs/a439ddfa-6ba4-4b38-8cf0-5d09db1a0af4/notes' \
2-H 'Authorization: Bearer {token}' \
3-H 'Content-Type: application/json' \
4-d '{ "body": "Client uploaded the missing W-2. Ready for review.", "recipient_user_ids": ["95e6f305-913e-40ad-9c80-ede263670878"] }'

Response

The response will contain the created job note's ID.

Sample Response

jsonCopied
1{
2  "id": "6b3b0a1c-d45c-4323-8584-6f341dbd8be9"
3}

Errors

Forbidden: API Client cannot create notes on the job, or the specified author is not permitted to author notes on the job.
Unauthorized: API Client does not have valid credentials.
BadRequest: Required properties are missing, one or more recipients are not authorized to view the job's notes, or the request was malformed.
NotFound: The job was not found.

Last updated on August 6, 2026

Privacy Policy Terms & Conditions© 2026 Taxfyle