Unpublish workflow

POST

/api/v1/workflows/{id}/unpublish

const url = 'https://api.justcrawl.io/api/v1/workflows/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/unpublish';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.justcrawl.io/api/v1/workflows/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/unpublish \
  --header 'Authorization: Bearer <token>'

Revert a published workflow back to draft and clear its route. Dispatch resolution will skip the workflow until it’s re-published with a route.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string format: uuid

The workflow’s stable logical id — the workflowId field of a workflow object, NOT its id field. id is the per-version row key and 404s here.

Responses

200

Workflow status flipped to draft; route cleared.

application/json

object

workflowId

string format: uuid

status

string

Allowed values: draft

Example

{
  "status": "draft"
}

401

Missing or invalid authentication token

application/json

object

error

string

Example

{
  "error": "Missing or invalid authentication token"
}

403

Insufficient permissions for this operation

application/json

object

error

string

Example

{
  "error": "No organization. Complete onboarding first."
}

404

Resource not found

application/json

object

error

string

Example

{
  "error": "Workflow not found"
}

500

Unexpected server error. Logs and PostHog $exception capture

application/json

object

error

string

Example

{
  "error": "Something went wrong"
}