Candidate Events

Create a new candidate event

Returns the newly created event object. NOTE: only manual_touchpoints type event can be created currently. NOTE: an inmail event for a candidate with a pending InMail stage in a sequence marks that stage as sent, and the response is the sequences event for that send.

post/v0/candidates/{candidate_id}/events

Request

  • Base URL
    https://api.gem.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.gem.com/v0/candidates/{candidate_id}/events
  • Auth
    none declared

Request body

candidate_idstring ObjectID
timestampinteger required
user_idstring ObjectID required
on_behalf_of_user_idstring ObjectID nullable
project_idstring ObjectID required
sequence_idstring ObjectID required
type'sequences' | 'sequence_replies' | 'manual_touchpoints' required
subtype'first_outreach' | 'follow_up' | 'reply' required
contact_medium'inmail' | 'phone_call' | 'text_message' | 'email' | 'meeting' | 'li_connect_request' required
reply_statusunknown

Response

Created

idstring ObjectID
candidate_idstring ObjectID
timestampinteger required
user_idstring ObjectID required
on_behalf_of_user_idstring ObjectID nullable
project_idstring ObjectID required
sequence_idstring ObjectID required
type'sequences' | 'sequence_replies' | 'manual_touchpoints' required
subtype'first_outreach' | 'follow_up' | 'reply' required
contact_medium'inmail' | 'phone_call' | 'text_message' | 'email' | 'meeting' | 'li_connect_request' required
reply_statusunknown

Changes

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