v1

latestOpenAPI 3.0.02026-08-04265791.1 MB

Groups

Create

You may create a new single group or multiple groups using this action. When creating a single group the body contains a json object, when creating multiple groups the body contains an array of objects.
Warning: a maximum of 1000 items can be sent in a single request.

Important: The group_id is generated automatically when a new group is created. The group_id corresponds to the group's title in lowercase letters, with _ instead of spaces, and without special caracters

post/public/api/groups

Headers

Acceptstring

e.g. application/json

Request body

user_idsstring[]

titlestring

descriptionstring

icon_urlstring

Example request

{
  "user_ids": [
    "53fb03c6546847ee0d33386b",
    "53fb03c6546847ee0d30086a"
  ],
  "title": "My Company Title",
  "description": "My Company Description",
  "icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1581436892/klsrdxjtz44dtnlsquzc.png"
}

Response

group_idstring required

user_idsstring[] required

updated_datestring required

created_datestring required

titlestring required

descriptionstring

icon_urlstring

group_idsstring[]

Example response

[
  {
    "group_id": "mycompany_sub-test",
    "user_ids": [
      "53fb03c6546847ee0d33386b",
      "53fb03c6546847ee0d30086a"
    ],
    "updated_date": "2018-10-08T10:15:22.100Z",
    "created_date": "2018-05-22T11:45:22.100Z",
    "title": "sub-test",
    "description": "My Company Description",
    "icon_url": "https://res.cloudinary.com/www-yoobic-com/image/upload/a_exif/v1581436892/klsrdxjtz44dtnlsquzc.png"
  },
  {
    "group_id": "mycompany_my_company_title",
    "user_ids": [
      "53fb03c6546847ee0d33386b",
      "53fb03c6546847ee0d30086a"
    ],
    "group_ids": [
      "mycompany_sub-test"
    ],
    "title": "My Company Title",
    "updated_date": "2018-10-08T10:15:22.100Z",
    "created_date": "2018-05-22T11:45:22.100Z"
  }
]