Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
EventInvite
EventInvite Service
Service for manipulating invitations to events.
Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
Create Invites
POST /invites/event/{eventID}Creates and sends invites to one or many persons for the specified event. The invitees can be defined by passing their username or person URI. An example of the required JSON input is:
{
"body" : "Please come join my awesome event.",
"invitees" : [
"exampleUser",
"https://example.jiveon.com/api/core/v3/people/1234"
]
}
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| eventID | String | true | ID of the event where a person is being invited to |
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | Fields to include in the returned EventInvite |
Takes:
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 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 |
Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
Destroy Invite
DELETE /invites/event/{inviteID}Delete the specified invitation.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| inviteID | String | true | ID of the invitation to be deleted |
Return Status:
| HTTP Status Code | Description |
|---|---|
| 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 |
Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
Get Invite
GET /invites/event/{inviteID}Return the specified invitation.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| inviteID | String | true | ID of the invitation to be returned |
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | Fields to include in the returned EventInvite |
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 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 |
Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
Get Invites
GET /invites/event/all/{eventID}Requires ModuleWhat's this?
This capability is implemented by a Jive Module.
This feature may not be available on all Jive instances.
This feature may not be available on all Jive instances.
Update Invite
PUT /invites/event/{inviteID}Update the state of the specified invitation.
Path Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| inviteID | String | true | ID of the invitation to be updated |
Query Parameters:
| Name | Type | Required | Description |
|---|---|---|---|
| fields | String | false | Fields to include in the returned EventInvite |
Takes:
Retrieves:
Return Status:
| HTTP Status Code | Description |
|---|---|
| 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 |