Skip to main content
POST
Update Service

Authorizations

api_key
string
header
required

Body

application/json

Service update input

oId
string
required

The ID of the service to update

Minimum string length: 1
Example:

"sc_1234"

name
string

The external name of the service

Example:

"Managed Analytics Onboarding"

internalName
string

The internal name of the service

Example:

"Analytics Onboarding Service"

description
string

A description of the service

Example:

"Hands-on onboarding engagement that configures and validates customer analytics dashboards"

primaryUrl
string<uri>

The primary URL of the service

Example:

"https://www.example.com/services/onboarding"

summary
string

A brief summary of the service

Example:

"6-week onboarding engagement for enterprise customers"

deliverables
string[]

Key deliverables of the service

Example:
competencies
string[]

Key competencies required for the service

Example:
comparativeAdvantage
string[]

The comparative advantage of the service

Example:
likelyAlternative
string[]

The likely alternative to the service

Example:
challengesAddressed
string[]

The challenges addressed by the service

Example:
customerBenefits
string[]

The customer benefits of the service

Example:
customFields
object[]

Custom fields for additional service information

additionalProperties
object

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

Example:

Response

Service updated successfully

_metadata
object
required
data
object
required