Skip to content
action

/api/v1/action/update-status

POST
/api/v1/action/update-status
curl --request POST \
--url https://dpg.example.com/api/v1/action/update-status \
--header 'Content-Type: application/json' \
--header 'x-api-key: <x-api-key>' \
--data '[ "example" ]'
x-acting-org-id
string

Organization this request acts on behalf of. Optional: a non-admin actor can perform an action without acting for an org.

Media typeapplication/json
Array
Examplegenerated
[
"example"
]

Default Response

Media typeapplication/json
object
results
required
Array
Any of:
object
index
required
integer
<= 9007199254740991
status
required
string
Allowed values: success
action_id
required
string
action_type
required
string
action_status
required
string
update_count
required
integer
<= 9007199254740991
summary
required
object
total
required
integer
<= 9007199254740991
succeeded
required
integer
<= 9007199254740991
failed
required
integer
<= 9007199254740991
Example
{
"results": [
{
"status": "success"
}
]
}

Default Response

Media typeapplication/json
object
results
required
Array
Any of:
object
index
required
integer
<= 9007199254740991
status
required
string
Allowed values: success
action_id
required
string
action_type
required
string
action_status
required
string
update_count
required
integer
<= 9007199254740991
summary
required
object
total
required
integer
<= 9007199254740991
succeeded
required
integer
<= 9007199254740991
failed
required
integer
<= 9007199254740991
Example
{
"results": [
{
"status": "success"
}
]
}

Default Response

Media typeapplication/json
object
error
required
string
message
required
string
Examplegenerated
{
"error": "example",
"message": "example"
}

Default Response

Media typeapplication/json
object
results
required
Array
Any of:
object
index
required
integer
<= 9007199254740991
status
required
string
Allowed values: success
action_id
required
string
action_type
required
string
action_status
required
string
update_count
required
integer
<= 9007199254740991
summary
required
object
total
required
integer
<= 9007199254740991
succeeded
required
integer
<= 9007199254740991
failed
required
integer
<= 9007199254740991
Example
{
"results": [
{
"status": "success"
}
]
}