BokaMera.API.Host

<back to all web services

UpdateWebhookSettingsRequest

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/webhook/settingsEnable or disable webhook feature for the companySets the webhook feature flag for the company identified by the API key in the header
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type WebhookSettingsResponse() = 
        member val Enabled:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set
        member val CompanyId:Guid = new Guid() with get,set

    [<AllowNullLiteral>]
    type UpdateWebhookSettingsRequest() = 
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.", IsRequired=true, ParameterType="query")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        [<Required>]
        [<ApiMember>]
        member val Enabled:Boolean = new Boolean() with get,set

F# UpdateWebhookSettingsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /webhook/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Enabled":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Enabled":false,"Message":"String"}