Skip to main content
PUT
Rename a source

Authorizations

x-cominty-token
string
header
required

A Cominty Platform API secret. A key created now starts with sk-cmt-. Send it as is, or as Bearer sk-cmt-..., with at most one Bearer prefix. A key created before the prefix existed has no sk-cmt- and still works.

Path Parameters

source_pid
string
required

Public id of the source (the pid field, a string).

Body

application/json
name
string

New name of the source.

connection_id
string

Not used with a drag-and-drop source.

config
Config · object

Not used with a drag-and-drop source: its drive cannot change.

Response

Successful Response

created_at
string<date-time>
required
id
integer
required

Numeric id. Use it in source_ids on a capability or a scope.

pid
string
required

Public id. Use it in every path.

name
string
required
scope
string
required
created_by
string
required
store
string
required

draganddrop, googledrive or sharepoint. A key creates only draganddrop.

status
string
required

pending, syncing, synced, error, out_of_sync, cancelling, pausing, paused, archived, disconnected, inoperative_connection, expired_connection, invalid_configuration or daily_quota_reached.

size
integer
required
embedded_size
integer
required
config
Config · object
required
documents_synced
integer
required
documents_failed
integer
required
oversized_documents
integer
required
documents_embedded
integer
required
last_synced_at
string<date-time> | null
required
archived_at
string<date-time> | null
required
connection
ConnectionOut · object | null
required