Objectives

Patch Objective

Changed on

This endpoint allows you to update specific fields of an objective using JSON Patch operations.

patch/v2/objectives/{objectives_id}

Request

  • Base URL
    https://tavusapi.com
  • URL
    https://tavusapi.com/v2/objectives/{objectives_id}
  • Auth
    API key in header x-api-key

Request body

op'add' | 'remove' | 'replace' | 'copy' | 'move' | 'test' required

The operation to perform. Must be one of: add, remove, replace, copy, move, test

pathstring required

A JSON Pointer string that references a location within the target document where the operation is performed

valuestring

The value to be used within the operation. This field is not required for the remove operation.

Example request

[
  {
    "op": "replace",
    "path": "/objective_name",
    "value": "updated_objective_name"
  }
]

Response

Objective updated successfully

messagestring

Success message

Example response

{
  "message": "Objective updated successfully"
}

Changes

    • info

      the endpoint scheme security apiKey was added to the API

    • info

      added the media type application/json to the request body

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status