| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /tags/{Id} | Update a tag | Replaces the editable fields of a tag. Name is required; Color, SortOrder, and Active default to null/0/true when omitted. Scope cannot be changed because it would orphan existing tag relations. |
|---|
"use strict";
export class TagResponse {
/** @param {{Id?:number,CompanyId?:string,Name?:string,Scope?:number,Color?:string,SortOrder?:number,Active?:boolean,CreatedDate?:string,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
CompanyId;
/** @type {string} */
Name;
/** @type {number} */
Scope;
/** @type {string} */
Color;
/** @type {number} */
SortOrder;
/** @type {boolean} */
Active;
/** @type {string} */
CreatedDate;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class UpdateTag {
/** @param {{CompanyId?:string,Id?:number,Name?:string,Color?:string,SortOrder?:number,Active?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @type {number}
* @description The tag id. */
Id;
/**
* @type {string}
* @description The tag name. */
Name;
/**
* @type {string}
* @description The display color for the tag. */
Color;
/**
* @type {?number}
* @description The sort order. Defaults to 0 when omitted. */
SortOrder;
/**
* @type {?boolean}
* @description Whether the tag is active. Defaults to true when omitted. */
Active;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /tags/{Id} HTTP/1.1
Host: api-staging.bookmore.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"Name":"String","Color":"String","SortOrder":0,"Active":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Id":0,"Name":"String","Scope":0,"Color":"String","SortOrder":0,"Active":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}