| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| DELETE | /customers/{CustomerId}/tags/{TagId} | Remove a tag from a customer | Detaches a tag from an existing customer. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | query | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
| CustomerId | path | Guid | Yes | The customer id. |
| TagId | path | int | Yes | The tag id to remove. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Firstname | form | string | Yes | |
| Lastname | form | string | Yes | |
| form | string | Yes | ||
| Phone | form | string | Yes | |
| ImageUrl | form | string | Yes | |
| PersonalIdentityNumber | form | string | Yes | |
| CustomFields | form | List<CustomFieldConfigData> | Yes | |
| CustomFieldValues | form | List<CustomFieldDataResponse> | Yes | |
| Comments | form | List<CustomerCommentsResponse> | Yes | |
| AccessKeys | form | List<UserAccessKeys> | Yes | |
| Updated | form | DateTime | No | |
| Created | form | DateTime | No | |
| ResponseStatus | form | Object | Yes | |
| SubscribedToNewsletter | form | bool | No | |
| InvoiceAddress | form | InvoiceAddressResponse | Yes | |
| Tags | form | List<TagResponse> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | Custom field id |
| Name | form | string | Yes | Configuration name. Example: 'Number of persons'. |
| Description | form | string | Yes | Custom field description. Example: 'For how many persons is this booking?' |
| Width | form | int? | No | Field width. Example: 20 for 20px |
| DataType | form | string | Yes | Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox' |
| DefaultValue | form | string | Yes | Default value of the field. Example: '3' |
| IsMandatory | form | bool | No | Determines if the field is required to have a value or not |
| MandatoryErrorMessage | form | string | Yes | Error message shown to the user if the field data is required but not entered |
| MaxLength | form | int | No | Max lenght of the field |
| MultipleLineText | form | bool | No | If the field should have multiple lines |
| RegEx | form | string | Yes | Regular expression used for validation of the field |
| RegExErrorMessage | form | string | Yes | Error message shown if the regular expression validation failed |
| Values | form | List<CustomFieldValueResponse> | Yes | The values to select from if Datatype is DropDown for this custom field |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Value | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Column | form | string | Yes | |
| Name | form | string | Yes | |
| Description | form | string | Yes | |
| Value | form | string | Yes | |
| DataType | form | string | Yes | Data field of custom field. Valid values are: TextBox, ... Example: 'TextBox' |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| CustomerId | form | Guid | No | |
| Comments | form | string | Yes | |
| Updated | form | DateTime | No | |
| Created | form | DateTime | No | |
| ImageUrl | form | Uri | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | form | Guid | Yes | |
| AccessKeyTypeId | form | int | Yes | |
| Value | form | string | Yes | |
| CustomerId | form | Guid | Yes | |
| Description | form | string | No | |
| Id | form | Guid | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| InvoiceAddressId | form | Guid | No | |
| UserId | form | Guid? | No | |
| CorporateIdentityNumber | form | string | Yes | |
| InvoiceAddress1 | form | string | Yes | |
| InvoiceAddress2 | form | string | Yes | |
| InvoiceCity | form | string | Yes | |
| InvoicePostalCode | form | string | Yes | |
| InvoiceCountryCode | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| CompanyId | form | Guid | No | |
| Name | form | string | Yes | |
| Scope | form | TagScope | No | |
| Color | form | string | Yes | |
| SortOrder | form | int | No | |
| Active | form | bool | No | |
| CreatedDate | form | DateTime | No | |
| ResponseStatus | form | ResponseStatus | Yes |
| Booking | |
| Customer |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
DELETE /customers/{CustomerId}/tags/{TagId} HTTP/1.1
Host: testapi.bokamera.se
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Firstname":"String","Lastname":"String","Email":"String","Phone":"String","ImageUrl":"String","PersonalIdentityNumber":"String","CustomFields":[{"Id":0,"Name":"String","Description":"String","Width":0,"DataType":"String","DefaultValue":"String","IsMandatory":false,"MandatoryErrorMessage":"String","MaxLength":0,"MultipleLineText":false,"RegEx":"String","RegExErrorMessage":"String","Values":[{"Value":"String"}]}],"CustomFieldValues":[{"Id":0,"Column":"String","Name":"String","Description":"String","Value":"String","DataType":"String"}],"Comments":[{"Id":0,"Comments":"String"}],"AccessKeys":[{"AccessKeyTypeId":0,"Value":"String","Description":"String"}],"ResponseStatus":{},"SubscribedToNewsletter":false,"InvoiceAddress":{"UserId":"00000000-0000-0000-0000-000000000000","CorporateIdentityNumber":"String","InvoiceAddress1":"String","InvoiceAddress2":"String","InvoiceCity":"String","InvoicePostalCode":"String","InvoiceCountryCode":"String"},"Tags":[{"Id":0,"Name":"String","Scope":"Booking","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"}}}]}