Skip to content

client_visibility.md

Latest commit

 

History

History
45 lines (30 loc) · 1.77 KB

client_visibility.md

File metadata and controls

45 lines (30 loc) · 1.77 KB

Client visibility

The client visibility refers to the newer way to work with clients in Basecamp 4, and not to the Clientside, which is covered in its own sections: approvals, correspondences and replies.

Endpoints:

Toggle client visibility

  • PUT /recordings/2/client_visibility.json allows changing the client visibility for the recording with an ID of 2.

Required parameter: visible_to_clients with value true or false.

This endpoint will return 200 OK with the current JSON representation of the recording if the update was a success. Notice that not all recordings allow toggling client visibility, some inherit the visibility of their parent. For example, individual to-dos inherit the visibility of the to-do list they belong to. This endpoint will return 403 Forbidden if the recording provided doesn't control its client visibility.

Example JSON Request
{
  "visible_to_clients": true
}
Copy as cURL
curl -s -H "Authorization: Bearer $ACCESS_TOKEN" -H "Content-Type: application/json" \
  -d '{"visible_to_clients":true}' -X PUT \
  https://3.basecampapi.com/$ACCOUNT_ID/recordings/2/client_visibility.json

Legacy project-scoped routes

The following project-scoped routes are still supported and will remain available, but flat routes above are the canonical form for new integrations.