Embedded APIResourcesConnections

Update connection

Updates a connection in a customer account. Requires oem_vendor privilege.

Path parameters

managed_user_idstringRequired

Embedded customer ID (external ID). The External ID must be URL encoded and prefixed with an E. For example, EA2300.

connection_idstringRequired
ID of the connection.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringOptional

Connection name, for example, Prod Salesforce connection.

inputmap from strings to anyOptional
Connection setting fields.
folder_idintegerOptional
Folder id where connection should be stored.
parent_idintegerOptional
ID of parent connection.
external_idstringOptional
External identifier given to the user who owns the runtime user connection.
oauth_token_pairobjectOptional

Response

Success reply
idinteger or null
The unique identifier for the connection.
namestring or null
The name of the connection.
providerstring or null
The provider associated with the connection.
authorized_atstring or null
The timestamp when the connection was authorized.
authorization_statusstring or null
The status of the connection authorization.
authorization_errorstring or null
Details of any authorization errors, if applicable.
created_atstring or null
The timestamp when the connection was created.
updated_atstring or null
The timestamp when the connection was last updated.
external_idstring or null
The external ID associated with the connection.
folder_idinteger or null
The ID of the folder containing the connection.
parent_idinteger or null
The ID of the parent connection, if applicable.

Errors