SAsalesforce
lenses

Update lens (partial)

Update selected metadata fields for the specified lens. Note that if you are updating the lens library, you must use PUT (which accepts multipart/form-data).

patch/lenses/{key}

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/lenses/{key}
  • Auth
    API key in header Authorization

Path parameters

keystring required

The id or name of the lens to update.

Request body

descriptionstring

A description of the lens. Leave empty if you want to use the description provided by the lens publisher (i.e. sourceDescription).

isPublishedboolean

Default false. When set to true, the lens is available to all users.

namestring

A unique name for the lens. Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-). Leave empty if you want to use the name provided by the lens publisher (i.e. sourceName).

versionstring

A version for the lens. Leave empty if you want to use the version provided by the lens publisher (i.e. sourceVersion).

ownerstring

The name of the user to assign as the owner. Defaults to the user that created it

Response

Success, returns the updated lens.

descriptionstring

A description of the lens.

helpEmailstring

The email address where a user can go to get more help about the lens. A lens may choose to display this information to the user e.g. if the user clicks a "help" icon attached to the lens.

helpUrlstring

The url where a user can go to get more help about the lens. A lens may choose to display this information to the user e.g. if the user clicks a "help" icon attached to the lens.

idstring

The lens id.

isCustomboolean

True for any lens which is installed by an administrator (rather than pre-installed in Refocus).

isPublishedboolean

True when the lens is available to users.

lensEventApiVersioninteger

The API version for the Lens Event API, e.g. 1, 2, etc.

namestring

The name of lens. Max 60 characters; case insensitive; allows alpha-numeric characters, underscore (_) and dash (-).

sourceDescriptionstring

The original lens publisher's description of the lens.

sourceNamestring

The original lens publisher's name of the lens.

sourceVersionstring

The original lens publisher's version of the lens.

thumbnailUrlstring

Optional thumbnail image to represent the lens.

installedBystring

TODO

createdBystring

Id of the User who created this Lens.

createdAtstring

TODO

updatedAtstring

TODO

Changes

No recorded changes to this operation across all 70 revisions of this API.