{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://api-evangelist.github.io/smokeball/json-schema/smokeball-staffdto.json", "title": "Smokeball StaffDto", "type": "object", "properties": { "userId": { "type": "string", "description": "Unique identifier of the associated user. Used to map staff member to the specified user id and ignored if left blank.\r\nUse the FirmUsers API to remove a staff/user mapping.", "nullable": true, "example": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2" }, "title": { "type": "string", "description": "Staff member's title.", "nullable": true, "example": "Mr" }, "firstName": { "type": "string", "description": "Staff member's first name.", "nullable": true, "example": "John" }, "middleName": { "type": "string", "description": "Staff member's middle name (if applicable).", "nullable": true, "example": "" }, "lastName": { "type": "string", "description": "Staff member's last name.", "nullable": true, "example": "Smith" }, "initials": { "type": "string", "description": "Staff member's initials.", "nullable": true, "example": "JS" }, "phone": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberDto" } ], "description": "Staff member's phone number.", "nullable": true }, "cell": { "allOf": [ { "$ref": "#/components/schemas/PhoneNumberDto" } ], "description": "Staff member's cell number.", "nullable": true }, "email": { "type": "string", "description": "Staff member's email address.", "nullable": true, "example": "john.smith@brown.com" }, "role": { "type": "string", "description": "Staff member's role.", "nullable": true, "example": "Bookkeeper" }, "avatar": { "type": "string", "description": "Staff member's avatar.", "nullable": true, "example": "https://example-avatar-url.com/image" }, "former": { "type": "boolean", "description": "Whether he/she is a former member. \r\n\r\nCaution: Setting a staff member to former staff will also deregister them from the firm.", "nullable": true, "example": false }, "colorFill": { "type": "string", "description": "Staff member's fill color hex code.", "nullable": true, "example": "#797d85" }, "colorStroke": { "type": "string", "description": "Staff member's stroke color hex code.", "nullable": true, "example": "#64666a" } }, "additionalProperties": false }