Skip to content
Sign In

requestBookAccess

POST
/v5/books/{bookId}/collaborators/request

Request access to a Book

Authorizations

Parameters

Path Parameters

bookId
required
string

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

Query Parameters

permission
required
string
Allowed values: OWNER EDITOR POSTER RECORDER VIEWER NONE

The permission requested in the Book

message
string

An optional message to the Book owner

Responses

204

Successful response with no content.

default

An error response from the Bkper API or its public API proxy.

A JSON error response. API operation errors use the nested error object. Public API proxy errors use the Problem Details fields.

object
error
object
errors
Array<object>
object
domain
string
reason
string
message
string
code
required
integer format: int32
message
required
string
type
string
title
string
status
integer format: int32
detail
string
instance
string
code
string