Support

Adds a case into the support system.

post/api/v1/support/cases

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/support/cases
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Query parameters

sendautoresponderstring nullable

Indicates whether an automatic message is sent that the ticket has been created.

Request body

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
SubmittedDateTimestring date-time
LastActivitystring date-time
AssignedToPersonClientIdentifierstring nullable
Subjectstring nullable
Bodystring nullable
UserAgentstring nullable
Status1 | 2 | 3 required

1 - Open, 2 - Closed, 3 - Spam

Source1 | 2 | 3 | 4 | 5 required

1 - Website, 2 - Email, 3 - Facebook, 4 - Twitter, 5 - Chat

HasUnreadboolean
IsOnlineboolean
Participantsstring nullable
RecaptchaTokenstring nullable
RecaptchaSiteKeystring nullable
Scorenumber float

Example request

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "SubmittedDateTime": "string",
  "LastActivity": "string",
  "FromPerson": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "SchemaLessData": {},
    "Email": "string",
    "FirstName": "string",
    "LastName": "string",
    "MailingAddress": {},
    "PasswordLastUpdated": "string",
    "PasswordMustChange": false,
    "PhoneMobile": "string",
    "PhoneWork": "string",
    "ProfileImageS3Url": "string",
    "Title": "string",
    "Timezone": "string",
    "Language": "string",
    "IPAddress": "string",
    "Referer": "string",
    "UserAgent": "string",
    "LastLoginDateTime": "string",
    "OAuthGoogleProfileId": "string",
    "PersonAccount": [],
    "DealPeople": [],
    "LeadFormSubmissions": [],
    "Account": {},
    "AccountUids": "string",
    "EmailListPerson": [],
    "FullName": "string",
    "HasLoggedIn": false,
    "OAuthIntegrationStatus": 0,
    "OptInToEmailList": false,
    "Password": "string",
    "RecaptchaToken": "string",
    "UserAgentPlatformBrowser": "string",
    "HasUnsubscribed": false,
    "DiscordUser": {},
    "IsConnectedToDiscord": false
  },
  "AssignedToPersonClientIdentifier": "string",
  "Subject": "string",
  "Body": "string",
  "UserAgent": "string",
  "Status": 1,
  "Source": 1,
  "CaseHistories": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "HistoryDateTime": "string",
      "Case": {},
      "AgentName": "string",
      "Comment": "string",
      "Type": 1,
      "SeenDateTime": "string",
      "ClickDateTime": "string",
      "UniqueIdentifier": "string",
      "PersonEmail": "string",
      "NewUvi": "string"
    }
  ],
  "CaseTags": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Tag": {}
    }
  ],
  "HasUnread": false,
  "IsOnline": false,
  "LastCaseHistory": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "HistoryDateTime": "string",
    "Case": {},
    "AgentName": "string",
    "Comment": "string",
    "Type": 1,
    "SeenDateTime": "string",
    "ClickDateTime": "string",
    "UniqueIdentifier": "string",
    "PersonEmail": "string",
    "NewUvi": "string"
  },
  "Participants": "string",
  "RecaptchaToken": "string",
  "RecaptchaSiteKey": "string",
  "Score": 0
}

Response

Uidstring nullable
_objectTypestring nullable
Createdstring date-time required
Updatedstring date-time required
ActivityEventDataunknown
SubmittedDateTimestring date-time
LastActivitystring date-time
AssignedToPersonClientIdentifierstring nullable
Subjectstring nullable
Bodystring nullable
UserAgentstring nullable
Status1 | 2 | 3 required

1 - Open, 2 - Closed, 3 - Spam

Source1 | 2 | 3 | 4 | 5 required

1 - Website, 2 - Email, 3 - Facebook, 4 - Twitter, 5 - Chat

HasUnreadboolean
IsOnlineboolean
Participantsstring nullable
RecaptchaTokenstring nullable
RecaptchaSiteKeystring nullable
Scorenumber float

Example response

{
  "Uid": "string",
  "_objectType": "string",
  "Created": "string",
  "Updated": "string",
  "ActivityEventData": {},
  "SubmittedDateTime": "string",
  "LastActivity": "string",
  "FromPerson": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "SchemaLessData": {},
    "Email": "string",
    "FirstName": "string",
    "LastName": "string",
    "MailingAddress": {},
    "PasswordLastUpdated": "string",
    "PasswordMustChange": false,
    "PhoneMobile": "string",
    "PhoneWork": "string",
    "ProfileImageS3Url": "string",
    "Title": "string",
    "Timezone": "string",
    "Language": "string",
    "IPAddress": "string",
    "Referer": "string",
    "UserAgent": "string",
    "LastLoginDateTime": "string",
    "OAuthGoogleProfileId": "string",
    "PersonAccount": [],
    "DealPeople": [],
    "LeadFormSubmissions": [],
    "Account": {},
    "AccountUids": "string",
    "EmailListPerson": [],
    "FullName": "string",
    "HasLoggedIn": false,
    "OAuthIntegrationStatus": 0,
    "OptInToEmailList": false,
    "Password": "string",
    "RecaptchaToken": "string",
    "UserAgentPlatformBrowser": "string",
    "HasUnsubscribed": false,
    "DiscordUser": {},
    "IsConnectedToDiscord": false
  },
  "AssignedToPersonClientIdentifier": "string",
  "Subject": "string",
  "Body": "string",
  "UserAgent": "string",
  "Status": 1,
  "Source": 1,
  "CaseHistories": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "HistoryDateTime": "string",
      "Case": {},
      "AgentName": "string",
      "Comment": "string",
      "Type": 1,
      "SeenDateTime": "string",
      "ClickDateTime": "string",
      "UniqueIdentifier": "string",
      "PersonEmail": "string",
      "NewUvi": "string"
    }
  ],
  "CaseTags": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Tag": {}
    }
  ],
  "HasUnread": false,
  "IsOnline": false,
  "LastCaseHistory": {
    "Uid": "string",
    "_objectType": "string",
    "Created": "string",
    "Updated": "string",
    "ActivityEventData": {},
    "HistoryDateTime": "string",
    "Case": {},
    "AgentName": "string",
    "Comment": "string",
    "Type": 1,
    "SeenDateTime": "string",
    "ClickDateTime": "string",
    "UniqueIdentifier": "string",
    "PersonEmail": "string",
    "NewUvi": "string"
  },
  "Participants": "string",
  "RecaptchaToken": "string",
  "RecaptchaSiteKey": "string",
  "Score": 0
}

Changes

No recorded changes to this operation across all 1 revision of this API.