Skip to main content
POST
Update Use Case

Authorizations

api_key
string
header
required

Body

application/json

Use case update input

oId
string
required

The ID of the use case to update

Minimum string length: 1
Example:

"uc_1234"

name
string

The name of the use case

Example:

"Lead Generation"

internalName
string

The internal name of the use case

Example:

"Lead Gen Process"

description
string

A description of the use case

Example:

"Automated lead generation and qualification process"

primaryUrl
string<uri>

The primary URL of the use case

Example:

"https://www.example.com/lead-generation"

summary
string

A brief summary of the use case

Example:

"Streamlined lead capture and qualification"

scenarios
string[]

Different scenarios where this use case applies

Example:
desiredOutcomes
string[]

The desired outcomes from this use case

Example:
businessDrivers
string[]

Business drivers that motivate this use case

Example:
strategicImpact
string[]

The strategic, business-level benefit realized when this use case is solved well: quantifiable impact on revenue, cost, risk, and/or efficiency, and the broader value to the company.

Example:
customFields
object[]

Custom fields for additional use case information

additionalProperties
object

Workspace-defined additional property values for this use case, keyed by property key.

Example:

Response

Use case updated successfully

_metadata
object
required
data
object
required