Skip to main content
PATCH
/
integrations
/
{id}
curl --request PATCH \
  --url https://panel.sendcloud.sc/api/v3/integrations/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "shop_name": "My Webshop"
}
'
{
  "errors": [
    {
      "status": "400",
      "code": "invalid",
      "title": "Invalid",
      "detail": "Webhook URL required when enable webhook is set to true"
    }
  ]
}
You can update certain parts of an integration with this endpoint:
  • Update the shop name of an integration
  • Update the shop URL of an integration
  • Enable service points and select the appropriate service point carriers
  • Enable webhooks and set the webhook URL
  • Change the type of feedback you would like the integration to follow

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required

Filtering on the Sendcloud integration ID

Required range: x >= 1

Body

application/json

Integration object.

​
shop_name
string

Name of the shop.

Required string length: 1 - 250
Example:

"My Shop Integration"

​
shop_url
string<uri>

URL of the shop the integration connects to.

Minimum string length: 1
Example:

"https://www.my-shop-integration.com/"

​
service_point_enabled
boolean

Flag indicating if delivery to service points is enabled.

Example:

false

​
service_point_carriers
string[]

List of carriers available for the service point picker. If service point delivery is enabled, make sure to provide at least one carrier.

Example:
["ups", "dhl"]
​
webhook_active
boolean

Flag indicating if parcel updates should be sent via the webhook.

Example:

false

​
webhook_url
string<uri> | null

URL for sending updates on a parcel. A value for webhook_url is required if webhook_active is set to true.

Minimum string length: 1
Example:

"https://my-shop-integration.integrator/api/webhooks/sendcloud"

​
feedback_type
enum<string>

Define how your shop status feedback should be sent into your system. Note that this will not apply to Prestashop V2 as the custom status mapping will define this.
Use the following states:

  • eager: Change the parcels’ status to “sent” once the label is created.
  • delayed: Change the parcels’ status to “sent” once the carrier scans the label.
  • none: Don’t send any feedback.
Available options:
eager,
delayed,
none
Minimum string length: 1

Response

No content