Rentals tags

Overview

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

Parameters

OAuth Scopes:

rentals_read

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.

rentals_write

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

OAuth Scopes:

public

response.json

{
  "links": {
    "rentals_tags.account": "https://www.bookingsync.com/api/v3/accounts/{rentals_tags.account}"
  },
  "rentals_tags": [
    {
      "links": {
        "account": 1
      },
      "id": 1,
      "name": {
        "en": "tag"
      },
      "logo": "fa-rocket",
      "color": "#FFFFFF",
      "created_at": "2025-03-17T22:18:31.720Z",
      "updated_at": "2025-03-24T22:18:31.720Z"
    }
  ]
}

Get a single rentals tag

Returns a single rentals tag identified by ID.

GET /rentals_tags/:rentals_tag_id

OAuth Scopes:

public

response.json

{
  "links": {
    "rentals_tags.account": "https://www.bookingsync.com/api/v3/accounts/{rentals_tags.account}"
  },
  "rentals_tags": [
    {
      "links": {
        "account": 1
      },
      "id": 1,
      "name": {
        "en": "tag"
      },
      "logo": "fa-rocket",
      "color": "#FFFFFF",
      "created_at": "2025-03-17T22:18:31.721Z",
      "updated_at": "2025-03-24T22:18:31.721Z"
    }
  ]
}

Create new rentals tags

Translated attributes

Please note that translated attributes are updated differently 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

OAuth Scopes:

rentals_write

request.json

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

response.json

{
  "links": {
    "rentals_tags.account": "https://www.bookingsync.com/api/v3/accounts/{rentals_tags.account}"
  },
  "rentals_tags": [
    {
      "links": {
        "account": 1
      },
      "id": 1,
      "name": {
        "en": "tag"
      },
      "logo": "fa-rocket",
      "color": "#FFFFFF",
      "created_at": "2025-03-17T22:18:31.722Z",
      "updated_at": "2025-03-24T22:18:31.722Z"
    }
  ]
}

Update a rentals tag

Translated attributes

Please note that translated attributes are updated differently 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

OAuth Scopes:

rentals_write

request.json

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

response.json

{
  "links": {
    "rentals_tags.account": "https://www.bookingsync.com/api/v3/accounts/{rentals_tags.account}"
  },
  "rentals_tags": [
    {
      "links": {
        "account": 1
      },
      "id": 1,
      "name": {
        "en": "tag"
      },
      "logo": "fa-rocket",
      "color": "#FFFFFF",
      "created_at": "2025-03-17T22:18:31.723Z",
      "updated_at": "2025-03-24T22:18:31.723Z"
    }
  ]
}