Update the status of a message. For example, when the candidate clicks a link, or if the message failed to send.

Request

PATCH https://api.comeet.co/messages/{uid}/status

Request body fields:

Name

Type

Optional

Description

time_status_update

string

Required

YYYY-MM-DDTHH:mm:ssZ

status

string

Required

One of the following: Sent, Open, Failed, Clicked

recipient

object

Required

recipient.type

string

Required

One of the following: user, candidate, source_contact, other

recipient.uid

string

Required if email is not provided

uid of the user, candidate or source contact

recipient.email

string

Required if uid is not provided

{
  "time_status_update": "2018-01-01T12:50:50Z",
  "status": "Sent",
  "recipient": {
    "type": "candidate",
    "uid": "B99.999",
    "email": "[email protected]"
  }
}

Response

Returns the Message object.

{
  "uid": "B12.121",
  "time_sent": "2018-01-01T12:50:50Z",
  "status": "Sent",
  "from": {
    "type": "user",
    "uid": "A00.001"
  },
  "to": [
    {
      "type": "candidate",
      "uid": "B99.999"
    }
    //...
  ],
  "cc": [],
  "bcc": [],
  "subject": "Director of Sales opportunity",
  "body": "Hi John, I wanted to see if you would be interested in interviewing for the Director of sales role in ACME."
}
{  
  "status":404,
  "error":"message_not_found",
  "message":"Message not found"
}