---
title: "Webresources.update"
method: PATCH
path: "/entities/Webresources/{id}"
tags: ["Webresource"]
---

# Webresources.update

`PATCH /entities/Webresources/{id}`

## Request

- Base URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id`
- URL: `https://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id/entities/Webresources/{id}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/coevera/apis/coevera-crm-api/docs/entities/Webresources/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Changes fields of the Webresource record with the given id; fields left out keep their values.

## Path parameters

- `id` string, uuid, required

## Query parameters

- `validation-level` integer

## Request body

- UpdateWebresourceInput: Field values to change on a Webresource record; fields left out keep their values.
  - `display_param` string: Bit flag controlling how the web resource is displayed (e.g. full-screen, in a tab).
  - `entity` string: Name of the entity the web resource is attached to (e.g. "Account", "Lead").
  - `name` string: Name of the entity and its default text representation.
  - `request_method` 1 | 2: HTTP method (Get or Post) used to open the url of the web resource. Integer enum value: 1 - Get, 2 - Post
  - `url` string: URL template for the embedded web resource. May reference field values via "{#<field_id>}" placeholders that are substituted with the current record's values.
  - `revision` integer: Revision when entity was lastly changed.

## Response `200`

The changed Webresource record.

- object
  - `success` boolean: True when the request succeeded; false on error.
  - `data` Webresource: Web page embedded in the app for records of an entity, with its URL filled from the record's field values.
    - `is_delete_protected` boolean, required: True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
    - `has_draft` boolean, required: True when the record has unpublished draft changes, including pending translation changes, that can be published.
    - `id` string, uuid, required: Unique identifier of entity.
    - `is_deleted` boolean: Specifies if the entity is considered deleted.
    - `modified` string, date-time: Last modification time.
    - `created` string, date-time: Creation time.
    - `display_param` string, required: Bit flag controlling how the web resource is displayed (e.g. full-screen, in a tab).
    - `entity` string, required: Name of the entity the web resource is attached to (e.g. "Account", "Lead").
    - `name` string, required: Name of the entity and its default text representation.
    - `request_method` 1 | 2: HTTP method (Get or Post) used to open the url of the web resource. Integer enum value: 1 - Get, 2 - Post
    - `url` string: URL template for the embedded web resource. May reference field values via "{#<field_id>}" placeholders that are substituted with the current record's values.
    - `is_published` boolean: True when the web resource is published; false while it exists only as an unpublished draft.
    - `revision` integer: Revision when entity was lastly changed.

## Other responses

- `400`: Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
- `401`: Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
- `404`: No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
- `422`: Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written.
- `429`: Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
- `500`: Unexpected server error (code 1000, ERROR_UNKNOWN).

---

[API](https://skmtc.dev/coevera/apis/coevera-crm-api.md) - [All operations](https://skmtc.dev/coevera/apis/coevera-crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/coevera/apis/coevera-crm-api/revisions/40ebbc83f179?raw)