static osapi.jive.corev3.invites

Static class for getting and creating Invites. An Invite is an invitation to a group.

Methods

↑
create(invite,options)
POST /invites/places/{placeURI}

Retrieves

Invite[]

Description

Creates and sends invites to one or many persons for the specified place. The invitees can be defined by passing their email address, username or person URI. An example of the required JSON input is:

     {
         "body" : "Please come join my awesome group.",
         "invitees" : [
             "fred@example.com",
             "https://example.jiveon.com/api/core/v3/people/1234"
         ]
     }
Takes:
  • JSON object with body and invitees fields
Options:
NameTypeRequiredDescription
placeURIStringtrueURI of the place where people are being invited to
fieldsStringfalseNames of the fields to be returned
Retrieves:
  • Invite[] List of invites created by this request
    • ↑
    get(options)
    GET /invites/{uri}

    Retrieves

    Invite

    Description

    Return the specified invite by its URI.

    Options:
    NameTypeRequiredDescription
    uriStringtrueURI of the invite to be returned
    fieldsStringfalseNames of the fields to be returned
    Retrieves:
  • Invite Representation of the requested invite