Stop a period

POST 
/:customer_id/groups/:group_id/users/:uid/periods/stop

Stop a period for a user in a group

Request

Path Parameters

customer_id Customer Idrequired

Id of the tenant

group_id Group Idrequired

Id of the group

uid uuidrequired

Id of the user

application/json

Body

required

period_name Period Namenullable

Default value: all

Name of the period to stop or all to stop all periods

user_utc_offset User Utc Offsetnullablerequired

Optional UTC offset of the user in minutes. Used if the user has never logged in before (and hence timezone not set)

disable_group_actions Disable Group Actions

Default value: true

Whether to enable group actions for this user after stopping the period

Responses

200

Successful response

application/json

Schema

Schema

message Message

Default value: OK

Example (from schema)

{
  "message": "OK"
}

400

Validation error

application/json

Schema

Schema

message Messagerequired
errors undefined[]nullablerequired

Example (from schema)

{
  "message": "string",
  "errors": [
    null
  ]
}

Loading...