# Upsert Workflow Action

Upsert Workflow Action

Endpoint: PATCH /rest/2.0/WORKFLOW_ACTION
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.ActionCriteria` (string)
    Action Criteria: This allows you to limit or provide conditions on when the action is performed. This is especially useful when dealing with actions that impact records/fields/objects in the child nodes relative to the workflow entity. The standard object reference model table or formula can be used to build the filters.

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `brmObjects.LinkUrl` (string)
    Callout URL: The URL where the message will be sent. For example: https://www.google.com.ph/

  - `brmObjects.DocumentTemplateSource` (string)
    Document Template Source

  - `brmObjects.CounterFail` (string)
    Failed Executions

  - `brmObjects.ActionType` (string)
    Action Type: Field Update is the only Action Type available for the workflows with enabled bulk updates.

  - `brmObjects.HttpMessage` (string)
    Message Body: The actual message body. Field references can be used to populate the message.

  - `brmObjects.SoapEntityCreationRequest` (string)
    JSON Entity Representation: This is auto-populated by a JSON request containing the fields of the target entity selected in the Entity for Create field. The Insert Field button can be used to source the data from entity fields via the object reference model. The value section will have INSERT DATA where you can enter hard-coded data or replace it with a field.

  - `brmObjects.FileName` (string, required)
    File Name: Specify file naming pattern here. The resultant formula will generate the file name for each document

  - `brmObjects.Status` (string)
    Active: The status of the workflow action. When ACTIVE, the workflow action is executed. When DEACTIVATED, the workflow action is skipped. This field can be updated after the creation of the workflow action as needed.

  - `brmObjects.RecipientTo` (string)
    Recipient To: Direct Email recipient sourced from the fields related to the Entity selected for the Workflow. Select the field on the entity or related Entities that contains the recipient email Address.

  - `brmObjects.DocumentTemplateField` (string, required)
    Document Template (Data)

  - `brmObjects.UpdateToNullFlag` (integer)
    Update To Null: When checked, this updates the field specified by Field To Update to null/blank.

  - `brmObjects.ExecOrder` (string, required)
    Order Of Execution: An integer field that allows you to specify the order by which the action is performed. This is used when there is more than one action associated with the entity. If there is more than one action with the same order value, the actions are executed according to the Name value in ascending alphabetical order.

  - `brmObjects.RecipientCc` (string)
    Recipient CC: CC (Carbon Copy) email recipient sourced from the fields related to the Entity selected for the Workflow. Select the field on the entity or related Entities that contains the recipient email Address.

  - `brmObjects.DocumentTemplateId` (integer, required)
    Document Template: Select the document template used for generating PDF document via this workflow action. Document template definition is done under the setup tab.

  - `brmObjects.ExpeditedExecution` (integer)
    Expedited Execution: When checked the action will be executed ahead of any pending scheduled workflow actions, when unchecked the action will be executed with pending scheduled workflow actions in the order it was received

  - `brmObjects.UpdEntityField` (string, required)
    Field To Update: This is the field on the entity record or reference record field up the hierarchy or child nodes that needs to be updated. The Insert Field can be used for easy navigation into the parent, reference, or child node hierarchy and selection of a field.

  - `brmObjects.Formula` (string)
    Field Update Formula: Text area where the new value of the field to be updated can be written. This can be a constant or a complicated formula that can pull values from other fields and concatenated with others or built-in functions.

  - `brmObjects.CriteriaFormula` (string)
    Formula: Use this formula to define criteria filter. Refer to online help system for a full list of operations, functions, and general syntax.

  - `brmObjects.CounterSucces` (string)
    Successful Executions

  - `brmObjects.UpdateFilterField` (string)
    Field to Update Filter Field

  - `brmObjects.WorkflowActionName` (string)
    Name: Unique name of the action. Note that the unique name is global so the same name cannot be used between two different workflows.

  - `brmObjects.CreateEntityId` (integer, required)
    Entity for Create/Update

  - `brmObjects.FilterLogic` (string)
    Criteria Join Logic: Use this to define the logical grouping of your filter criteria. The ordered list of Filters defined above can be segregated to more narrowly define the filter as a whole. So let`s say you have three filters, use this field to define a meaning across the three references. For example: (1 AND 2 ) OR 3/ Use parentheses as well as AND and OR operators to define the filter logic.

  - `brmObjects.EmailTemplateId` (integer, required)
    Email Template: Select the email template used for the email delivered via this workflow action. Email template definition is done under the setup tab.

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.UpsertField` (string)
    Upsert/Update Field

  - `brmObjects.Id` (string, required)
    ID: WORKFLOW_ACTION_ID

  - `brmObjects.Description` (string)
    Description

  - `brmObjects.RecipientBcc` (string)
    Recipient BCC: BCC (Blind Carbon Copy) email recipient sourced from the fields related to the Entity selected for the Workflow. Select the field on the entity or related Entities that contains the recipient email Address.

  - `brmObjects.HttpMethod` (string)
    HTTP Method: This specifies the type of HTTP CallOut to be made.

  - `brmObjects.OauthAuthenticationKeyId` (integer)
    OAuth Authentication Key

  - `brmObjects.ExecuteOnUpdate` (string)
    Execute On Update

  - `brmObjects.ExecuteOnUpsert` (string)
    Execute On Upsert

  - `brmObjects.ExecuteOnDelete` (string)
    Execute On Delete

  - `brmObjects.Immediately` (integer)
    Synchronous Execution: Synchronous Execution Flag

  - `brmObjects.AttachField` (string)
    AttachField

  - `brmObjects.WorkflowRuleId` (integer)
    WorkflowRuleId

  - `brmObjects.SystemFlag` (string)
    SystemFlag

  - `brmObjects.ExternalKey` (string, required)
    ExternalKey

  - `brmObjects.ExecuteOnCreate` (string)
    Execute On Create

  - `externalIDFieldName` (string)
    Enum: "ExternalKey"

## Response 200 fields (application/json):

  - `upsertResponse` (array)

  - `upsertResponse.Id` (integer)

  - `upsertResponse.success` (boolean)

  - `upsertResponse.ErrorText` (string)

  - `upsertResponse.ErrorElementField` (string)

  - `upsertResponse.created` (boolean)