Sign in

v1

latestOpenAPI 3.1.12026-07-14355311.4 MB
Case

Create Case

Create a new 'Case' record.

post/Case

Headers

X-Skip-Duplicate-Check'true' | 'false'

Skip duplicate check.

X-Duplicate-Source-Idstring

A record ID of the entity that is being duplicated.

Request body

idstring

An ID.

namestring

A one-line string.

numberinteger

An auto-increment number.

status'New' | 'Assigned' | 'Pending' | 'Closed' | 'Rejected' | 'Duplicate'
priority'Low' | 'Normal' | 'High' | 'Urgent'
type'Question' | 'Incident' | 'Problem' nullable
descriptionstring nullable

A multi-line text.

accountIdstring nullable

An ID of the record of the Account type.

accountNamestring nullable

A foreign record name.

leadIdstring nullable

An ID of the record of the Lead type.

leadNamestring nullable

A foreign record name.

contactIdstring nullable

An ID of the record of the Contact type.

contactNamestring nullable

A foreign record name.

contactsIdsstring[] nullable

IDs of records of the Contact type.

contactsNamesobject nullable

An {ID => record name} map.

inboundEmailIdstring nullable

An ID of the record of the InboundEmail type.

inboundEmailNamestring nullable

A foreign record name.

originalEmailIdstring nullable
originalEmailNamestring nullable

A foreign record name.

isInternalboolean
createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

collaboratorsIdsstring[] nullable

IDs of records of the User type.

collaboratorsNamesobject nullable

An {ID => record name} map.

streamUpdatedAtstring nullable

A timestamp in UTC.

Example request

{
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56",
  "streamUpdatedAt": "2026-11-29 12:34:56"
}

Response

Success.

idstring

An ID.

namestring

A one-line string.

numberinteger

An auto-increment number.

status'New' | 'Assigned' | 'Pending' | 'Closed' | 'Rejected' | 'Duplicate'
priority'Low' | 'Normal' | 'High' | 'Urgent'
type'Question' | 'Incident' | 'Problem' nullable
descriptionstring nullable

A multi-line text.

accountIdstring nullable

An ID of the record of the Account type.

accountNamestring nullable

A foreign record name.

leadIdstring nullable

An ID of the record of the Lead type.

leadNamestring nullable

A foreign record name.

contactIdstring nullable

An ID of the record of the Contact type.

contactNamestring nullable

A foreign record name.

contactsIdsstring[] nullable

IDs of records of the Contact type.

contactsNamesobject nullable

An {ID => record name} map.

inboundEmailIdstring nullable

An ID of the record of the InboundEmail type.

inboundEmailNamestring nullable

A foreign record name.

originalEmailIdstring nullable
originalEmailNamestring nullable

A foreign record name.

isInternalboolean
createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

collaboratorsIdsstring[] nullable

IDs of records of the User type.

collaboratorsNamesobject nullable

An {ID => record name} map.

streamUpdatedAtstring nullable

A timestamp in UTC.

Example response

{
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56",
  "streamUpdatedAt": "2026-11-29 12:34:56"
}