Dropbox

Links

    Dropbox API

    Getting access, Developing, Testing

    Back to Dropbox

    Paper - Docs - Users - Add

    Allows an owner or editor to add users to a Paper doc or change their permissions using their email address or Dropbox account ID.

    Note: The Doc owner's permissions cannot be changed.

    Input

    type: object properties: data: type: object description: > doc_id: The Paper doc ID. members: User which should be added to the Paper doc. Specify only email address or Dropbox account ID. custom_message: A personal message that will be emailed to each successfully added member. quiet: Clients should set this to true if no email message shall be sent to added users. properties: doc_id: type: string description: The Paper doc ID. quiet: type: boolean description: >- Clients should set this to true if no email message shall be sent to added users. members: type: array description: >- User which should be added to the Paper doc. Specify only email address or Dropbox account ID. items: type: object description: > member: User which should be added to the Paper doc. Specify only email address or Dropbox account ID. permission_level: Permission for the user. properties: member: type: object description: | Includes different ways to identify a member of a shared folder. dropbox_id: Dropbox account, team member, or group ID of member. email: E-mail address of member. other: None properties: .tag: title: Choice of MemberSelector type: string enum: - dropbox_id - email - other dropbox_id: type: string description: Dropbox account, team member, or group ID of member. email: type: string description: E-mail address of member. permission_level: type: object description: > edit: User will be granted edit permissions. view_and_comment: User will be granted view and comment permissions. other: None properties: .tag: title: Choice of PaperDocPermissionLevel type: string enum: - edit - view_and_comment - other custom_message: type: string description: >- A personal message that will be emailed to each successfully added member. title: Data

    Output

    type: array items: type: object description: | Per-member result for :route:`docs/users/add`. member: One of specified input members. result: The outcome of the action on this member. properties: member: type: object description: | Includes different ways to identify a member of a shared folder. dropbox_id: Dropbox account, team member, or group ID of member. email: E-mail address of member. other: None properties: .tag: title: Choice of MemberSelector type: string enum: - dropbox_id - email - other dropbox_id: type: string description: Dropbox account, team member, or group ID of member. email: type: string description: E-mail address of member. result: type: object description: > success: User was successfully added to the Paper doc. unknown_error: Something unexpected happened when trying to add the user to the Paper doc. sharing_outside_team_disabled: The Paper doc can be shared only with team members. daily_limit_reached: The daily limit of how many users can be added to the Paper doc was reached. user_is_owner: Owner's permissions cannot be changed. failed_user_data_retrieval: User data could not be retrieved. Clients should retry. permission_already_granted: This user already has the correct permission to the Paper doc. other: None properties: .tag: title: Choice of AddPaperDocUserResult type: string enum: - success - unknown_error - sharing_outside_team_disabled - daily_limit_reached - user_is_owner - failed_user_data_retrieval - permission_already_granted - other