Patch Objective

curl --request PATCH \ --url https://tavusapi.com/v2/objectives/{objectives_id} \ --header 'Content-Type: application/json' \ --header 'x-api-key: <api-key>' \ --data ' [ { "op": "replace", "path": "/objective_name", "value": "updated_objective_name" } ] '

Authorizations

x-api-key

string

header

required

Path Parameters

objectives_id

string

required

The unique identifier of the objective.

Example:

"o12345"

Body

application/json

Note: The path field is a JSON Pointer string that references a location within the target document where the operation is performed.

For example:

[
  { "op": "replace", "path": "/data/0/objective_name", "value": "updated_objective_name" },
  { "op": "replace", "path": "/data/0/objective_prompt", "value": "Updated prompt for the objective" },
  { "op": "replace", "path": "/data/0/confirmation_mode", "value": "manual" },
  { "op": "add", "path": "/data/0/output_variables", "value": ["new_variable"] },
  { "op": "replace", "path": "/data/0/modality", "value": "visual" },
  { "op": "remove", "path": "/data/0/callback_url" }
]

enum<string>

required

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

Available options:

add,

remove,

replace,

copy,

move,

test

Example:

"replace"

path

string

required

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

Example:

"/objective_name"

value

any

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

Example:

"updated_objective_name"

Response

Objective updated successfully

message

string

Success message

Example:

"Objective updated successfully"

Introduction

Conversation

PAL

Face

Tools

Skills

Magic Canvas

Objectives

Guardrails

Knowledge Base

Pronunciation Dictionaries

Voices

Deployments

Patch Objective

Authorizations

Path Parameters

Body

Response