ContactInvitationRead

A connection request sent to a contact before messaging is allowed (e.g. a LinkedIn connection invite or InMail), created as a step within an outreach dispatch run. The dispatch run waits for the invitation to be accepted before proceeding.

idIdrequired

Unique numeric identifier of the record.

dispatch_run_idDispatch Run Idrequired

ID of the dispatch run that created this invitation.

agent_idAgent Idrequired

ID of the agent (a configured AI assistant / bot persona) this record belongs to.

lead_idLead Idrequired

ID of the lead this record relates to.

contact_idContact Idrequired

ID of the contact this record relates to.

channel_id objectrequired

ID of the messaging channel this record relates to.

anyOf

• integer
• null

integer

ext_channel_idExt Channel Idrequired

External channel id used to send the invitation.

provider_idProvider Idrequired

The invitation's id at the provider.

step_indexStep Indexrequired

Index of the dispatch step that produced this invitation.

statusContactInvitationStatusrequired

Invitation status — queued, sending, sent, approved, denied, failed, or expired.

Possible values: [queued, sending, sent, approved, denied, failed, expired]

modeModerequired

Whether the request was a connection invite or an InMail.

note objectrequired

Optional note sent with the invitation.

anyOf

• string
• null

string

reason objectrequired

Status detail (e.g. failure reason).

anyOf

• string
• null

string

sent_at objectrequired

When the invitation was sent (UTC).

anyOf

• date-time
• null

date-time

accounted_at objectrequired

When the invitation was counted against limits (UTC).

anyOf

• date-time
• null

date-time

expires_at objectrequired

When the invitation expires (UTC).

anyOf

• date-time
• null

date-time

created_atdate-timerequired

Creation time (UTC, ISO 8601).

updated_atdate-timerequired

Last modification time (UTC, ISO 8601).

ContactInvitationRead

{
  "id": 0,
  "dispatch_run_id": 0,
  "agent_id": 0,
  "lead_id": 0,
  "contact_id": 0,
  "channel_id": 0,
  "ext_channel_id": "string",
  "provider_id": "string",
  "step_index": 0,
  "status": "queued",
  "mode": "string",
  "note": "string",
  "reason": "string",
  "sent_at": "2024-07-29T15:51:28.071Z",
  "accounted_at": "2024-07-29T15:51:28.071Z",
  "expires_at": "2024-07-29T15:51:28.071Z",
  "created_at": "2024-07-29T15:51:28.071Z",
  "updated_at": "2024-07-29T15:51:28.071Z"
}