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 count

OCRStart OCR processingGet OCR results

WebhooksConsume webhook eventsEvent resourcesCheck signatures

Magic LinkDashboardJob DetailsWaitlist

PortalPortal embeddingPortal translations

GuidesFilteringPostman Collection

Update Workspace Members

Update members belonging to your workspace.

The edit members endpoint allows you to update existing members in your workspace. This endpoint is only available if your workpsace has been configured to allow member editing.

This endpoint uses the PATCH HTTP method. The request body should contain a JSON object with the properties you wish to update.

Endpoint

Method	Url
`PATCH`	`/v1.0/members/{memberId}`

Request Parameters

email

•

string

The member's unique email.

external_id

•

string

The member's external ID. This is their unique identifier in your system.

given_name

•

string

The member's given name. This is their first name.

family_name

•

string

The member's family name. This is their surname.

phone_number

•

string

The member's phone number.

Sample Request

bashCopied
1curl -X PATCH 'https://api.worklayer.com/v1.0/members/{memberId}' \
2-H 'Authorization: Bearer {token}' \
3-d '{ "email": "ironman@stark.com" }'

Response

An instance of member resource.

Sample Response

jsonCopied
1{
2    "email": "ironman@stark.com",
3    "user_id": "a6e5ea2f-7d96-4852-9f46-2383dfd572f7",
4    "create_time": "2022-04-11T15:18:00.701Z",
5    "update_time": "2022-04-11T15:18:00.701Z"
6}

Errors

Forbidden: API Client cannot edit members.
Unauthorized: API Client does not have valid credentials.
BadRequest: Either required properties are missing, or there was a malformed request.

Last updated on December 18, 2025

Privacy Policy Terms & Conditions© 2026 Taxfyle