Skip to main content
PUT
/
connections
/
{connection_type}
/
{connection_id}
Update Connection
curl --request PUT \
  --url https://api.xplenty.com/{account_id}/api/connections/{connection_type}/{connection_id} \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "id": 123,
  "name": "<string>",
  "type": "<string>",
  "connection_group_id": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Enter your API key as the username. Leave the password field blank. Example: curl -u YOUR_API_KEY: https://api.xplenty.com/...

Headers

​
Accept
string
default:application/vnd.xplenty+json; version=2
required

API version header — required on all requests

Path Parameters

​
connection_type
string
required

The type of the connection (e.g., sftp, mysql, salesforce). Determines which connector schema the response is shaped against.

​
connection_id
integer
required

The numeric ID of the connection.

Body

application/json
​
name
string

Response

200 - application/vnd.xplenty+json; version=2

Connection updated

​
id
integer
​
name
string
​
type
string
​
connection_group_id
integer | null

ID of the connection group this connection belongs to, or null if ungrouped.

​
created_at
string<date-time>
​
updated_at
string<date-time>
​
url
string<uri>
Last modified on June 12, 2026