Launchpad by Pegasystems icon

Launchpad by Pegasystems

Consume Pega Launchpad API

Actions22

User → Mark as Inactive

AI-generated

Summary

Marks a Pega Launchpad user object as inactive by sending a PATCH to the object's MarkAsInactive action, with an optional reason recorded as the status-update reason.

Inputs

  • authentication — Authentication method; only OAuth2 is available (uses the pegalaunchpadOAuth2Api credential).
  • baseUrl (required) — Base URL of the Pega Launchpad instance, e.g. https://your-pega-domain.com. A trailing slash is stripped.
  • objectId (required) — ID of the user object to deactivate. It is placed in the request path.
  • ifMatch (required) — ETag from a prior GET of the object, used for optimistic concurrency. It is trimmed, and a leading 'W/' is converted to lowercase 'w/' before being sent as the If-Match header.
  • reason — Free-text reason for deactivation. It is sent as content.ReasonForStatusUpdate and defaults to an empty string.

Output shape

One JSON item per input item. It contains the parsed response body from Pega, plus a responseHeaders object with the HTTP response headers.

The request is PATCH /dx/api/application/v2/objects/{objectId}/actions/MarkAsInactive with body {content:{ReasonForStatusUpdate}, pageInstructions:[]}. If the ETag is stale or the request fails, the node throws a NodeApiError. With Continue On Fail enabled, it instead returns an item containing {error: message}. The body may be empty, in which case only responseHeaders is returned.

Examples

Example 1: Deactivate a departing employee's user record after fetching its current ETag.

baseUrl=https://acme.pega.com, objectId={{$json.ID}}, ifMatch={{$json.responseHeaders.etag}}, reason='Employee left company'

Example 2: Deactivate a user without giving a reason.

Set baseUrl, objectId and ifMatch to w/"2"; leave Reason empty.

Links

Discussion