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"
}
]
}{
"errors": [
{
"status": 404,
"code": "not_found",
"title": "Not Found",
"detail": "The Integration could not be found with the search criteria given"
}
]
}Manage integrations
Update certain parts of an integration
Update the shop name, shop URL, service point settings, webhook settings, and feedback type of an integration.
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"
}
]
}{
"errors": [
{
"status": 404,
"code": "not_found",
"title": "Not Found",
"detail": "The Integration could not be found with the search criteria given"
}
]
}OAuth2 scopes required:
write:integration. See Scopes for OAuth apps.- 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
HTTPBasicAuthOAuth2ClientCreds
Body
application/json
Integration object.
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:
1Response
No content