# Create a Schedule

Creates a schedule for appointments or events based on the original associated entity.

Endpoint: POST /company/{location_id}/schedules
Version: 1.0.0
Security: BearerPartnerUser

## Header parameters:

  - `Accept` (string, required)
    Should be equal to application/vnd.api.v2+json
    Example: "application/vnd.api.v2+json"

  - `Content-Type` (string, required)
    Should be equal to application/json
    Example: "application/json"

## Path parameters:

  - `location_id` (number, required)
    ID of a location.
    Example: 123

## Query parameters:

  - `include` (array)
    Requested set of an included models.
    Enum: "days"

## Request fields (application/json):

  - `original_entity_type` (string, required)
    Type of entity the schedule will be based on:  
record - individual appointment, currently not supported;  
activity - group event.
    Enum: "record", "activity"

  - `original_entity_id` (number, required)
    ID of entity the schedule will be based on.
    Example: 123

  - `date_end` (string, required)
    Date of the schedule end.
    Example: "2022-02-01"

  - `add_clients_from_original_entity` (boolean, required)
    Add clients from original entity to all scheduled events.

  - `days` (array, required)
    Each object represents schedule series settings for a specific day of the week. A minimum of 1 and a maximum of 7 schedule series can be defined (one for each day of the week).

  - `days.day_of_week` (string, required)
    The day of the week for the schedule series.
    Enum: "mon", "tue", "wed", "thu", "fri", "sat", "sun"

  - `days.events_master_id` (number, required)
    The ID of the team member assigned to the events in the schedule series.
    Example: 123

  - `days.events_time` (string, required)
    Start time of the events in the schedule series, formatted as HH:MM:SS.
    Example: "14:00:00"

  - `days.events_duration` (number, required)
    Duration of each event in the schedule series, in seconds.
    Example: 3600

  - `days.events_capacity` (number, required)
    The capacity of activities in the schedule series. For appointments, this should be set to 1.
    Example: 4

  - `days.labels_ids` (array)
    An array of tag IDs associated with the events in the schedule series.
    Example: [123]

  - `days.resource_instances_ids` (array)
    An array of resource instance IDs used in the events of the schedule series.
    Example: [123]

## Response 201 fields (application/json):

  - `success` (boolean)
    Response status.

  - `data` (object)
    Data for an existing schedule in a location.

  - `data.id` (number)
    ID of a schedule.

  - `data.created_at` (string)
    Datetime of a schedule created.

  - `data.updated_at` (string)
    Datetime of a schedule last updated.

  - `data.deleted_at` (string,null)
    Datetime of a schedule deleted.

  - `data.original_entity_type` (string)
    Type of entity schedule is based on (appointment or event).
    Enum: "record", "activity"

  - `data.original_entity_id` (number)
    ID of entity schedule is based on.

  - `data.date_start` (string)
    Date of a schedule start.

  - `data.date_end` (string)
    Date of a schedule end.

  - `data.days` (array)
    Schedule series, linked to a specified schedule.  
Returned in response only if corresponding include is present in request.
    Example: [{"id":123,"created_at":"2026-01-01T12:12:12-05:00","updated_at":"2026-01-01T12:12:12-05:00","deleted_at":null,"timetable_event_schedule_id":123,"day_of_week":"mon","events_time":"14:00:00","events_duration":3600,"event_technical_break_duration":0,"events_master":{"id":123,"name":"John Johnson","company_id":123,"specialization":"Team Member","avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","position":{"id":123,"title":"Team Member"}},"events_labels":[{"id":123,"title":"Tag","color":"#ff0000"}],"events_resource_instances":[{"id":123,"title":"Resource #1","resource_id":123}],"events":[{"id":123,"created_at":"2026-01-01T12:12:12-05:00","updated_at":"2026-01-01T12:12:12-05:00","deleted_at":null,"event_status":"stable","event_datetime":"2026-01-24T14:00:00-05:00","event_entity_type":"activity","event_entity_id":123,"is_entity_master_changed":false,"is_entity_datetime_changed":false,"is_entity_duration_changed":false,"is_entity_labels_changed":false,"is_entity_resource_instances_changed":false}]}]

  - `data.days.id` (number)
    ID of a schedule series.
    Example: 123

  - `data.days.created_at` (string)
    Datetime of a schedule series created.
    Example: "2026-01-01T12:12:12-05:00"

  - `data.days.updated_at` (string)
    Datetime of a schedule series last updated.
    Example: "2026-01-01T12:12:12-05:00"

  - `data.days.deleted_at` (string,null)
    Datetime of a schedule series deleted.

  - `data.days.timetable_event_schedule_id` (number)
    ID of a schedule, which series is linked to.
    Example: 123

  - `data.days.day_of_week` (string)
    Day of week of a schedule series.
    Enum: "mon", "tue", "wed", "thu", "fri", "sat", "sun"

  - `data.days.events_time` (string)
    Time of beginning of the events in a schedule series.
    Example: "14:00:00"

  - `data.days.events_duration` (number)
    Duration of the events in a schedule series.
