Skip to content
Roboto
Esc
↑↓navigate↵open⌘Jpreview

Update board access

Share a personal board with its org by making the org principal its owner.

The owner or an org admin can share a personal board. Any other caller receives 401 Unauthorized, except that any member may repeat the request for a board already shared. A board outside the caller’s org returns 404 Not Found. Sharing cannot be undone: no request makes a shared board personal again. To get a personal board, create a new board from a copy of its definition.

Sharing a board is not sharing data. The board holds a query, never a credential and never a snapshot, so each member who opens it sees only what their own platform access allows.

The definition and the revision are left unchanged, so an editor who loaded the board before it was shared can still save from the revision they loaded.

Access control

  • requires_org
  • Restricted tokens cannot call this endpoint
PUT/v1/boards/id/{board_id}/access
Authorization
AuthorizationBearer token · headerrequired
Path parameters
board_idstringrequired
Header parameters
X-Roboto-Org-Idstring
X-Roboto-User-Idstring
Request body
requiredapplication/json
accessibilitystringrequired
Responses
200

OK

dataobjectrequired

A wire-transmissible representation of a board.

Show properties
board_definitionobjectrequired
board_idstringrequired
createdstring<date-time>required
created_bystringrequired
modifiedstring<date-time>required
modified_bystringrequired
namestringrequired
org_idstringrequired
owner_principal_idstringrequired
revisioninteger
default: 0
400

Thrown when the conversation context (messages, system prompt, tool results) exceeds the model's context window limit.

The token estimate and the model's context limit are not carried on the exception, so a caller cannot read usage numbers off it.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
401

Thrown when authentication fails

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
403

Thrown if an operation would exceed a user or org level limit.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
404

Thrown if a user is attempting to perform an action unrecognized by the Roboto platform.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
409

Thrown if there is a conflict between a resource you're creating and another existing resource

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
410

Thrown if a resource is missing or expired.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
500

An error the platform reported that this SDK release cannot resolve to a specific exception class.

Reported for an element of a :py:class:~roboto.http.BatchResponse whose error names a code this release defines no class for, or that arrived without a code, without a message, or as text that is not an error envelope at all. It carries whatever code and message the platform sent, so a caller handling the failure still learns what went wrong; when no message could be read, the message is the error's raw text.

The error envelope carries no status code, so http_status_code reports the 500 inherited from :py:class:RobotoDomainException rather than the status the failure actually had.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
501

Thrown by shimmed out APIs which have not yet been implemented

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
503

Thrown when a service is unavailable, such as when it's under heavy load and can't accept new requests. This is expected to be transient and ought to be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
504

Thrown when the service times out while processing a request. This is exepcted to be transient and ought to be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
507

Thrown when the server cannot complete the request because the response payload exceeds a storage or transport capacity limit (e.g., Lambda response size). This is NOT expected to be transient and should NOT be retried.

errorobject
Show properties
error_codenumber
messagestring
stack_tracestring | null
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X PUT 'https://api.roboto.ai/v1/boards/id/string/access' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "accessibility": "organization"
}'
Response
{
  "data": {
    "board_definition": {},
    "board_id": "string",
    "created": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "modified": "2019-08-24T14:15:22Z",
    "modified_by": "string",
    "name": "string",
    "org_id": "string",
    "owner_principal_id": "string",
    "revision": 0
  }
}

Was this page helpful?