UpdateBot

PATCH

https://orgs.ezghcloud.com/v1/organizations/{orgId}/bots/{botId}

View as Markdown

Authorization

apiKeyoptionalHTTP
sessionCookieoptionalAPI key in cookie
oauthoptionalHTTP

Path parameters

orgIdstringrequired
botIdstringrequired

Header parameters

if-matchoptionalstring

Request bodyJSONrequired

namestringrequired

Returns

200

Success

JSON

idstringrequired
organizationIdstringrequired
namestringrequired
slugstringrequired
resourceNamestringrequired
groupIdsarray ofstringrequired
policyIdsarray ofstringrequired
createdAtstringrequired
updatedAtstringrequired

400

InvalidRequest

JSON

errorobjectrequired
3 properties
- codeinvalid_requestrequired
- messagestringrequired
- issuesoptionalarray ofobject
  2 properties
  pathstringrequired
  messagestringrequired

401

Unauthenticated

JSON

errorobjectrequired
2 properties
- codeunauthenticatedrequired
- messagestringrequired

403

Forbidden | AccessDenied | ForbiddenOrigin

JSON

One of the following:

ForbiddenEncoded
View ForbiddenEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeforbiddenrequired
  messagestringrequired
AccessDeniedEncoded
View AccessDeniedEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeaccess_deniedrequired
  messagestringrequired
ForbiddenOriginEncoded
View ForbiddenOriginEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeforbidden_originrequired
  messagestringrequired

404

NotFound

JSON

errorobjectrequired
2 properties
- codenot_foundrequired
- messagestringrequired

412

PreconditionFailed

JSON

errorobjectrequired
2 properties
- codeprecondition_failedrequired
- messagestringrequired

429

TooManyRequests

JSON

errorobjectrequired
2 properties
- codetoo_many_requestsrequired
- messagestringrequired

500

InternalError

JSON

errorobjectrequired
2 properties
- codeinternal_errorrequired
- messagestringrequired

503

Unavailable

JSON

errorobjectrequired
2 properties
- codeunavailablerequired
- messagestringrequired

curl --request PATCH \ --url https://orgs.ezghcloud.com/v1/organizations/string/bots/string \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "string" } '

{ "id": "string", "organizationId": "string", "name": "string", "slug": "string", "resourceName": "string", "groupIds": [ "string" ], "policyIds": [ "string" ], "createdAt": "string", "updatedAt": "string" }