COcoevera
Webresource

Webresources.create

Creates a Webresource record.

post/entities/Webresources

Request

Query parameters

validation-levelinteger

Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

modifiedstring date-time

Last modification time.

createdstring date-time

Creation time.

display_paramstring required

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

entitystring required

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

namestring required

Name of the entity and its default text representation.

request_method1 | 2

HTTP method (Get or Post) used to open the url of the web resource.

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.

is_publishedboolean

True when the web resource is published; false while it exists only as an unpublished draft.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "modified": "2019-01-01T00:00:00",
  "created": "2019-01-01T00:00:00",
  "entity": "string",
  "name": "string",
  "request_method": 1,
  "url": "string",
  "revision": 1
}

Response

The created Webresource record.

successboolean

True when the request 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
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.