v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Webresource

Webresources.update

Modifies Webresource or Webresources with given id(s)

patch/entities/Webresources/{id}

Path parameters

idstring uuid required

ID of Webresource to update

Query parameters

validation-levelinteger

Specify validation level of Webresource on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

display_paramstring

Bit flag controlling how the web resource is displayed (e.g. full-screen, in a tab).

entitystring

Name of the entity the web resource is attached to (e.g. "Account", "Lead").

namestring

Name of the entity and its default text representation.

request_method1 | 2

Field whose values are strictly defined with an enumeration of values.

Integer enum value: 1 - Get, 2 - Post

urlstring

URL template for the embedded web resource. May reference field values via "{#<field_id>}" placeholders that are substituted with the current record's values.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "entity": "string",
  "name": "string",
  "request_method": 1,
  "url": "string",
  "revision": 1
}

Response

Modification confirmation. Returns resulting Webresource

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "entity": "string",
    "name": "string",
    "request_method": 1,
    "url": "string",
    "revision": 1
  }
}