Skip to main content
PATCH
/
integrations
/
{id}
curl --request PATCH \
  --url https://panel.sendcloud.sc/api/v2/integrations/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shop_name": "Integration #1",
  "shop_url": "https://example.com",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "service_point_enabled": true,
  "service_point_carriers": [
    "ups"
  ],
  "webhook_active": true,
  "webhook_url": "https://example.com"
}
'
{
  "shop_name": "Integration #1",
  "shop_url": "https://example.com",
  "last_updated_at": "2019-08-24T14:15:22Z",
  "service_point_enabled": true,
  "service_point_carriers": [
    "ups"
  ],
  "webhook_active": true,
  "webhook_url": "https://example.com"
}

Documentation Index

Fetch the complete documentation index at: https://sendcloud.dev/llms.txt

Use this file to discover all available pages before exploring further.

API v2 is entering maintenance mode. New users should start with API v3 to access our latest features and improved performance. Already using v2? Don’t worry, your current integration remains fully functional. Read more about maintenance mode, or check out the migration guide for API v3.
Using this endpoint, you can change the webshop name and URL, edit the list of carriers you want to enable for service point delivery and enable or disable service point delivery by setting service_point_enabled to true or false. Unlike the Update an integration endpoint, you can send only the fields you want to update. You can obtain an integration id via the Retrieve a list of integrations endpoint.

Authorizations

​
Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Path Parameters

​
id
integer
required

The id of the integration

Body

application/json

An updated integration response object

​
shop_url
string<uri>

URL of the shop the integration connects to

Minimum string length: 1
​
service_point_enabled
boolean

Flag for denoting if delivery to service points is enabled

​
service_point_carriers
string[]

A list of carriers available for the service point picker. At least one carrier must be provided if the service point delivery is enabled.

​
webhook_active
boolean

Flag indicating if updates for parcels should be send via the webhook

​
webhook_url
string<uri>

A URL to which Sendcloud communicates updates in a parcel

Minimum string length: 1

Response

OK

An updated integration response object

​
shop_name
string
read-only

Name of the shop

Required string length: 1 - 250
Example:

"Integration #1"

​
shop_url
string<uri>

URL of the shop the integration connects to

Minimum string length: 1
​
last_updated_at
string<date-time>
read-only

Timestamp when the integration was last updated

​
service_point_enabled
boolean

Flag for denoting if delivery to service points is enabled

​
service_point_carriers
string[]

A list of carriers available for the service point picker. At least one carrier must be provided if the service point delivery is enabled.

​
webhook_active
boolean

Flag indicating if updates for parcels should be send via the webhook

​
webhook_url
string<uri>

A URL to which Sendcloud communicates updates in a parcel

Minimum string length: 1