Update director details

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

Updates one or more fields on a director; only the fields supplied are changed. Setting active back to true reactivates a resigned director. The updated record is returned.

Path parameters

idstringrequired
Director ID (e.g. dir_1). Must use the director prefix.

Body parameters

activestringoptional
Whether the director is currently active. Set to false on resignation.
addressstringoptional
Postal address, or null.
appointedDatestringoptional
Date of appointment (YYYY-MM-DD), or null.
connectedToDirectorIdstringoptional
Prefixed director ID of the person this director is connected to for S455, or null. Set together with relationship.
emailstringoptional
Email address, or null.
fullNamestringoptional
Full legal name of the director or shareholder.
isShareholderstringoptional
Whether this person is a shareholder. A dividend can only be declared to a shareholder.
relationshipstringoptional
Relationship to the connected director, one of spouse, child, parent, or associate, or null. Set together with connectedToDirectorId.
resignedDatestringoptional
Date of resignation (YYYY-MM-DD), or null while active. Once stamped it is preserved.
shareClassstringoptional
Share class held (for example Ordinary). Defaults to Ordinary.
sharesHeldstringoptional
Number of shares held, or null. Feeds per-share dividend arithmetic.
userIdstringoptional
Prefixed user ID when the director has a linked platform account, otherwise null (for example a spouse who holds shares but does not log in).

Response

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

Error codes

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