| PUT | /widget/configuration/{Id}/reset | Reset the homepage default widget configuration to factory defaults | Resets the auto-provisioned homepage default configuration's Configuration JSON and SchemaVersion back to the factory-default values. Only valid for the homepage default configuration — returns 400 for any other configuration. |
|---|
| 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 | 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 | |
| IsHomepageDefault | form | bool | 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 .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /widget/configuration/{Id}/reset HTTP/1.1
Host: api.bookmore.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Id":"String","Name":"String","Slug":"String","Description":"String","Configuration":"String","SchemaVersion":0,"IsHomepageDefault":false,"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"}}}