POST /api/v2/approval_workflow_instances/{approval_workflow_instance_id}/approval_requests
Creates an approval request that is attached to a ticket. The request must include all of the following information:
- A subject and message for the approval
- A ticket the request should be associated with
- A workflow instance id for the request
- An assignee that will act as an approver
Allowed For
- Agents
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
approval_workflow_instance_id |
String | Yes |
The id of the approval workflow instance |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
ticket_id |
Integer | No |
Ticket id to attach the approval request to |
message |
String | No |
Details for the approval request |
assignee_user |
Integer | No |
User id of the request approver |
subject |
String | No |
Subject for the approval request |
workflow_instance_id |
String | No |
Workflow instance id for the approval request |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.