Skip to content

API Documentation

ConceptsThe Worklayer platformAuthenticationRate LimitsError handling

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 ResourceGet a consultationList consultations

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 countMark messages read

OCRStart OCR processingGet OCR results

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob DetailsWaitlist

PortalPortal embeddingPortal translations

GuidesFilteringPostman Collection

Mark Messages Read

Mark messages as read for a member.

The mark messages read endpoint allows you to mark one or more messages as read for a member. After this call, the messages no longer count toward the member's unread count.

Endpoint

Method	Url
`POST`	`/v1.0/messages/read`

Request Parameters

message_ids

•

list of UUID

required

The IDs of the messages to mark as read. Send at least 1 and at most 100 IDs. Duplicate IDs are ignored.

user_id

•

UUID

The ID of the member to mark the messages as read for. If you do not send it, the messages are marked as read for the API Client.

Sample Request

bashCopied
1curl -X POST 'https://api.worklayer.com/v1.0/messages/read' \
2-H 'Authorization: Bearer {token}' \
3-H 'Content-Type: application/json' \
4-d '{ "message_ids": ["6b3b0a1c-d45c-4323-8584-6f341dbd8be9"], "user_id": "a6e5ea2f-7d96-4852-9f46-2383dfd572f7" }'

Response

A 204 No Content

Errors

Forbidden: API Client does not have permission to mark these messages as read for the member.
Unauthorized: API Client does not have valid credentials.
NotFound: The messages could not be found.
BadRequest: Either message_ids is empty or has more than 100 IDs, an ID is not a valid UUID, or the request was malformed.

Last updated on October 15, 2026

Privacy Policy Terms & Conditions© 2026 Taxfyle