Table of Contents
Fields
Field | Name | Description | Type | Required |
---|---|---|---|---|
section_id | Section ID | For course invites, the ID of the course section related to the invite | integer | |
section_name | Section Name | For course invites, the display name of the course section related to the invite | string | |
group_id | Group ID | For group invites, the ID of the group related to the invite | string | |
group_name | Group Name | For group invites, the display name of the group related to the invite | string | |
picture_url | Picture URL | The full URL of the profile picture of the related group or course section | string | |
school_name | School Name | The name of the school that owns the realm related to the invite | string | |
school_id | School ID | The ID of the school that owns the realm related to the invite | string | |
created | Date Created | The unix timestamp when the request was created | string | yes |
Operations
list
View a list of pending invites. You can specify the key ‘created_offset’ in the query string to view only invites that were created after the specified time. The expected format of the ‘created_offset’ key value is anything that PHP’s strtotime function can interperet. For example:
/users/[user_id]/invites/group?created_offset=2010-05-14+23:44:32
Path | |
Content | none |
Return | A collection of invite objects, each one containing invite fields JSON XML
|
update
Update a pending invite. The invite action field value must be a string( accept | deny ). NOTE: Currently there is an issue with this API call that requires an additional tag for correct request body structure. See the example below for details.
<?xml version="1.0" encoding="utf-8" ?>
<request>
<invite>
<invite_action>deny</invite_action>
</invite>
</request>
Path | |
Content | An object containing a invite_action field JSON XML
|
Return | none |