POST/desk/api/v2/businesshours.json

Create a new businesshour.

Body Params

BusinessHour represents a BusinessHour.

    • Name
      businesshourholidays
      Type
      array
    • Name
      businesshourschedules
      Type
      array
    • Name
      createdAt
      Type
      string
      Description
      CreatedAt is a read-only date marking the creation time.
    • Name
      createdBy
      Type
      object
    • Name
      deletedAt
      Type
      string
      Description
      DeletedAt is a read-only date marking the time of deletion. Is only returned when the object is marked as deleted.
    • Name
      deletedBy
      Type
      object
    • Name
      description
      Type
      string
    • Name
      filter_args
      Type
      object
      Description
      RequestCommons allows specifying paging and sorting options. All API endpoints should embed the RequestOrder for consistency.
    • Name
      id
      Type
      integer
    • Name
      isDefault
      Type
      boolean
    • Name
      name
      Type
      string
    • Name
      state
      Type
      string
      Description
      State is the status of the object. Typically this will be either active or deleted. When deleted the `deletedAt` and `deletedBy` relationship will be returned.
    • Name
      timezone_name
      Type
      string
    • Name
      timezoneId
      Type
      integer
    • Name
      triggers
      Type
      array
    • Name
      updatedAt
      Type
      string
      Description
      UpdatedAt is a read-only date marking the last updated time. This field is not updated when the object is deleted.
    • Name
      updatedBy
      Type
      object

    Responses

    • Code
      201
      Type
      object
      Schema
      Description
      201 Created
      BusinessHourAPIBody handles the get/create/update request/response for businesshour.
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      Validator hold the validation errors. Typically you shouldn't create this directly but use the New() function.

    Examples

    201 Created

    BusinessHourAPIBody
    {  "businesshour": {    "businesshourholidays": [      {        "delete": true,        "id": 0,        "meta": {          "additionalProp": "Unknown Type: any"        },        "type": 0      }    ],    "businesshourschedules": [      {        "delete": true,        "id": 0,        "meta": {          "additionalProp": "Unknown Type: any"
    Download Swagger