Bookings Tags

Overview

This resource represents the Booking Tags that can be associated with the Bookings.

Parameters

OAuth Scopes:

bookings_read

Name	Type	Read/Write	Description
account	Integer	Read	Account's ID related to the Bookings Tag
id	Integer	Read	Bookings Tag's id.
color	String	Read	Bookings Tag's color (Hexadecimal representation)
logo	String	Read	Bookings Tag's logo (Currently as font awesome class)
name	Object	Read	Bookings Tag's name, list of locales described in enums section.
created_at	Time	Read	Bookings Tag's create time.
updated_at	Time	Read	Bookings Tag's update time.

bookings_write

Name	Type	Read/Write	Description	Constraints
account	Integer	Read	Account's ID related to the Bookings Tag
id	Integer	Read	Bookings Tag's id.
color	String	Read/Write	Bookings Tag's color (Hexadecimal representation)	Required
logo	String	Read/Write	Bookings Tag's logo (Currently as font awesome class)
name	Object	Read/Write	Bookings Tag's name, list of locales described in enums section.	Required
created_at	Time	Read	Bookings Tag's create time.
updated_at	Time	Read	Bookings Tag's update time.

List bookings tags

List all bookings tags for a given account(s).

GET /bookings_tags

OAuth Scopes:

bookings_read

response.json

{
  "links": {
    "bookings_tags.account": "https://www.bookingsync.com/api/v3/accounts/{bookings_tags.account}"
  },
  "bookings_tags": [
    {
      "links": {
        "account": 3
      },
      "id": 3,
      "name": {
        "en": "Beach"
      },
      "color": "#6666ff",
      "logo": "fa-link",
      "created_at": "2017-04-26T08:21:58Z",
      "updated_at": "2017-05-02T09:41:51Z"
    }
  ],
  "meta": {}
}

Get a single bookings tag

Returns a single bookings tag identified by ID.

GET /bookings_tags/:bookings_tag_id

OAuth Scopes:

bookings_read

response.json

{
  "links": {
    "bookings_tags.account": "https://www.bookingsync.com/api/v3/accounts/{bookings_tags.account}"
  },
  "bookings_tags": [
    {
      "links": {
        "account": 3
      },
      "id": 3,
      "name": {
        "en": "Beach"
      },
      "color": "#6666ff",
      "logo": "fa-link",
      "created_at": "2017-04-26T08:21:58Z",
      "updated_at": "2017-05-02T09:41:51Z"
    }
  ],
  "meta": {}
}

Create a new bookings tag

Creates a bookings tag for account.

POST /bookings_tags

OAuth Scopes:

bookings_write

request.json

{
  "bookings_tags": [
    {
      "color": "#008080",
      "name_en": "tag_name"
    }
  ]
}

response.json

{
  "links": {
    "bookings_tags.account": "https://www.bookingsync.com/api/v3/accounts/{bookings_tags.account}"
  },
  "bookings_tags": [
    {
      "links": {
        "account": 1
      },
      "id": 5,
      "name": {
        "en": "tag_name"
      },
      "color": "#008080",
      "logo": null,
      "created_at": "2019-04-25T02:26:42Z",
      "updated_at": "2019-04-25T02:26:42Z"
    }
  ],
  "meta": {}
}

Update a bookings tag

Returns an updated bookings tag identified by ID.

PUT /bookings_tags/:bookings_tag_id

OAuth Scopes:

bookings_write

request.json

{
  "bookings_tags": [
    {
      "color": "#008080",
      "name_en": "tag_name"
    }
  ]
}

response.json

{
  "links": {
    "bookings_tags.account": "https://www.bookingsync.com/api/v3/accounts/{bookings_tags.account}"
  },
  "bookings_tags": [
    {
      "links": {
        "account": 1
      },
      "id": 5,
      "name": {
        "en": "tag_name"
      },
      "color": "#008080",
      "logo": null,
      "created_at": "2019-04-25T02:26:42Z",
      "updated_at": "2019-04-25T02:26:42Z"
    }
  ],
  "meta": {}
}

Add a single bookings tag

Adds a tag to an existing booking.

POST /bookings/:id/add_tag/:bookings_tag_id

Returns empty body with status: 201

Remove a single bookings tag

Removes a tag from an existing booking.

DELETE /bookings/:id/remove_tag/:bookings_tag_id

Returns empty body with status: 204