Contributors:
CRM Cases API
Create, Retrieve, Update and Delete CRM Cases via the public API endpoint using "where" filtering.
GET CRM Cases List
Retrieves a list of Cases as a JSON response based on your provided query parameters.
/api/v2/admin/cases
Data / Response:
{
"Where" : {},
"Order_By" : "Id",
"Offset" : 0,
"Limit" : 100,
}
{
"Items": [
{
"Id": 0,
"OrderId": 0,
"FormId": 0,
"MemberId": 0,
"CreatedDateTime": "2024-05-17T17:45:27.212Z",
"CustomCrmGroups": {
"<GroupAlias1>": {
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
},
"Member": {
"Id": 0,
"Email": "string",
"FirstName": "string",
"LastName": "string"
},
"Form": {
"Id": 0,
"Alias": "string",
"Name": "string"
},
"CaseFields": {
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
}
],
"TotalItemsCount": 0
}
POST CRM Case Create
Creates a new Case based on the provided data.
/api/v2/admin/cases
Data / Response:
FormSubmissionData with FormId as required field
{
"Id": 0,
"OrderId": 0,
"FormId": 0,
"MemberId": 0,
"CreatedDateTime": "2024-05-17T18:14:56.124Z",
"CustomCrmGroups": {
"<GroupAlias1>": {
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
},
"Member": {
"Id": 0,
"Email": "string",
"FirstName": "string",
"LastName": "string"
},
"Form": {
"Id": 0,
"Alias": "string",
"Name": "string"
},
"CaseFields": {
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
}
GET CRM Case Item
Retrieves a single Case based on the ID passed in the endpoint URL.
/api/v2/admin/cases/{id}
Data / Response:
N/A
{
"Id": 0,
"OrderId": 0,
"FormId": 0,
"MemberId": 0,
"CreatedDateTime": "2024-05-17T18:14:56.124Z",
"CustomCrmGroups": {
"<GroupAlias1>": {
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
},
"Member": {
"Id": 0,
"Email": "string",
"FirstName": "string",
"LastName": "string"
},
"Form": {
"Id": 0,
"Alias": "string",
"Name": "string"
},
"CaseFields": {
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
}
PUT CRM Case Update
Updates a single Case based on the ID passed in the endpoint URL and data provided.
/api/v2/admin/cases/{id}
Data / Response:
FormSubmissionData
{
"Id": 0,
"OrderId": 0,
"FormId": 0,
"MemberId": 0,
"CreatedDateTime": "2024-05-17T18:14:56.124Z",
"CustomCrmGroups": {
"<GroupAlias1>": {
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
},
"Member": {
"Id": 0,
"Email": "string",
"FirstName": "string",
"LastName": "string"
},
"Form": {
"Id": 0,
"Alias": "string",
"Name": "string"
},
"CaseFields": {
"<FieldAlias1>": "<value>",
"<FieldAlias2>": false,
"<FieldAlias3>": 0
}
}
DELETE CRM Case Delete
Deletes a single Case based on the ID passed in the endpoint URL.
/api/v2/admin/cases/{id}
Data / Response:
N/A
Status 204