Update Integration Instance
PATCH/api/tiktok-shop/integration-instances/:integration_instance_id
Patch-update name and/or integration_settings. integration_settings is merged into the existing JSON: a top-level key you send replaces that key, except the nested settings and shipping_labels objects, which are merged key by key.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Fields:
- name (sometimes, string, max 255)
- integration_settings (sometimes, array)
- integration_settings.* (nullable)
- integration_settings.shipping_labels.purchase_automatically (boolean, default false): buy TikTok's shipping label automatically for orders TikTok ships on its own label (TikTok Shipping), when the order is released. Buying a label charges the TikTok account the label fee, the same as Arrange shipment in Seller Center.
Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.