Invitation

Provides information about an invitation to a MyHeritage family site


Fields

The Invitation object contains the following fields:

Name Description Type Access Mode

id

The invitation's identifier

string

read

channel

The invitation's channel

  • email

  • sms

string

read, write

platform

The platform the invitation was sent from

  • web

  • iOS

  • android

string

read, write

contact_means

The means to contact the invitee.

string

read, write

site

The family site the invitation is for

Site object: id and name fields

read

inviter

The user who sent the invitation

User object: id and name fields

read

creation_time

Date and time when the invitation was sent

string (YYYY-MM-DD HH:MM:SS)

read

status

The invitation's status

  • pending

  • approved

  • reinvite

  • sent

  • failed

string

read, write

status_time

Date and time when the status was updated

string (YYYY-MM-DD HH:MM:SS)

read

invitee

The user the invitation was sent to

User object: id and name fields

read, write

invitee_individual

The individual associated with the invitee

Individual object: id and name fields

read, write

reinvite_count

How many times the invitation was re-sent

integer

read

visited

Whether the invitee had arrived to the site

boolean

read

source

The invitation's source

  • mobile_invitation_center

  • mobile_invitation_center_single_sms

  • mobile_invitation_center_single_cell

  • mobile_profile

  • incentivizer

  • contact_importer

  • contact_importer

  • data_entry

  • ftb

  • instant

  • greetings

  • edit tag

  • remind

  • health_report

string

read, write

class_name

The object class name

string

read