Skip to content
Sanmopia Modernization

Change branch office lifecycle state

Switch to Zen Mode
POST
/branch-office-lifecycle-changes
curl --request POST \
  --url https://example.com/branch-office-lifecycle-changes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "commandId": "example", "revisionId": "example", "branchOfficeProfileId": "example", "expectedRevision": 1, "lifecycleState": "onboarding", "reason": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ChangeBranchOfficeLifecycleRequest
object
commandId
required
string
>= 1 characters
revisionId
required
string
>= 1 characters
branchOfficeProfileId
required
string
>= 1 characters
expectedRevision
required
integer
lifecycleState
required
string
Allowed values: onboarding active suspended closed
reason
required
string
>= 1 characters
key
additional properties

Responses

Section titled “Responses”

201

Section titled “201”

Branch office lifecycle revision committed

Media typeapplication/json
BranchOfficeProfileRevisionResponse
object
revisionId
required
string
>= 1 characters
branchOfficeProfileId
required
string
>= 1 characters
revisionNumber
required
integer
>= 1
factGroup
required
string
Allowed values: profile lifecycle settlement_account membership_fee_policy credential_rotation
actorId
required
string
>= 1 characters
reason
required
string
>= 1 characters
effectiveAt
required
string format: date-time
key
additional properties

401

Section titled “401”

Supabase bearer token is required

403

Section titled “403”

Actor cannot change the branch office lifecycle

409

Section titled “409”

Expected revision is stale

503

Section titled “503”

Branch office profile store is unavailable