FIfiles
share_groups
Share Groups

Create Share Group

Changed on

Create Share Group

post/share_groups

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/share_groups
  • Auth
    none declared

Request body multipart/form-data

user_idinteger

User ID. Provide a value of 0 to operate the current session's user.

notesstring

Additional notes of the share group

namestring required

Name of the share group

membersobject[] required

A list of share group members.

Example request

{
  "notes": "This group is defined for testing purposes",
  "name": "Test group 1",
  "members": [
    {
      "name": "John Doe",
      "company": "Acme Ltd",
      "email": "johndoe@gmail.com"
    }
  ]
}

Response

The ShareGroups object.

idinteger

Share Group ID

namestring

Name of the share group

notesstring

Additional notes of the share group

user_idinteger

Owner User ID

Example response

{
  "id": 1,
  "name": "Test group 1",
  "notes": "This group is defined for testing purposes",
  "user_id": 1,
  "members": [
    {
      "name": "John Doe",
      "company": "Acme Ltd",
      "email": "johndoe@gmail.com"
    }
  ]
}

Changes