Skip to main content
PATCH
/
v2.0
/
projects
/
{projectId}
Update a Project
curl --request PATCH \
  --url https://api-trial.cognigy.ai/new/v2.0/projects/{projectId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "New Project",
  "color": "blue",
  "handoverConfiguration": {
    "setupLiveAgentInbox": true,
    "whisperAssistConfiguration": "none"
  }
}
'
{
  "type": "Bad Request",
  "title": "Bad Request Error",
  "status": 400,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

ā€‹
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

ā€‹
projectId
string
required
Required string length: 24
Pattern: ^[a-z0-9]{24}$

Body

application/json
ā€‹
name
string

The name of the Project

Example:

"New Project"

ā€‹
color
Available options:
aliceBlue,
antiqueWhite,
aqua,
aquamarine,
azure,
beige,
bisque,
black,
blanchedAlmond,
blue,
blueViolet,
brown,
burlyWood,
cadetBlue,
chartreuse,
chocolate,
coral,
cornflowerBlue,
cornsilk,
crimson,
cyan,
darkBlue,
darkCyan,
darkGoldenRod,
darkGray,
darkGrey,
darkGreen,
darkKhaki,
darkMagenta,
darkOliveGreen,
darkOrange,
darkOrchid,
darkRed,
darkSalmon,
darkSeaGreen,
darkSlateBlue,
darkSlateGray,
darkSlateGrey,
darkTurquoise,
darkViolet,
deepPink,
deepSkyBlue,
dimGray,
dimGrey,
dodgerBlue,
fireBrick,
floralWhite,
forestGreen,
fuchsia,
gainsboro,
ghostWhite,
gold,
goldenRod,
gray,
grey,
green,
greenYellow,
honeyDew,
hotPink,
indianRed,
indigo,
ivory,
khaki,
lavender,
lavenderBlush,
lawnGreen,
lemonChiffon,
lightBlue,
lightCoral,
lightCyan,
lightGoldenRodYellow,
lightGray,
lightGrey,
lightGreen,
lightPink,
lightSalmon,
lightSeaGreen,
lightSkyBlue,
lightSlateGray,
lightSlateGrey,
lightSteelBlue,
lightYellow,
lime,
limeGreen,
linen,
magenta,
maroon,
mediumAquaMarine,
mediumBlue,
mediumOrchid,
mediumPurple,
mediumSeaGreen,
mediumSlateBlue,
mediumSpringGreen,
mediumTurquoise,
mediumVioletRed,
midnightBlue,
mintCream,
mistyRose,
moccasin,
navajoWhite,
navy,
oldLace,
olive,
oliveDrab,
orange,
orangeRed,
orchid,
paleGoldenRod,
paleGreen,
paleTurquoise,
paleVioletRed,
papayaWhip,
peachPuff,
peru,
pink,
plum,
powderBlue,
purple,
rebeccaPurple,
red,
rosyBrown,
royalBlue,
saddleBrown,
salmon,
sandyBrown,
seaGreen,
seaShell,
sienna,
silver,
skyBlue,
slateBlue,
slateGray,
slateGrey,
snow,
springGreen,
steelBlue,
tan,
teal,
thistle,
tomato,
turquoise,
violet,
wheat,
white,
whiteSmoke,
yellow,
yellowGreen,
none,
transparent
Example:

"blue"

ā€‹
handoverConfiguration
object

Response

Successfully updated the Project.