Pause a workflow

Nothing new starts until a version is activated again.

POST/v1/workflows/{workflowId}/pause

Request

curl --request POST \
  --url 'https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>/pause' \
  --header 'Authorization: Bearer <token>'

import json
import requests

url = "https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>/pause"
headers = {
  "Authorization": "Bearer <token>"
}

response = requests.request("POST", url, headers=headers)
print(response.json())

const response = await fetch("https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>/pause", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>/pause");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>/pause", nil)
  req.Header.Set("Authorization", "Bearer <token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>/pause"))
    .header("Authorization", "Bearer <token>")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://your-suite.grid82.app/your-app/v1/workflows/<workflowId>/pause")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "id": "<string>",
    "status": "<string>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}

Runs already started carry on.

Requires the workflows:write scope. Operation my.workflows.pause. MCP tool my_workflows_pause. CLI: grid82 my workflows pause (npx grid82).

Path parameters

Name	Type	Required	Description
`workflowId`	string	yes

Headers

Name	Type	Required	Description
`Idempotency-Key`	string	no	Any unique string. Sending the same key with the same request again returns the first response (marked `Idempotency-Replayed: true`) instead of running it twice. Reusing it for a different request is refused with 409. Kept for 24 hours. Up to 255 characters.

Response

application/json

Success

dataobjectrequired

Show child attributes

data.idstringrequired

data.statusstringrequired

Pause a workflow

Path parameters

Headers

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown