Initiate a script execution#

Description#

Starts the process to execute a script. This is a long-running operation.

The response includes a Location header (and an operationLocation field in the response body) that points to the operation polling endpoint. For more details on long-running job polling, see Operations endpoint.

When the operation completes successfully, its resourceUrl points to the script run at /scripts/{scriptId}/runs/{runId}.

POST /scripts/{scriptId}/execution

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
X-Scripting-Nonce	header	string	false	A client-generated idempotency key. If a request with the same nonce was already processed for this script, the original run is returned instead of starting a new one.
body	body	ScriptExecution	true	The environment variables with which to start a run

Body parameter example#

{
  "SpreadsheetId": "9ba1b5dfbd3b4c8997f309fa61180b87",
  "apiKey": "Az86pm34xyz",
  "has-changed": "true",
  "row_number": "27"
}

Code Samples#

curl

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

httpie

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

wget

wget --method=POST "https://api.app.wdesk.com/scripts/{scriptId}/execution" \
    --output-document - \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'X-Scripting-Nonce: string' \
    --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',
  'X-Scripting-Nonce': 'string',
  'Authorization': 'Bearer {access-token}'
}

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

print(r.headers['Location'])

Returns#

202 - Accepted#

Response body for asynchronous operations. Contains an operationLocation field that specifies the URL to poll for the operation result. This URL can also be found in the Location header on the response.

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.