post
https://{your-domain}.com/case
Create a new case with interactions
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Details
Responses and Response Schema
201 (Success)
Top-level Object
[block:parameters] { "data": { "h-0": "Field Name", "h-1": "Type", "h-2": "Description", "0-0": "id*", "1-0": "number*", "2-0": "customerId*", "3-0": "title*", "4-0": "description*", "5-0": "url*", "6-0": "lastUpdated*", "7-0": "created*", "8-0": "status*", "9-0": "interactions", "9-1": "array[object]", "0-1": "string", "1-1": "string", "2-1": "string", "3-1": "string", "4-1": "string", "5-1": "string", "6-1": "string", "7-1": "string", "8-1": "string", "1-2": "The case number to display to Khoros Marketing Agents", "2-2": "The ID of the customer associated with this new case.", "3-2": "The title of the case.", "4-2": "The longer form description of the case.", "5-2": "The URI the agent can click on to see the case.", "6-2": "ISO8601 DateTime of when the case was last updated.", "7-2": "ISO8601 DateTime of when the case was created.", "8-2": "**Allowed Values** `open`, `closed`", "10-0": "customCasePropertyOne", "10-1": "string", "10-2": "An example of a custom field on the Case object. These will only be present if specified via the **/meta/object/case endpoint**.", "11-0": "customCasePropertyTwo", "11-1": "string", "11-2": "An example of a custom field on the Case object. These will only be present if specified via the **/meta/object/case endpoint**." }, "cols": 3, "rows": 12 } [/block]
Interactions Object
[block:parameters] { "data": { "h-0": "Field Name", "h-1": "Type", "h-2": "Description", "0-0": "created*", "0-1": "string", "0-2": "The creation date of the interaction on the origin service.", "1-0": "body*", "1-1": "string", "1-2": "The text of the interaction.", "2-0": "linkUrl*", "2-1": "string", "2-2": "The direct link to the context on the origin service when available.", "3-0": "serviceId*", "3-1": "string", "3-2": "The social service the interaction originated.", "4-0": "service*", "4-1": "string", "4-2": "The social service the interaction originated.", "5-0": "contentType*", "5-1": "string", "5-2": "The type of content the interaction is on the origin service. Examples include: `post`, `comment`, etc." }, "cols": 3, "rows": 6 } [/block]
Author Object
[block:parameters] { "data": { "h-0": "Field Name", "h-1": "Type", "h-2": "Descritpion", "0-0": "service*", "0-1": "string", "0-2": "The social service of the author.", "1-0": "serviceId*", "1-1": "string", "2-0": "handle*", "2-1": "string", "2-2": "The handle of the author on the origin service.", "3-0": "name*", "3-1": "string", "4-0": "brandOwned*", "4-1": "boolean", "4-2": "A flag that signals if the author belongs to an account added to the platform.", "1-2": "The id of the author on the origin service.", "3-2": "The screen name of the author on the origin service." }, "cols": 3, "rows": 5 } [/block]
400 (Generic Error)
[block:parameters] { "data": { "h-0": "Field Name", "h-1": "Type", "h-2": "Description", "0-0": "fields", "0-1": "array[object]", "0-2": "", "2-0": "message", "2-1": "string", "2-2": "Message passable to the user.", "1-0": "error", "1-1": "string", "1-2": "Name of the error code." }, "cols": 3, "rows": 3 } [/block]
fields object
[block:parameters] { "data": { "h-0": "Field Name", "h-1": "Type", "h-2": "Description", "0-0": "name*", "0-1": "string", "1-0": "errorMessage*", "1-1": "string" }, "cols": 2, "rows": 2 } [/block]
401 (Authentication Failure)
API key is invalid or has become de-authenticated
422
[block:parameters] { "data": { "h-0": "Field Name", "h-1": "Type", "h-2": "Description", "0-0": "error*", "0-1": "string", "0-2": "Name of the error or code.", "1-0": "message*", "1-1": "string", "1-2": "Message passable to the user." }, "cols": 3, "rows": 2 } [/block]
fields object
[block:parameters] { "data": { "h-0": "Field Name", "h-1": "Type", "h-2": "Description", "0-0": "name*", "0-1": "string", "1-0": "errorMessage*", "1-1": "string" }, "cols": 2, "rows": 2 } [/block]
500 (Unexpected Error)
Unexpected Error [block:parameters] { "data": { "h-0": "Field Name", "h-1": "Type", "h-2": "Description", "0-0": "error", "0-1": "string", "0-2": "Name of the error or code.", "1-0": "message", "1-1": "string", "1-2": "Message passable to the user." }, "cols": 3, "rows": 2 } [/block]