Validate a Process

Description

Run a validation check on a process and return any structural or configuration errors found. Returns an empty errors array if the process is valid.

POST /processes/{processId}/validation

Required OAuth Scopes

file:read

Parameters

Parameter	In	Type	Required	Description
X-Version	header	string	true	Version of the API (2026-01-01)
processId	path	string	true	Identifier of the process

Code Samples

curl

curl -X POST https://api.app.wdesk.com/processes/{processId}/validation \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2026-01-01'

httpie

http POST https://api.app.wdesk.com/processes/{processId}/validation \
    X-Version:2026-01-01 \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=POST "https://api.app.wdesk.com/processes/{processId}/validation" \
    --output-document -  \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2026-01-01'

python

import requests

headers = {
  'X-Version': '2026-01-01',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://api.app.wdesk.com/processes/{processId}/validation', headers = headers)

print(r.json())

Returns

200 - Validation completed successfully

Returns a ProcessValidationResults object containing any validation errors found.

400 - Invalid request

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

401 - Unauthenticated request.

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

403 - Unauthorized

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

404 - Not found

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

409 - Collision

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

429 - Too Many Requests

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

500 - Server error

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

503 - Service Unavailable

Error response that indicates that the service is not able to process the incoming request. The reason is provided in the error message.

Example Responses

Process with validation errors

{
  "errors": [
    {
      "code": "MISSING_REQUIRED_FIELD",
      "message": "Job is missing required field: assigneeUser",
      "target": "/root/children/0/job"
    },
    {
      "code": "INVALID_DUE_DATE",
      "message": "Due date must be in the future",
      "target": "/dueDate"
    }
  ]
}

Process with no validation errors

{
  "errors": []
}

An invalid request.

{
  "code": "invalidUser",
  "documentationUrl": "http://developerdocs.example.com",
  "message": "The provided user is invalid.",
  "meta": {
    "argumentName": "assignee",
    "jobId": "job1234"
  },
  "target": "assignee"
}

An unauthenticated request.

{
  "code": "Unauthorized",
  "message": "Bad credentials"
}

Requestor does not have appropriate permissions for requested action.

{
  "code": "403",
  "message": "Forbidden"
}

A requested resource could not be found.

{
  "code": "404",
  "message": "Could not find process id 51bcc3ec3d0b4aadb69659e2a7ed767b"
}

A request cannot be completed because it conflicts with the current state of the target

resource on the server.

{
  "code": "409",
  "message": "Letter is not in a status that supports submissions"
}

No example available

The client (like a web browser) has sent too many requests to a server in a given amount of time.

{
  "code": "429",
  "message": "Rate limit of 1000 per 60 seconds exceeded for listJobs requests. Retry request in 10 seconds."
}

No example available

The server encountered an unexpected condition that prevented it from fulfilling the request.

This is a generic error message, meaning the server cannot provide a more specific error code.

{
  "code": "500",
  "message": "unknown error"
}

No example available

The server is currently unable to handle the request due to a temporary overload or scheduled

maintenance. This status code implies that the server is functional and understands the request, but it cannot fulfill it at the moment.

{
  "code": "503",
  "message": "Service Unavailable."
}

No example available