Initiate Object Action on a Single Record

Use this request to initiate an action on a specific object record.

POST/api/{version}/vobjects/{object_name}/{object_record_id}/actions/{action_name}

Headers

Name	Description
`Content-Type`	`application/x-www-form-urlencoded`
`Accept`	`application/json` (default) or `application/xml`

URI Path Parameters

Name	Description
`object_name`	The object `name__v` field value.
`object_record_id`	The object record `id` field value from which to retrieve user actions.
`action_name`	The name of the `Objectaction` or `Objectlifecyclestateuseraction` to initiate. You can retrieve this from the Retrieve User Actions request. The format for `action_name` is `Objectaction.vobject.action` or `Objectlifecyclestateuseraction.vobject.state.action`.

Body Parameters

Include any parameters required to initiate the action as name-value pairs in the request body. You can retrieve the required parameters for your action by Retrieving Object User Action Details.

Request

curl -X POST -H "Authorization: {SESSION_ID}" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d 'due_date__c=2020-03-01T08:00:00.000Z' \
-d 'product__v.generic_name__c=nitroprinaline oxalate' \
-d 'product__v.internal_name__c=Nyaxa' \
-d 'product__v.compound_id__c=CC-127' \
-d 'approvers__c=user:10001399' \
https://myvault.veevavault.com/api/v20.2/vobjects/product__v/00P000000000301/actions/Objectlifecyclestateuseraction.product__v.active_state__c.start_workflow_useraction__c

Response

{
    "responseStatus": "SUCCESS"
}