Add a director or shareholder

POSThttps://app.speybooks.com/api/v1/directors/

Adds a director or shareholder. Only the full name is required; the share class defaults to Ordinary and the record is created active. To link a connected person for S455, supply both connectedToDirectorId and a relationship, or neither; the connected director must already exist. The created record is returned.

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

201Director created. Returns the full director object with prefixed ID.
Show response fields
activeboolean
connectedToDirectorIdstring
fullNamestring
idstring
isShareholderboolean
relationshipstring

Error codes

400Validation error or invalid connected director reference.