Booking page visibility tool

This tool proposes making your booking page public or private and waits for you to approve it in a browser. It needs the permission profile:write, which you grant on the Authorize access page when you connect. This page is generated from the connector’s tool catalogue. It describes 1 tool. Every tool reads or writes only your own account.

Permissions this page needs

profile:write: Update your profile preferences, and propose booking page changes you approve

The permissions reference lists every permission you can grant.

`booking_update_page_visibility`

Your agent host shows this tool as “Propose booking page visibility”. What this changes: Propose making the authenticated student’s booking page public or private, which takes effect only after the student approves the change in a browser. Permissions: This tool needs profile:write, which the Authorize access page describes as “Update your profile preferences, and propose booking page changes you approve”. Risk: consequential. This tool cannot change anything on its own. It proposes the change, and nothing happens until you open the Coffee Chats page it points to and approve exactly what is shown.

Input

The agent sends one object, and the table below is that object exactly as the connector publishes it. The connector accepts the object in one of these 2 forms and refuses any mixture of them. A published schema cannot state that rule, which is why the Required column reads no on every property and why each form is written out under the table. Within a form, every property the form does not name is refused.

Property	Type	Required	Bounds
`idempotencyKey`	string	no	16 to 128 characters
`isPublic`	boolean	no	none stated
`operationId`	string	no	pattern `^[a-f0-9]{24}$`

Form 1, sending `idempotencyKey`, `isPublic`

Send idempotencyKey and isPublic. They are required in this form. No other property is accepted with them.

Form 2, sending `operationId`

Send operationId. It is required in this form. No other property is accepted with it.

Example calls

{
  "idempotencyKey": "example-idempotency-key-0003",
  "isPublic": true
}

{
  "operationId": "0123456789abcdef01234567"
}

Result

A result is never larger than 4,096 bytes. This tool’s result takes one of these 6 forms, and one call returns exactly one of them. The field named beside each form below says which one you are looking at. Open a form to read its top-level fields.

Shape 1, where tag is completed

Top-level fields

[
  "operationId",
  "operationStatus",
  "result",
  "scenario",
  "tag"
]

Shape 2, where tag is requires_confirmation

Top-level fields

[
  "actionStatus",
  "handoff",
  "operationId",
  "scenario",
  "tag"
]

Shape 3, where tag is accepted

Top-level fields

[
  "operationId",
  "operationStatus",
  "scenario",
  "tag"
]

Shape 4, where status is failed

Top-level fields

[
  "error",
  "operationId",
  "scenario",
  "status"
]

Shape 5, where status is cancelled

Top-level fields

[
  "error",
  "operationId",
  "scenario",
  "status"
]

Shape 6, where status is uncertain

Top-level fields

[
  "error",
  "operationId",
  "scenario",
  "status"
]

The result may carry a retry hint

A call can be accepted and still ask the agent to come back later. When that happens the result is an accepted result and not a failure, and it carries a hint beside it holding one of these codes and a delay in milliseconds. Nothing has gone wrong and nothing has been written yet.

Code	What it means
`PERMIT_BACKPRESSURE`	Too much work is already running on this connection. The agent should wait for the stated delay and call the tool again.
`PERMIT_CONTENTION`	Another call was holding the same slot. The agent should wait for the stated delay and call the tool again.

Errors

A call that does not succeed carries one of these codes.

Code	What it means
`ACTION_DENIED`	Either you declined this review request, or the connection was no longer allowed to make the change when Coffee Chats came to apply it. Nothing was written.
`ACTION_EXPIRED`	The review request ran out of time, either before you decided or before Coffee Chats could apply it. Nothing was written.
`NOT_APPLIED`	Coffee Chats stopped before writing anything. Your data is exactly as it was.
`OPERATION_CANCELLED`	The connection was revoked before the change started, so nothing was written.
`OUTCOME_UNKNOWN`	Coffee Chats cannot prove whether the change was written and will not guess. Open your Coffee Chats page and look before you decide what to do. Do not ask the agent to retry with a new key, because that could apply the change twice.
`SERVICE_UNAVAILABLE`	Coffee Chats could not do the work just now and wrote nothing. Try again later.
`VERSION_CONFLICT`	The page changed after the agent read it, so nothing was written. Ask the agent to read the page again and propose the change from what is there now.

Get started

Chrome extension

How it works

Guides

Reference

Permissions this page needs

`booking_update_page_visibility`

Input

Form 1, sending `idempotencyKey`, `isPublic`

Form 2, sending `operationId`

Example calls

Result

The result may carry a retry hint

Errors

​Permissions this page needs

​booking_update_page_visibility

​Input

​Form 1, sending idempotencyKey, isPublic

​Form 2, sending operationId

​Example calls

​Result

​The result may carry a retry hint

​Errors

Permissions this page needs

`booking_update_page_visibility`

Input

Form 1, sending `idempotencyKey`, `isPublic`

Form 2, sending `operationId`

Example calls

Result

The result may carry a retry hint

Errors