Cancel

Description

Cancel a change request.

Request

HTTP Method: POST

Query Parameter Description
change_request_id The ID of the change request
Path Parameter Description
story_id The ID of the story.

Sample request

curl -X POST \
  https://<<META.tenant.domain>>/api/v1/stories/<<story_id>>/change_request/cancel  \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>' \
  -d '{
        "change_request_id": "<<change_request_id>>"
      }'

Response

A successful request will return a JSON object that shows the change request has been deleted

Field description

Parameter Description
draft_id ID of the draft containing the change request.
draft_name Name of the draft containing the change request.
id The story container ID.
change_request The change request, which will be null as it was canceled.

Sample response

{
  "draft_id": 1234,
  "draft_name": "Initial draft",
  "change_request": null,
  "id": 154,
}
,
Was this helpful?