Add a director or shareholder
POST
https://app.speybooks.com/api/v1/directors/Adds a new director or shareholder. At minimum, fullName is required. Share class defaults to Ordinary.
To link a connected person for S455 aggregation, provide both connectedToDirectorId and relationship. Both must be present together or both omitted.
Body parameters
active string optionalWhether the director is currently active. Set to
false on resignation.address string optionalOptional postal address, max 2000 characters.
appointedDate string optionalDate of appointment as director (YYYY-MM-DD), or
null.connectedToDirectorId string optionalPrefixed director ID of the connected person (e.g. dir_1), or
null. Used for S455 aggregation.email string optionalOptional email address.
fullName string optionalFull legal name of the director or shareholder.
isShareholder string optionalWhether this person is a shareholder. Controls dividend allocation eligibility.
relationship string optionalRelationship to the connected director:
spouse, child, parent, or associate. Required when connectedToDirectorId is provided.resignedDate string optionalDate of resignation, or
null if still active.shareClass string optionalShare class held (e.g. Ordinary, A Ordinary). Defaults to Ordinary.
sharesHeld string optionalNumber of shares held. Used to calculate dividend per share.
userId string optionalPrefixed user ID if the director has a linked user account, or
null.Response
201 Director created. Returns the full director object with prefixed ID.
Show response fields
id stringError codes
400 Validation error or invalid connected director reference.