Pause an item

/v1/companies/{campus}/items/{id}/pause

The item keeps its step and stops being walked until it is resumed. Answers the item as it is now.

Authorizations

Authorizationstringheaderrequired

Bearer token: Authorization: Bearer ozk_…. ozk_ platform API key (Authorization: Bearer ozk_…)

Path parameters

campusstringrequired

The company’s slug (plunge), never a row id

idstringrequired

Item id

Query parameters

formatenum<string>

Response format; overrides Accept (an unknown value is 400 invalid_format)

Available options: json, yaml, markdown, text

Response

The item Response format negotiates via the format field, an Accept header (application/json, text/yaml, text/markdown, text/plain), or the request Content-Type mirror; default JSON.

application/json
text/yaml
text/markdown
text/plain

idstring

campusstring

buildingstring

titlestring

bodystring

kindenum<string>

Available options: feature, bugfix, docs, research, content, task

sourceenum<string>

Available options: api, bot, schedule, then, node

priorityinteger

tierstring | null

The standard’s tier word (T2, V1); null until set

stepstring

intake, a step id of the building’s pipeline, done or parked

attemptinteger

statusenum<string>

Available options: active, done, failed, parked

parked_reasonstring | null

pausedenum<integer>

Available options: 0, 1

steerstring | null

last_outputstring | null

The previous step’s output, the next office’s {input}

cost_usdnumber

parent_item_idstring | null

created_atstring

updated_atstring

invalid_json — body is not valid JSON or YAML; invalid_format — format must be one of json, yaml, markdown, text

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

unauthorized — missing, invalid or revoked ozk_ key

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

company_not_found — no company with that slug for this account (a foreign slug answers the same); or no item with that id in this company; not_found — no route for this method on this path: every other method answers it

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

the item is in a state this action does not apply to (the code and message say why); nothing changed

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

upstream_error — the company service is unavailable; retry

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

not_enabled — the company service is not deployed on this tier

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

import os import requests response = requests.post( "https://api.plungeai.com/v1/companies/{campus}/items/{id}/pause", headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"}, ) if not response.ok: raise SystemExit(f"{response.status_code} {response.headers.get('X-Error-Code')}") print(response.json())

const response = await fetch('https://api.plungeai.com/v1/companies/{campus}/items/{id}/pause', { method: 'POST', headers: { Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`, }, }) if (!response.ok) throw new Error(`${response.status} ${response.headers.get('X-Error-Code')}`) console.log(await response.json())

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class Main { public static void main(String[] args) throws Exception { HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.plungeai.com/v1/companies/{campus}/items/{id}/pause")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .POST(HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); if (response.statusCode() >= 400) { System.out.println(response.statusCode() + " " + response.headers().firstValue("X-Error-Code").orElse("")); return; } System.out.println(response.body()); } }

{ "id": "<string>", "campus": "<string>", "building": "<string>", "title": "<string>", "body": "<string>", "kind": "feature", "source": "api", "priority": 0, "tier": "<string>", "step": "<string>", "attempt": 0, "status": "active", "parked_reason": "<string>", "paused": 0, "steer": "<string>", "last_output": "<string>", "cost_usd": 0, "parent_item_id": "<string>", "created_at": "<string>", "updated_at": "<string>" }

Authorizations

Path parameters

Query parameters

Response

Planned: TI-33

Planned: TI-34