PapermarkDocs
APIReferenceDatarooms

Add group members

Add members by email (up to 500 per call). Viewers are created for unknown addresses; already-present members are skipped, so the call is idempotent. No invitation emails are sent. Returns the memberships for every email in the request.

POST
/v1/datarooms/{id}/groups/{gid}/members

Authorization

bearerAuth datarooms.write
AuthorizationBearer <token>

Dashboard-issued token (pm_live_...) or OAuth-issued access token.

In: header

Scope: datarooms.write

Path Parameters

id*string
gid*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.papermark.com/v1/datarooms/string/groups/string/members" \  -H "Content-Type: application/json" \  -d '{    "emails": [      "jane@acme.com",      "joe@acme.com"    ]  }'
{
  "data": [
    {
      "id": "clxmem1234567890",
      "object": "dataroom_group_member",
      "email": "jane@acme.com",
      "viewer_id": "string",
      "created": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string"
}
{
  "error": {
    "code": "bad_request",
    "message": "The request body is not valid JSON.",
    "doc_url": "https://www.papermark.com/docs/api/errors#bad_request",
    "details": null
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token. Include an `Authorization: Bearer <token>` header.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "Token is missing required scope: links.write.",
    "doc_url": "https://www.papermark.com/docs/api/errors#forbidden",
    "details": null
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Link link_abcd1234 not found.",
    "doc_url": "https://www.papermark.com/docs/api/errors#not_found",
    "details": null
  }
}
{
  "error": {
    "code": "unprocessable_entity",
    "message": "Invalid request body.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unprocessable_entity",
    "details": {
      "formErrors": [],
      "fieldErrors": {
        "expires_at": [
          "Invalid datetime"
        ]
      }
    }
  }
}
{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Rate limit exceeded. Try again in 30s.",
    "doc_url": "https://www.papermark.com/docs/api/errors#rate_limit_exceeded",
    "details": null
  }
}

List group members

Paginated list of a group's explicit email members. Viewers admitted via the group's `domains` or `allow_all` are not listed here.

Remove a group member

Removes a membership by its id (from the members list). The underlying viewer is kept — only their membership in this group is removed.