Approve

Description

Approve 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/approve  \
  -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 with the status of the change request

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 live story ID.
change_request The change request. This contains id, the ID of the request, status, the status of the request which is one of "PENDING" or "APPROVED", and participants, an array of user IDs that made changes in the change request

Sample response

{
  "draft_id": 1234,
  "draft_name": "Initial draft",
  "change_request": {
    "id": 15,
    "status": "APPROVED",
    "participants": [1, 2, 3]
  },
  "id": 154
}
Was this helpful?