action flat_add_score_collaborator { label: "Add a new collaborator" description: "Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a resource.\n- To add an existing Flat user to the resource, specify its unique identifier in the `user` property.\n- To invite an external user to the resource, specify its email in the `userEmail` property.\n- To add a Flat group to the resource, specify its unique identifier in the `group` property.\n- To update an existing collaborator, process the same request with different rights.\n" provider: flat method: POST path: "/scores/{score}/collaborators" encoding: json input: { type: "object" description: "Add a collaborator to a resource." properties: { aclAdmin: { type: "boolean" description: "`True` if the related user can can manage the current document, i.e. changing the document permissions and deleting the document\n" } aclRead: { type: "boolean" description: "`True` if the related user can read the score. (probably true if the user has a permission on the document).\n" } aclWrite: { type: "boolean" description: "`True` if the related user can modify the score.\n" } group: { type: "string" description: "The unique identifier of a Flat group" } user: { type: "string" description: "The unique identifier of a Flat user" } userEmail: { type: "string" description: "Fill this field to invite an individual user by email.\n" } userToken: { type: "string" description: "Token received in an invitation to join the score.\n" } } } output: { description: "A collaborator of a score. The `userEmail` and `group` are only available if the requesting user is a collaborator of the related score (in this case these permissions will eventualy not be listed and exposed publicly).\n" type: "object" } }