Skip to main content
PATCH
Patch connector

Authorizations

Authorization
string
header
required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Path Parameters

connectorId
string
required

Internal numeric ID of the connector

Query Parameters

connectionTest
boolean

Run a connection test before saving; automatically true for MAGENTO and TYPO3

Body

application/json
name
string
required

Name of the connector

Maximum string length: 255
type
string
required

Connector type

commitMessage
string
defaultRemoteFolder
string
encodedDefaultRemoteFolder
string
sourceUrl
string

Response

OK

created
string<date-time>

Date and time the connector was created

id
string

Internal numeric identifier, encoded as a string

linkedAccount
string

Name of the account linked to this connector on the remote service; null if unavailable. For connector types without a live connection test (e.g. PHRASE, GIT), this may be null while the connector is in the initial PENDING synchronization state and becomes populated once synchronization completes.

localToken
string

Backend token identifying this connector; required by connector backend calls

name
string

Connector display name

status
string

Connection status reported by the backend; null if the backend did not return a status. Fetched live from the connector backend on every call. A live remote connectivity test is only run for MAGENTO and TYPO3 connector types (see PATCH connector docs); for all other types this reflects the backend's stored credential/sync state rather than a live health check. For PHRASE (Strings job sync) and GIT connectors, PENDING is a valid, expected state meaning an initial synchronization is still in progress - typically right after connector creation - and is not itself an error; the status transitions to OK once synchronization completes.

type
string

Connector type identifier (e.g. FTP, GIT, GITHUB)