Skip to content
AveraAveraAvera Documentation

Set a lifecycle's initial state

PUT
/api/v1/projects/{projectId}/lifecycles/{lifecycleId}/initial-state
curl --request PUT \
  --url 'https://app.avera.io/api/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/lifecycles/example/initial-state?sandboxId=example' \
  --header 'Content-Type: application/json' \
  --data '{ "stateId": "example" }'

Stages the change into the change request named by sandboxId and returns the lifecycle as the request would leave it.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string format: uuid
lifecycleId
required
string

Query Parameters

Section titled “Query Parameters”
sandboxId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
stateId
required
string

Example generated

{
  "stateId": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
id
required
string
name
required
string
description
string | null
editable
required
boolean
initialStateId
required
string
states
required
Array<object>
object
id
required
string
name
required
string
lifecycleStatus
required
string
color
string | null
type
required
string
displayOrder
required
integer format: int32
transitions
required
Array<object>
object
id
required
string
fromStateId
required
string
toStateId
required
string
name
required
string
requiresSignature
required
boolean
separationOfDuties
required
boolean
requiredEndorsements
required
Array<object>
object
principal
required
object
type
required
string
id
required
string
signatureRequired
required
boolean
distinctUsers
integer | null format: int32
buttonLabel
string | null
buttonColor
required
string
buttonIcon
string | null
sortOrder
required
integer format: int32
requiresComment
required
boolean
commentMinLength
required
integer format: int32
confirmationRequired
required
boolean
confirmationMessage
string | null