Update a case

PUT /api/2.0/crm/case/{caseid:[0-9]+}

Request

Updates the selected case with the parameters specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string: Can be one of: application/json.
Content-Typeenum of string: Can be one of: application/json.

Body

caseidinteger: Case ID
titlestring: New case title
membersarray of integer: List of contact IDs of the case participants
customFieldListarray of object: New list of case custom fields
isPrivateboolean: Case privacy: private or not
accessListarray of string: New list of users with access to the case
isNotifyboolean: Notifies users from the access list about the case

Examples

PUT /api/2.0/crm/case/%7Bcaseid:[0-9]+%7D HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request PUT \
  --url 'https://example.com/api/2.0/crm/case/%7Bcaseid:[0-9]+%7D' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Case

Membersarray of object

SmallFotoUrlstring

MediumFotoUrlstring

DisplayNamestring

IsCompanyboolean

AccessListarray of object

Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring

IsPrivateboolean

IsSharedboolean

ShareTypeenum of integerformat: int32

[0 - None, 1 - ReadWrite, 2 - Read]

Can be one of: None, ReadWrite, Read.

Currencyobject

Titlestring
Symbolstring
Abbreviationstring
CultureNamestring
IsConvertableboolean
IsBasicboolean

CanEditboolean

CanDeleteboolean

IDintegerformat: int32

CreateByobject

Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring

Createdstring

Titlestring

IsClosedboolean

IsPrivateboolean

AccessListarray of object

Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring

CanEditboolean

CustomFieldsarray of object

EntityIdintegerformat: int32

Labelstring

FieldValuestring

FieldTypeenum of integerformat: int32

[0 - TextField, 1 - TextArea, 2 - SelectBox, 3 - CheckBox, 4 - Heading, 5 - Date]

Can be one of: TextField, TextArea, SelectBox, CheckBox, Heading, Date.

Positionintegerformat: int32

Maskstring