Create a profile check action
POST/workflow_actions/profile_check_actions
Create a profile check action
Request
- application/json
Body
required
workflow_action object
The workflow the workflow action belongs to.
The description of the workflow action.
Default value: false
If the workflow action is archived or not.
An array of ne_attribute_ids.
Possible values: [session
, attribute
]
The handle type for what should happen if an existing profile is found.
The handle id. When handle type is session, this is the session id.
Responses
- 200
- 400
- 500
Expected response to a valid request
- application/json
- Schema
- Example (from schema)
Schema
workflow_action object
The workflow the workflow action belongs to.
The description of the workflow action.
The page the workflow action should render.
Default value: true
If the requester should be added as the owner of the profile to be created.
The attribute storing the email address for the workflow action.
The email addresses for the workflow action.
The new status for the Status Change workflow action.
Default value: false
If the workflow action is archived or not.
Default value: false
If the workflow action is skippable or not.
Default value: false
If the workflow action requires a comment or not.
{
"workflow_action": {
"workflow_id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
"description": "Require approval from another user or a group of users with a specific role.",
"page_id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
"add_requester_as_owner": true,
"email_attribute_id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
"email_addresses": [
"[email protected]",
"[email protected]"
],
"new_status": "Active, Inactive, On Leave, Terminated",
"archived": false,
"skippable": false,
"requires_comment": false
}
}
Bad Request - unable to complete.
- application/json
- Schema
- Example (from schema)
Schema
- InvalidJson
- ValidationErrors
{}
Internal Server Error - returned on unhandled exceptions.
- application/json
- Schema
- Example (from schema)
Schema
A message describing the error
{
"error": "Sorry something went wrong"
}