Skip to content
ShiftSync Developers

Create a group

Creates a friend group.

POST
/v1/groups
curl --request POST \
  --url https://api.shiftsync.app/v1/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "string", "description": "string", "userIds": [ 0 ] }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
>= 1 characters <= 255 characters
description
string
<= 2000 characters
userIds
required
Array<integer>
Example
{
  "name": "string",
  "description": "string",
  "userIds": [
    0
  ]
}

Responses

Section titled “Responses”

201

Section titled “201”

The created group

Media typeapplication/json
object
item
required
object
id
required
integer
>= -9007199254740991 <= 9007199254740991
name
required
string
description
string
users
required
Array<object>
object
id
required
integer
>= -9007199254740991 <= 9007199254740991
emailAddress
required
string format: email
/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/
firstName
required
string
lastName
string
verified
required
boolean
isFacebookAuth
boolean
isGoogleAuth
boolean
isMicrosoftAuth
boolean
hasPassword
boolean
userPlan
required
string
Allowed values: free premium
firstDayOfWeek
required
string
timezone
required
string
nullable
avatarUrls
object
small
required
string format: uri
medium
required
string format: uri
large
required
string format: uri
markedForDeletion
required
boolean
deletionScheduledFor
string
Example
{
  "item": {
    "id": 0,
    "name": "string",
    "description": "string",
    "users": [
      {
        "id": 0,
        "emailAddress": "user@example.com",
        "firstName": "string",
        "lastName": "string",
        "verified": true,
        "isFacebookAuth": true,
        "isGoogleAuth": true,
        "isMicrosoftAuth": true,
        "hasPassword": true,
        "userPlan": "free",
        "firstDayOfWeek": "string",
        "timezone": "string",
        "avatarUrls": {
          "small": "https://example.com",
          "medium": "https://example.com",
          "large": "https://example.com"
        },
        "markedForDeletion": true,
        "deletionScheduledFor": "string"
      }
    ]
  }
}