Rentals tags

  1. Overview
  2. List rentals tags
  3. Get a single rentals tag
  4. Create new rentals tags
  5. Update a rentals tag

Overview

This resource represents the Rentals Tags that can be associated with the Rentals.

Parameters

Name Type Read/Write Description
account Integer Read Account’s ID related to the Rentals Tag
id Integer Read Rentals Tag’s ID.
name Object Read Rentals Tag’s title, list of locales described in enums section.
logo String Read Rentals Tag’s logo (Font Awesome class).
color String Read Rentals Tag’s color (hex).
created_at Time Read Rentals Tag’s create time.
updated_at Time Read Rentals Tag’s update time.
Name Type Read/Write Description Constraints
account Integer Read Account’s ID related to the Rentals Tag  
id Integer Read Rentals Tag’s ID.  
name Object Read/Write Rentals Tag’s title, list of locales described in enums section. Required
logo String Read/Write Rentals Tag’s logo (Font Awesome class).  
color String Read/Write Rentals Tag’s color (hex). Required
created_at Time Read Rentals Tag’s create time.  
updated_at Time Read Rentals Tag’s update time.  

List rentals tags

List all rentals tags for a given account.

GET /rentals_tags

Response

{
  "links": {
    "rentals_tags.account": "https://www.bookingsync.com/api/v3/accounts/{rentals_tags.account}"
  },
  "rentals_tags": [
    {
      "id": 1,
      "color": "#FFFFFF",
      "logo": "fa-rocket",
      "name": {
        "en": "tag"
      },
      "created_at": "2022-03-23T16:56:20Z",
      "updated_at": "2022-03-23T16:56:20Z",
      "links": {
        "account": 1
      }
    }
  ]
}

Get a single rentals tag

Returns a single rentals tag identified by ID.

GET /rentals_tags/:rentals_tag_id

Response

{
  "links": {
    "rentals_tags.account": "https://www.bookingsync.com/api/v3/accounts/{rentals_tags.account}"
  },
  "rentals_tags": [
    {
      "id": 1,
      "color": "#FFFFFF",
      "logo": "fa-rocket",
      "name": {
        "en": "tag"
      },
      "created_at": "2022-03-23T16:56:20Z",
      "updated_at": "2022-03-23T16:56:20Z",
      "links": {
        "account": 1
      }
    }
  ]
}

Create new rentals tags

Translated attributes

Please note that translated attributes are updated differenly than you read them.
To set the English name, locale en, you need to use the name_en attribute.

List of locales described in enums section.

Returns the newly created rentals tags.

POST /rentals_tags

Example JSON request

{
  "rentals_tags": [
    {
      "color": "#FFFFFF",
      "logo": "fa-rocket",
      "name_en": "tag"
    }
  ]
}

Response

{
  "links": {
    "rentals_tags.account": "https://www.bookingsync.com/api/v3/accounts/{rentals_tags.account}"
  },
  "rentals_tags": [
    {
      "id": 1,
      "color": "#FFFFFF",
      "logo": "fa-rocket",
      "name": {
        "en": "tag"
      },
      "created_at": "2022-03-23T16:56:20Z",
      "updated_at": "2022-03-23T16:56:20Z",
      "links": {
        "account": 1
      }
    }
  ]
}

Update a rentals tag

Translated attributes

Please note that translated attributes are updated differenly than you read them.
To set the English name, locale en, you need to use the name_en attribute.

List of locales described in enums section.

Returns an updated rentals tag identified by ID.

PUT /rentals_tags/:rentals_tag_id

Example JSON request

{
  "rentals_tags": [
    {
      "color": "#FFFFFF",
      "logo": "fa-rocket",
      "name_en": "tag"
    }
  ]
}

Response

{
  "links": {
    "rentals_tags.account": "https://www.bookingsync.com/api/v3/accounts/{rentals_tags.account}"
  },
  "rentals_tags": [
    {
      "id": 1,
      "color": "#FFFFFF",
      "logo": "fa-rocket",
      "name": {
        "en": "tag"
      },
      "created_at": "2022-03-23T16:56:20Z",
      "updated_at": "2022-03-23T16:56:20Z",
      "links": {
        "account": 1
      }
    }
  ]
}