Skip to main content

OwnerChangeInstructionsDto

The outcome of asking for the portal-ownership transfer letter to be sent.

NameTypeDescriptionNotes
statusInteger (int32)Whether the letter was sent: 1 that it was, 0 that the request was turned down. A refusal comes back with HTTP 200, so this field and not the status code is what says whether anything happened - the request is turned down when the caller is not the portal owner and when the named member is unknown or inactive.[optional] [example: 1]
messageStringThe outcome spelled out in the portal language. On success it names the address the letter went to, and it carries an HTML mailto: anchor rather than plain text, so it has to be rendered as markup or stripped; on a refusal it is the localised reason.[optional] [example: Ownership transferred successfully] [nullable]