Skip to main content

Batch adds shared account members

POST/v2/users/:id_or_email/sharedMembers/batchAdd

Adds members in bulk to the specified shared account and sets access permissions for each member. This API is reused in the self-service delegation scenario:

  • The delegator/account owner initiates the delegation through this API, and the server sets the SharedMember.status of newly added members to PENDING.

Request​

Path parameters

    id_or_email stringrequired
    • id:
    • email:

Body parameters

    members object[]

    Maximum number of members does not exceed 50.

    sendMimeType object
    email boolean
    calendar boolean
    type enum

    Member type

    • USER:
    • DEPARTMENT:
    • GROUP:

    Possible values: [USER, DEPARTMENT, GROUP]

    value string

    Member value.

    • When type is USER, the value is the user email.
    • When type is DEPARTMENT, the value is the department ID.
    • When type is GROUP, the value is the group email.
    isBlocked boolean

    Indicates whether the member is blocked.

    name string

    Name of the member. Read-only property.

    relationships enum[]

    Sharing relationship, such as LOGIN + SEND_AS / SEND_ON_BEHALF.

    Possible values: [LOGIN, SEND_AS, SEND_ON_BEHALF]

    status enum

    Shared member approval status, used for the self-service delegation scenario. For legacy data or legacy callers that do not pass this field, the business logic defaults to APPROVED to maintain online compatibility. The self-service delegation status flow: The delegator/account owner initiates the delegation (PENDING) → the delegate accepts (APPROVED) or rejects (REJECTED).

    • PENDING: Pending acceptance. After the delegator/account owner initiates the delegation, the delegate has not yet processed it.
    • APPROVED: Accepted. The delegate agrees to the delegation, and the delegation takes effect.
    • REJECTED: Rejected. The delegate rejects the delegation.
    • EXPIRED: Expired (reserved enumeration, not implemented in this release and will not be set).

    Possible values: [PENDING, APPROVED, REJECTED, EXPIRED]

Response

No response fieldsA successful response contains no documented fields.

Errors

400Bad Request
401

Access is unauthorized. Please check whether the correct authorization token is passed.

403

No API access permission. Please complete the relevant authorization on the application management page of the domain administrator.

404Not Found