Invitation Schema

Invitation Schema

Field Name Sub-Field Name Format Description
created   Long A timestamp corresponding to the creation of this invitation. Represented as milliseconds since epoch.
deleted   optional Long  A timestamp corresponding to the deletion of this invitation. Represented as milliseconds since epoch.
id   optional URN Unique identifier of the invitation.
invitee   URN Identifier of the invitee. Can be one following format:
  • Person - urn:li:person:{personID}
  • Email - urn:li:emailAddress:{emailID}
  • Phone - urn:li:phoneAccount:{phoneAccountID}
inviter   Person URN The identifier of the LinkedIn member as the inviter.
lastModified   Long A timestamp corresponding to the last modification of this invitation. Represented as milliseconds since epoch.
message   optional String The message content. Can be a template or customized message.
  string String The message template ID. Can be the following values:
  • "invite_member_28" - Default member template
  • "invite_guest" - Default guest template
  • "sms_invite_guest" - Default SMS template
  • "accept_invite_04" - Default invitation accept template
  com.linkedin. invitations. InvitationMessage. body String The body of a custom message created by the inviter.
sentAt   optional Long Timestamp of the last time this invitation was sent. Represented as milliseconds since epoch.
source   optional String The source type of this invitation. Can be the following values:
  • ABI - The invitation is contributed by Address-Book-Import workflow.
  • PYMK - The invitation is contributed by People-You-May-Know workflow.
  • PROFILE - The invitation comes from direct profile view.
  • OTHER - The invitation comes from all other sources except the specified ones.
state   String The source type of this invitation. Can be the following values:
  • UNSENT - The invitation has been created but has not been submitted to the senders for processing.
  • ABORTED - The invitation was aborted prior to being sent.
  • PENDING - The invitation has been sent and is awaiting action by the invitee or inviter.
  • BOUNCED - The invitation failed to be sent due to a problem with the delivery mechanism.
  • ACCEPTED - The invitation has been accepted by the invitee.
  • IGNORED - The invitation has been ignored by the invitee.
  • REJECTED - The invitation has been rejected by the invitee.
  • WITHDRAWN - The invitation has been withdrawn by the inviter after it is sent out.
  • EXPIRED - The invitation has been expired.
  • BLOCKED - The invitation was sent to an invitee without providing sufficient invitee information.
useCase   optional String Use case of this invitation such as whethether client is going to send the invitation out. Can be the following values:
  • CLIENT_TO_SEND - The client will send this invitation. The service should store this invitation and not send it out, e.g.native SMS.
validationToken   optional String A randomly generated value used for the invitee performing action on his or her own pending invitations. This field will only be returned if the requester is the invitee of the invitation object.