Skip to content
AURA

Update Onboarding Task

PUT
/api/v1/user_onboarding_tasks/{task_id}

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
task_id
required
Any of:
string
Allowed value: all

Request Body

Section titled “Request Body ”
UpdateOnboardingTaskRequest
object
user_onboarding_task
required
UserOnboardingTaskUpdate
object
status
required
Status
string
Allowed values: done pending

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

BooleanResponse

Simple response returning a single boolean success status.

object
success
required
Success

Success status of the operation

boolean

400

Section titled “400 ”

Upstream error updating onboarding task

ErrorResponse
object
detail
Any of:
string
error
Any of:
string
error_code
Any of:
string

404

Section titled “404 ”

Not Found

ErrorResponse
object
detail
Any of:
string
error
Any of:
string
error_code
Any of:
string

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

500

Section titled “500 ”

Internal Server Error

ErrorResponse
object
detail
Any of:
string
error
Any of:
string
error_code
Any of:
string