Skip to content

Connect Drive Folder

POST
/customer-success/companies/{company_id}/drive-folder

Map a folder in the organisation’s Google Drive to this client. OWNER/ADMIN.

Uses the Workspace connection the organisation already has - no new grant is made. Mapping the same Drive folder again UPDATES it, and mapping a different folder to the same Library folder REPLACES that mapping. A sync is queued straight away so the files start importing. 400 when the company is not an active client.

Authorizations

Parameters

Path Parameters

company_id
required

Company id.

string

Company id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors csm.DriveFolderConnectRequest.

object
folder_id
required

Google Drive folder id.

string
folder_name
required

Folder name, as shown in Drive.

string
label
Any of:
string
library_folder_id
Any of:
string
library_folder_path
Any of:
string
local_folder_key
Any of:
string
local_folder_name
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a single role, team, member or account record.

Open on purpose. The app’s own response models on this surface grow with the product - RoleResponse gained rep_limits and manages_role_slugs, TeamResponse gained channel counts and a campaign count - and a pinned mirror would SILENTLY DROP whatever it had not caught up on. A dropped permission in a role read is the worst possible kind of stale: it reads as “they do not have it”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string