CHcheckhq

Create a communication

Changed on
post/communications

Request

Request body

companystring required

ID of the company that the communication is in reference to

typestring

The type of communication.

messageobject

Response

200

idstring
companystring
typestring
originatorstring
messageunknown
created_atstring

Example response

{
  "id": "cmn_MrFrw0F82NSJjyw10Erk",
  "company": "com_zH8Gq33iBkFj5o0GKjTw",
  "type": "email",
  "originator": "check",
  "email": {
    "to": [
      "arifaulakh@gmail.com"
    ],
    "from": "support@checkhq.zendesk.com",
    "cc": [
      "payroll-support@novo.co"
    ],
    "subject": "Check <> Arif's Sneakers",
    "message": "You're ready to run your first payroll"
  },
  "created_at": "2024-01-19 17:04:15+00",
  "conversation_history": [
    {
      "originator": "company",
      "message": "I need help with payroll!",
      "sent_at": "2024-01-19 17:04:15+00"
    }
  ]
}

Changes