Views

Update a saved view

Changed on

Apply a partial update to one of your account's saved views. Only the fields you send are changed, except arrays such as filters and columns, which are replaced wholesale rather than merged. Guesty's predefined views cannot be modified and return 400. Returns the updated view.

put/views/{id}

Request

  • Base URL
    https://open-api.guesty.com/v1
  • URL
    https://open-api.guesty.com/v1/views/{id}
  • Auth
    API key in header authorization

Path parameters

idstring required

View ID

Request body

_idstring

Unique id

accountIdstring

Id of the user owning this view

titlestring

Title for the view

fieldsstring

Selection of fields, separated by space

sortstring

ascending sort, use '-' for descending sort

createdAtstring date-time

Timestamp when the view was created.

updatedAtstring date-time

Timestamp when the view was last updated.

Example request

{
  "scheduledEmails": [
    {
      "days": [
        4
      ],
      "hour": 14
    }
  ],
  "shares": [
    {
      "contactId": "5926bdfb1bfe871000d0a745"
    }
  ]
}

Response

Retrieve the updated listing, selection of fields that were sent in body.

_idstring

Unique id

accountIdstring

Id of the user owning this view

titlestring

Title for the view

fieldsstring

Selection of fields, separated by space

sortstring

ascending sort, use '-' for descending sort

createdAtstring date-time

Timestamp when the view was created.

updatedAtstring date-time

Timestamp when the view was last updated.

Example response

{
  "scheduledEmails": [
    {
      "days": [
        4
      ],
      "hour": 14
    }
  ],
  "shares": [
    {
      "contactId": "5926bdfb1bfe871000d0a745"
    }
  ]
}

Changes

    • breaking

      the request property format changed from no format to date-time

    • breaking

      the // request property format changed from no format to int32

    • breaking

      the request property format changed from no format to date-time

    • info

      api operation id accountsViewUpdate was added