API reference/Opportunity pipeline/Applications

POSTLive

Put application on hold

Pauses an application in place (e.g. hiring freeze); the pipeline stage is preserved.

/v1/applications/{applicationId}:hold

Authorization

Credential

oauth_user

Required scopes

applications:write

Path parameters

applicationId

string · required

Error responses

401Authentication required

No valid credentials were supplied. Attach a Bearer access token and retry.

402Upgrade required

The authenticated user's plan does not include this capability. `feature` names the gated capability, `requiredPlan` the cheapest plan that unlocks it, `currentPlan` the user's plan today, and `upgradeUrl` links to checkout. This is a plan gate, not a transient error — retrying without upgrading fails again; surface `upgradeUrl` to the user instead. Dormant until a plan that grants the feature is active, so a route that documents it may not currently return it.

403Insufficient scope

The token is valid but lacks the OAuth scope (or token kind) this endpoint requires.

404Resource not found

The addressed resource does not exist, or is not visible to the caller.

409Conflicting state

The resource is in a state that does not allow this operation (e.g. a terminal application stage or an already-decided offer).