Group Invites
Topics
Schema
The schema defines all the fields that exist for a group invite object.
idinteger | A unique numeric ID for the BP Invitation object. Read only Context: view, edit |
user_idinteger | The ID of the user who is invited to join the Group. Context: view, edit |
invite_sentboolean | Whether the invite has been sent to the invitee. Context: view, edit |
inviter_idinteger | The ID of the user who made the invite. Context: view, edit |
group_idinteger | The ID of the group to which the user has been invited. Context: view, edit |
date_modifiedstring or null | The date the object was created or last updated, in the site’s timezone. Read only Context: view, edit |
date_modified_gmtstring or null | The date the object was created or last updated, as GMT. Read only Context: view, edit |
typestring | Invitation or request. Context: view, editDefault: inviteOne of: invite, request |
messageobject | The raw and rendered versions for the content of the message.Context: view, edit |
List the Group Invites
Arguments
| Name | Type | Description |
|---|---|---|
| context | string | Scope under which the request is made; determines fields present in response. Default: viewOne of: view, edit |
| page | integer | Current page of the collection. Default: 1 |
| per_page | integer | Maximum number of items to be returned in result set. Default: 10 |
| group_id | integer | ID of the group to limit results to. Default: 0 |
| user_id | integer | Return only invitations extended to this user. Default: 0 |
| inviter_id | integer | Return only invitations extended by this user. Default: 0 |
| invite_sent | string | Limit result set to invites that have been sent, not sent, or include all. Default: sentOne of : draft, sent, all |
Definition
GET /buddypress/v1/groups/invites
Example of Use
bp.apiRequest function, you need to enqueue the bp-api-request JavaScript or use it as a dependency of your script. Refer to this page to know more about loading JavaScript files in WordPress.
bp.apiRequest( {
path: 'buddypress/v1/groups/invites',
type: 'GET',
data: {
context: 'view',
group_id: 3
}
} ).done( function( data ) {
return data;
} ).fail( function( error ) {
return error;
} );
Invite a user to join a Group
Arguments
| Name | Type | Description |
|---|---|---|
| user_id | integer | The ID of the user who is invited to join the Group. Required |
| inviter_id | integer | The ID of the user who made the invite. Default: the current logged in user ID. |
| group_id | integer | The ID of the group to which the user has been invited. Required |
| message | string | The optional message to send to the invited user. |
| send_invite | boolean | Whether the invite should be sent to the invitee. Default: true |
Definition
POST /buddypress/v1/groups/invites
Example of use
Alert: To use the bp.apiRequest function, you need to enqueue the bp-api-request JavaScript or use it as a dependency of your script. Refer to this page to know more about loading JavaScript files in WordPress.
bp.apiRequest( {
path: 'buddypress/v1/groups/invites',
type: 'POST',
data: {
context: 'edit',
user_id: 13,
group_id: 7,
message: 'Join the BuddyPress Contributors Group'
}
} ).done( function( data ) {
return data;
} ).fail( function( error ) {
return error;
} );
Retrieve a specific Group Invite
Arguments
| Name | Type | Description |
|---|---|---|
| invite_id | integer | A unique numeric ID for the group invitation. Required |
| context | string | Scope under which the request is made; determines fields present in response. Default: view One of : view, edit |
Definition
GET /buddypress/v1/groups/invites/<invite_id>
Example of use
Alert: To use the bp.apiRequest function, you need to enqueue the bp-api-request JavaScript or use it as a dependency of your script. Refer to this page to know more about loading JavaScript files in WordPress.
bp.apiRequest( {
path: 'buddypress/v1/groups/invites/5',
type: 'GET',
data: {
context: 'view'
}
} ).done( function( data ) {
return data;
} ).fail( function( error ) {
return error;
} );
Accept a specific Group Invite
Arguments
| Name | Type | Description |
|---|---|---|
| invite_id | integer | A unique numeric ID for the group invitation. Required |
Definition
PUT /buddypress/v1/groups/invites/<invite_id>
Example of use
Alert: To use the bp.apiRequest function, you need to enqueue the bp-api-request JavaScript or use it as a dependency of your script. Refer to this page to know more about loading JavaScript files in WordPress.
bp.apiRequest( {
path: 'buddypress/v1/groups/invites/5',
type: 'PUT',
data: {
context: 'edit'
}
} ).done( function( data ) {
return data;
} ).fail( function( error ) {
return error;
} );
Reject or remove a specific Group Invite
Note: If the invited user is the logged in user then the Group Invite will be rejected. Otherwise the uninvite action will be used.
Arguments
| Name | Type | Description |
|---|---|---|
| invite_id | integer | A unique numeric ID for the group invitation. Required |
Definition
DELETE /buddypress/v1/groups/invites/<invite_id>
Example of use
Alert: To use the bp.apiRequest function, you need to enqueue the bp-api-request JavaScript or use it as a dependency of your script. Refer to this page to know more about loading JavaScript files in WordPress.
bp.apiRequest( {
path: 'buddypress/v1/components',
type: 'GET',
data: {
context: 'view'
}
} ).done( function( data ) {
return data;
} ).fail( function( error ) {
return error;
} );