Update state of User by id or external ref

1min

PUT
https://{domain}/app/api/v2/users/{userId}/transition
State Transitions Allowed
from_state->to_state
onboarding:onboarding->active:available
active:available->active:busy active:unavailable inactive:inactive active:allocated active:deboarding
active:busy->active:available
active:unavailable->active:available inactive:inactive
active:allocated->active:available
active:deboarding->inactive:inactive
inactive:inactive->active:available
inactive:terminal->
Header Parameters
X-Solutions-Callback-Secret
string
Body Parameters
body
UpdateStateRequest
Description
Request parameters for updating the State
All Of
StateTransitionRequest  +
toState
string
*
reasonCode
string
data
object
callback
object
Responses
202
Request Accepted
SuccessResponse
data
Data
error
Error
request
Request
default
Default Error Response
DefaultResponse
error
Error
request
Request
Curl
JS
Ruby
Python
curl --location --globoff --request PUT 'https://{domain}/app/api/v2/users/{userId}/transition' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "toState": "",
  "callback": {
    "url": ""
  }
}'
curl --location --globoff --request PUT 'https://{domain}/app/api/v2/users/{userId}/transition' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "toState": "",
  "callback": {
    "url": ""
  }
}'
Responses
202
default
// Request Accepted 
{
  "data": {
    "id": ""
  },
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  }
}
// Request Accepted 
{
  "data": {
    "id": ""
  },
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "requestId": "",
    "queryString": "",
    "body": {},
    "method": ""
  }
}
﻿
﻿

from_state	->	to_state
`onboarding:onboarding`	->	`active:available`
`active:available`	->	`active:busy` `active:unavailable` `inactive:inactive` `active:allocated` `active:deboarding`
`active:busy`	->	`active:available`
`active:unavailable`	->	`active:available` `inactive:inactive`
`active:allocated`	->	`active:available`
`active:deboarding`	->	`inactive:inactive`
`inactive:inactive`	->	`active:available`
`inactive:terminal`	->

Updated 15 Mar 2024

Did this page help you?

Get current state of User by id or external ref

Get contact details of the users.