Skip to content

API Documentation

ConceptsThe Worklayer platformAuthentication

MemberThe Member ResourceCreate a memberRetrieve a list of membersUpdate a member

JobsThe Job ResourceThe job creation flowThe Info Gathering ChecklistCreate a job from a templateRetrieve questionnaireSubmit questionnaire answersRequest a specific ProRequest a previous ProSubmit a jobRetrieve a list of your jobsList job documentsDelete a jobRetrieve a job checklistComplete info gathering for a job

ConsultationsThe Consultation Resource

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

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 document

Document TypesThe Document Type ResourceList document types

MessagesThe Message ResourceSend a messageList messages

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob Details

GuidesFilteringPostman Collection

Sending Messages

Send messages to a job in your workspace.

The send messages endpoint allows you to send new messages to a user's job in your workspace.

Endpoint

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

Request Parameters

text

•

string

required

The message's text.

sender_user_id

•

string

required

ID of the user that is sending the message.

Sample Request

Copied
1curl -X POST 'https://api.worklayer.com/v1.0/jobs/a439ddfa-6ba4-4b38-8cf0-5d09db1a0af4/messages' \
2-H 'Authorization: Bearer {token}' \
3-d '{ "text": "The text content", "sender_user_id": "95e6f305-913e-40ad-9c80-ede263670878" }'

Response

The response will contain the sent message's ID and creation time.

Sample Response

Copied
1{
2  "id": "6b3b0a1c-d45c-4323-8584-6f341dbd8be9",
3  "create_time": "2025-07-15T15:18:00.701Z",
4}

Errors

Forbidden: API Client cannot send messages.
Unauthorized: API Client does not have valid credentials.
BadRequest: Either required properties are missing, or the request was malformed.

Last updated on July 15, 2025

Privacy Policy Terms & Conditions© 2025 Taxfyle