Invite

Invite Service

Service for manipulating invitations to places, sent by a Jive user, and received by a Jive user or an email address.

Create Invites

POST /invites/places/{placeID}

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"
         ]
     }
Path Parameters:
NameTypeRequiredDescription
placeIDStringtrueID of the place where a person is being invited to
Query Parameters:
NameTypeRequiredDescription
fieldsStringfalseFields to include in the returned Invite
Takes:
  • JSON object describing the invitation(s) to be created. Limit the number of invitees per call to 200.
    • Retrieves:
  • Invite[] describing the invites that were created by this call
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)The user is already a member of the group
    403 (Forbidden)You are not allowed to perform this operation
    404 (Not Found)The specified place cannot be found

    Destroy Invite

    DELETE /invites/{inviteID}

    Delete the specified invitation.

    Path Parameters:
    NameTypeRequiredDescription
    inviteIDStringtrueID of the invitation to be deleted
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field is missing or malformed
    403 (Forbidden)You are not allowed to perform this operation
    404 (Not Found)The specified invitation cannot be found

    Get Invite

    GET /invites/{inviteID}

    Return the specified invitation.

    Path Parameters:
    NameTypeRequiredDescription
    inviteIDStringtrueID of the invitation to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in the returned Invite
    Retrieves:
  • Invite
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    403 (Forbidden)You are not allowed to perform this operation
    404 (Not Found)The specified invitation cannot be found

    Get Invites

    GET /invites/places/{placeID}

    Return the invites of the specified place that match the specified criteria.

    Path Parameters:
    NameTypeRequiredDescription
    placeIDStringtrueID of the place for the selected invitations
    Query Parameters:
    NameTypeRequiredDescription
    inviterStringfalseURI of the person that sent the invite (default is null so all inviters are returned)
    inviteeStringfalseURI of the person that was invited (default is null so all invitees are returned)
    startIndexIntegerfalseZero-relative offset of the first invite to be returned (default is 0)
    countIntegerfalseMaximum number of invites to be returned (default is 25)
    fieldsStringfalseFields to include in the returned Invite
    Retrieves:
  • Invite[] listing the matched invites
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    403 (Forbidden)You are not allowed to perform this operation
    404 (Not Found)The specified place cannot be found

    Update Invite

    PUT /invites/{inviteID}

    Update the state of the specified invitation.

    Only the following state transitions are allowed, and only for the specified people:

    From State To State Authorized For Notes
    processing, sent, or fulfilled accepted Invitee Causes the invitation to be accepted and group membership established. If the group is configured to require administrator approval, and this invite was not sent by a Jive admin or group admin, the membership will still be pending approval by a Jive or group administrator.
    processing, sent, or fulfilled resent Jive Admin, group admin, or the user who sent the invitation Causes the invitation to be resent to the corresponding invitee.
    any revoked Jive Admin, group admin, or the user who sent the invitation Causes the invitation to be revoked.
    Path Parameters:
    NameTypeRequiredDescription
    inviteIDStringtrueID of the invitation to be updated
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in the returned Invite
    Takes:
  • Updated invite entity (only state is used)
    • Retrieves:
  • Invite
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed or is invalid
    403 (Forbidden)You are not allowed to perform this operation
    404 (Not Found)The specified invite cannot be found