Sync script sources from a ZIP archive#

Description#

Starts the process to synchronize a script’s source directory from an uploaded ZIP archive. This is a long-running operation using a two-step upload pattern.

POST this endpoint to receive an uploadUrl and operation polling URL.
PUT the ZIP archive to the uploadUrl.
Poll the operation for completion via the Location header URL. For more details, see Operations endpoint.

When the operation completes, resourceUrl points to the sources collection.

POST /scripts/{scriptId}/sources/sync

Required OAuth Scopes

file:write

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	true	Version of the API (2026-09-01.scripting.preview)
scriptId	path	string	true	The unique identifier of the script
body	body	SourceSyncRequest	false

Body parameter example#

{
  "mode": "replace"
}

Code Samples#

curl

curl -X POST https://api.app.wdesk.com/scripts/{scriptId}/sources/sync \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2026-09-01.scripting.preview'

httpie

http POST https://api.app.wdesk.com/scripts/{scriptId}/sources/sync \
    X-Version:2026-09-01.scripting.preview \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=POST "https://api.app.wdesk.com/scripts/{scriptId}/sources/sync" \
    --output-document - \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2026-09-01.scripting.preview'

python

import requests

headers = {
  'X-Version': '2026-09-01.scripting.preview',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.app.wdesk.com/scripts/{scriptId}/sources/sync', headers = headers)

print(r.headers['Location'])

Returns#

202 - Accepted#

Response body for source sync. Contains both operationLocation for polling and uploadUrl for the ZIP upload.

Header	Description
Location	The location to poll for the operation result.
Retry-After	The number of seconds to wait before polling for a result and between polling attempts.