Skip to content

removeCollaborator

DELETE
/v5/books/{bookId}/collaborators/{id}

Remove a collaborator from the book

Parameters

Path Parameters

bookId
required
string

The id of the book. Same bookId url param on Bkper

id
required
string

The collaborator id or email

Responses

200

A Collaborator response

object
agentId

The id of agent that created the resource

string
createdAt

The creation timestamp, in milliseconds

string
email

The email of the Collaborator

string
id

The unique id that identifies the Collaborator in the Book

string
permission

The permission the Collaborator has in the Book

string
Allowed values: OWNER EDITOR POSTER RECORDER VIEWER NONE
updatedAt

The last update timestamp, in milliseconds

string
Example
{
"agentId": "string",
"createdAt": "1592000000000",
"email": "string",
"id": "string",
"permission": "OWNER",
"updatedAt": "1592000000000"
}