Update director details

PATCH https://app.speybooks.com/api/v1/directors/{id}

Updates one or more fields on a director. Partial update semantics (PATCH).

Path parameters

id string required
Director ID (e.g. dir_1). Must use the director prefix.

Body parameters

active string optional
Whether the director is currently active. Set to false on resignation.
address string optional
Optional postal address, max 2000 characters.
appointedDate string optional
Date of appointment as director (YYYY-MM-DD), or null.
connectedToDirectorId string optional
Prefixed director ID of the connected person (e.g. dir_1), or null. Used for S455 aggregation.
email string optional
Optional email address.
fullName string optional
Full legal name of the director or shareholder.
isShareholder string optional
Whether this person is a shareholder. Controls dividend allocation eligibility.
relationship string optional
Relationship to the connected director: spouse, child, parent, or associate. Required when connectedToDirectorId is provided.
resignedDate string optional
Date of resignation, or null if still active.
shareClass string optional
Share class held (e.g. Ordinary, A Ordinary). Defaults to Ordinary.
sharesHeld string optional
Number of shares held. Used to calculate dividend per share.
userId string optional
Prefixed user ID if the director has a linked user account, or null.

Response

200 Director updated. Returns the full updated director object.
Show response fields
updated boolean

Error codes

400 Invalid ID format or validation error.
404 Director not found.