Note: Does not include technical break duration.
    Example: 3600

  - `data.days.event_technical_break_duration` (number)
    Technical break duration in seconds.

  - `data.days.events_master` (object)
    Team member for the events in a schedule series.  
Returned in response only if corresponding include is present in request.
    Example: {"id":123,"name":"John Johnson","company_id":123,"specialization":"Master","avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","position":{"id":123,"title":"Position"},"is_paid_staff":false}

  - `data.days.events_master.id` (number)
    ID of a team member.
    Example: 123

  - `data.days.events_master.name` (string)
    Name of a team member.
    Example: "John Johnson"

  - `data.days.events_master.company_id` (number)
    ID of a location, where team member was created.
    Example: 123

  - `data.days.events_master.specialization` (string)
    Specialization of a team member.
    Example: "Master"

  - `data.days.events_master.avatar` (string)
    Link to the avatar of a team member (small).
    Example: "https://app.alteg.io/images/no-master-sm.png"

  - `data.days.events_master.avatar_big` (string)
    Link to the avatar of a team member (original).
    Example: "https://app.alteg.io/images/no-master.png"

  - `data.days.events_master.position` (object,null)
    Position of a team member.
    Example: {"id":123,"title":"Position"}

  - `data.days.events_master.is_paid_staff` (boolean)
    Whether the team member is a paid staff member counted in license price.

  - `data.days.events_labels` (array)
    Tags for the events in a schedule series.
