Skip to main content

Start a period

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

Start 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

Body

required
    period_name Period Namerequired

    Name of the period

    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)

    enable_group_actions Enable Group Actions

    Default value: true

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

    tags string[]nullable

    Default value: ``

    Optional list of tags to attach to the period

    duration_seconds Duration Secondsnullable

    Optional duration of the period in seconds

    start_at_first_event Start At First Event

    Default value: false

    If set, the period will start time will be replaced by the first event in the period

Responses​

Successful response

Schema
    message Message

    Default value: OK

Loading...