| PUT | /widget/configuration/{Id} | Update a widget configuration | Updates an existing widget configuration. The Configuration JSON is re-validated against the schema for SchemaVersion. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
| Id | path | string | Yes | The widget configuration id (6-character NanoID). |
| Name | body | string | Yes | The widget configuration name. |
| Slug | body | string | No | Optional slug (URL-friendly identifier). The API will append the last 3 characters of the company ID. Example: 'hairsalon' becomes 'hairsalon-001'. |
| Description | body | string | No | Optional description. |
| Configuration | body | string | Yes | The widget configuration as a JSON string. Must validate against the schema for SchemaVersion. |
| SchemaVersion | body | int | Yes | Version of the configuration schema this Configuration adheres to. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | Yes | |
| CompanyId | form | Guid | No | |
| Name | form | string | Yes | |
| Slug | form | string | No | |
| Description | form | string | No | |
| Configuration | form | string | Yes | |
| SchemaVersion | form | int | No | |
| CreatedDate | form | DateTime | No | |
| UpdatedDate | form | DateTimeOffset? | No | |
| ResponseStatus | form | ResponseStatus | Yes |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /widget/configuration/{Id} HTTP/1.1
Host: testapi.bokamera.se
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":"String","Name":"String","Slug":"String","Description":"String","Configuration":"String","SchemaVersion":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Id":"String","Name":"String","Slug":"String","Description":"String","Configuration":"String","SchemaVersion":0,"UpdatedDate":"0001-01-01T00:00:00.0000000+00:00","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}