osapi.jive.corev3.places.Invite

An invitation to a place. For example, an invitation to join a private group.

Properties

PropertyTypeMode Description
bodyStringread-only

The (HTML) body content of this invitation.

emailStringread-only

The email address of the invitee, if not a Jive person. Otherwise, the invitee field will be populated.

idStringread-only

Identifier (unique within an object type and Jive instance) of this object. This field is internal to Jive and should not be confused with contentID or placeID used in URIs.

inviteePersonread-only

The person that was invited, if the invitee is a Jive person. If not, the email field should be populated.

inviterPersonread-only

The person that issued this invitation.

isFollowedBooleanread-only

Whether the current user is following this object.

Availability:

Will be present only for object types that support being followed.

placePlaceread-only

The place to which the invitee was invited.

publishedISO 8601 Dateread-only

The date and time at which this invite was created.

resourcesObjectread-only

Resource links (and related permissions for the requesting person) relevant to this object.

revokeDateISO 8601 Dateread-only

The date and time at which this invitation was revoked (if any).

revokerPersonread-only

The person that revoked this invitation (if any).

sentDateISO 8601 Dateread-only

The date and time at which this invitation was sent.

stateStringread-only

The current state of this invitation. Valid values are:

  • deleted - Marked for deletion but not yet removed by a background task.
  • fulfilled - Conditions for fulfillment of this invitation have been met, but further action on the part of the invitee is required.
  • processing - Initial state of an invitation after a user has been invited. State will automatically change to sent after it has been emailed.
  • revoked - This invitation has been revoked and may no longer be accepted.
  • sent - This invitation has been sent (via email), but not yet accepted.
  • - In the case of invitations to groups requiring approval from a group admin, invitations will be placed in this state until approval is granted.
typeStringread-only

The object type of this object ("invite")

typeCodeIntegerread-only
updatedISO 8601 Dateread-only

The date and time at which this invite was last updated.

→ Fields used by update and create operations
→ Fields used only by create operations
→ Fields not used by update or create operations

Methods

destroy()
DELETE /invites/1234

Retrieves

--

Description

Remove this invitation.

get(options)
GET /invites/1234

Retrieves

Invite

Description

Return an updated version of this invitation.

Options:
NameTypeRequiredDescription
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • Invite
  • toURI()

    Retrieves

    String

    Description

    Retrieves:
  • A URI representing this entity, or undefined if no such URI exists.
  • update(options)
    PUT /invites/1234

    Retrieves

    Invite

    Description

    Update the information for this invitation, and return an updated representation of it.

    Options:
    NameTypeRequiredDescription
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Invite