Returned in response only if corresponding include is present in request.
    Example: [{"id":123,"title":"Tag","color":"#ff0000"}]

  - `data.days.events_labels.id` (number)
    ID of tag.
    Example: 123

  - `data.days.events_labels.title` (string)
    Title of a tag.
    Example: "Tag"

  - `data.days.events_labels.color` (string)
    Color of a tag (#rrggbb).
    Example: "#ff0000"

  - `data.days.events_resource_instances` (array)
    Resource instances for the events in a schedule series.  
Returned in response only if corresponding include is present in request.
    Example: [{"id":123,"title":"Resource #1","resource_id":123}]

  - `data.days.events_resource_instances.id` (number)
    ID of a resource instance.
    Example: 123

  - `data.days.events_resource_instances.title` (string)
    Title of a resource instance.
    Example: "Resource #1"

  - `data.days.events_resource_instances.resource_id` (number)
    ID of a resource, to which instance is linked.
    Example: 123

  - `data.days.events` (array)
    Events of appointments or events in a schedule series.  
Returned in response only if corresponding include is present in request.
    Example: [{"id":123,"created_at":"2026-01-01T12:12:12-05:00","updated_at":"2026-01-01T12:12:12-05:00","deleted_at":null,"event_status":"stable","event_datetime":"2026-01-24T14:00:00-05:00","event_entity_type":"activity","event_entity_id":123,"is_entity_master_changed":false,"is_entity_datetime_changed":false,"is_entity_duration_changed":false,"is_entity_labels_changed":false,"is_entity_resource_instances_changed":false}]

  - `data.days.events.id` (number)
    ID of an event of appointment/event in a schedule.
    Example: 123

  - `data.days.events.created_at` (string)
    Datetime of an event of appointment/event in a schedule created.
    Example: "2026-01-01T12:12:12-05:00"

  - `data.days.events.updated_at` (string)
    Datetime of an event of appointment/event in a schedule last updated.
    Example: "2026-01-01T12:12:12-05:00"

  - `data.days.events.deleted_at` (string,null)
    Datetime of an event of appointment/event in a schedule deleted.

  - `data.days.events.event_status` (string)
    Event of appointment/event status:  
stable - entity is stable;  
event_created - event is created, corresponding appointment/event is not created yet;  
event_changed - event is changed, corresponding appointment/event is not changed yet;  
event_changed_force - event is changed with force override of manual changes, corresponding appointment/event is not changed yet;  
event_deleted - event is deleted, corresponding appointment/event is not deleted yet;  
entity_deleted - appointment/event corresponding to an event is deleted (due to event deletion or due to manual deletion);  
entity_failed - appointment/event creation failure.
    Enum: "stable", "event_created", "event_changed", "event_changed_force", "event_deleted", "entity_deleted", "entity_failed"

  - `data.days.events.event_datetime` (string)
    Datetime of a scheduled appointment/event beginning.
    Example: "2026-01-24T14:00:00-05:00"

  - `data.days.events.event_entity_type` (string)
    Type of an scheduled entity (appointment or event). Note: enum values "record" and "activity" are legacy terms for appointment and event.
    Enum: "record", "activity"

  - `data.days.events.event_entity_id` (number,null)
    ID of an scheduled entity (appointment or event).
    Example: 123

  - `data.days.events.is_entity_master_changed` (boolean)
    Flag for manual change of a team member for a scheduled appointment/event.

  - `data.days.events.is_entity_datetime_changed` (boolean)
    Flag for manual change of a datetime for a scheduled appointment/event.

  - `data.days.events.is_entity_duration_changed` (boolean)
    Flag for manual change of a duration for a scheduled appointment/event.

  - `data.days.events.is_entity_labels_changed` (boolean)
    Flag for manual change of a tags linked to a scheduled appointment/event.

  - `data.days.events.is_entity_resource_instances_changed` (boolean)
    Flag for manual change of a resource instances linked to a scheduled appointment/event.

  - `data.days.events.entity_master` (object)
    Team member for a scheduled appointment/event.
    Example: {"id":123,"name":"John Johnson","company_id":123,"specialization":"Master","avatar":"https://app.alteg.io/images/no-master-sm.png","avatar_big":"https://app.alteg.io/images/no-master.png","position":{"id":123,"title":"Position"},"is_paid_staff":false}

  - `data.days.events.entity_master.id` (number)
    ID of a team member.
    Example: 123

  - `data.days.events.entity_master.name` (string)
    Name of a team member.
    Example: "John Johnson"

  - `data.days.events.entity_master.company_id` (number)
    ID of a location, where team member was created.
    Example: 123

  - `data.days.events.entity_master.specialization` (string)
    Specialization of a team member.
    Example: "Master"

  - `data.days.events.entity_master.avatar` (string)
    Link to the avatar of a team member (small).
    Example: "https://app.alteg.io/images/no-master-sm.png"

  - `data.days.events.entity_master.avatar_big` (string)
    Link to the avatar of a team member (original).
    Example: "https://app.alteg.io/images/no-master.png"

  - `data.days.events.entity_master.position` (object,null)
    Position of a team member.
    Example: {"id":123,"title":"Position"}

  - `data.days.events.entity_master.is_paid_staff` (boolean)
    Whether the team member is a paid staff member counted in license price.

  - `data.days.events.entity_datetime` (string)
    Actual datetime of a scheduled appointment/event beginning.
    Example: "2022-01-24 14:00:00"

  - `data.days.events.entity_duration` (string)
    Actual duration of a scheduled appointment/event.
    Example: 3600

  - `data.days.events.entity_labels` (array)
    Actual tags linked to a scheduled appointment/event.
    Example: [{"id":123,"title":"Tag","color":"#ff0000"}]

  - `data.days.events.entity_labels.id` (number)
    ID of tag.
    Example: 123

  - `data.days.events.entity_labels.title` (string)
    Title of a tag.
    Example: "Tag"

  - `data.days.events.entity_labels.color` (string)
    Color of a tag (#rrggbb).
    Example: "#ff0000"

  - `data.days.events.entity_resource_instances` (array)
    Actual resource instances linked to a scheduled appointment/event.
    Example: [{"id":123,"title":"Resource #1","resource_id":123}]

  - `data.days.events.entity_resource_instances.id` (number)
    ID of a resource instance.
    Example: 123

  - `data.days.events.entity_resource_instances.title` (string)
    Title of a resource instance.
    Example: "Resource #1"

  - `data.days.events.entity_resource_instances.resource_id` (number)
    ID of a resource, to which instance is linked.
    Example: 123

  - `meta` (object,array)
    Additional response data (empty object or empty array)

## Response 401 fields (application/json):

  - `success` (boolean)
    Response status.

  - `data` (object,null)
    Response data.

  - `meta` (object)
    Additional response data.

  - `meta.message` (string)
    Error message.
    Example: "Authentication needed."

## Response 403 fields (application/json):

  - `success` (boolean)
    Response status.

  - `data` (object,null)
    Response data.

  - `meta` (object)
    Additional response data.

  - `meta.message` (string)
    Error message.
    Example: "Access denied."

## Response 404 fields (application/json):

  - `success` (boolean)
    Response status.

  - `data` (object,null)
    Response data.

  - `meta` (object,array)
    Additional response data (empty object or empty array)

## Response 422 fields (application/json):

  - `success` (boolean)
    Response status.

  - `data` (object,null)
    Response data.

  - `meta` (object)
    Additional response data.

  - `meta.message` (string)
    Error message.
    Example: "An error has occurred."

  - `meta.errors` (array)
    Set of a validation error messages.