Skip to navigation
ReferenceAPI Referenceworkflows

Check Workflow Name Availability

Deprecated

Deprecated shim kept for the pre-auto-name web client, which gates its create button on this call.

Workflow names are no longer unique per workspace, so this always reports available: true for a name that passes the shared name policy. An invalid name still returns 422. exclude_id is accepted and ignored. Removed once no deployed client calls it.

Authentication

AuthorizationBearer
Clerk JWT token
OR
AuthorizationBearer

Onepin live API key (op_live_...). Test and public keys are reserved in Phase 1.

Headers

X-Workspace-Idstring or nullOptional

Query parameters

namestringRequired1-200 characters

Workflow name to check (trimmed before comparison).

exclude_idstring or nullOptionalformat: "uuid"

Workflow to exclude from the check — its own name then reads as available. Pass the workflow’s id when validating a rename.

Response

Successful Response
dataobject

Result of a workflow-name availability check within a workspace.

metaobject

Errors

422
Unprocessable Entity Error