Partially updates an existing solution by its ID (PATCH).

patch

https://rls.congacloud.com/api/ingress/v1/Solution/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The ID of the solution to patch.

Body Params

The payload containing the fields to be updated.

PATCH request body for a solution. Inherits all editable fields (including
Status) from SolutionBase. Do NOT redeclare
inherited properties here — a shadowing property would be populated by the deserializer
while the base property (read by the mapper's ApplyPatch(SolutionBase, …)) stayed
null, silently dropping the field on update.

string

name

string

description

string

status

string

Free-form solution status supplied by the UI (e.g. "pending changes", "up to date").
Accepted on create/patch and persisted in the stored solution payload.

environment

string

region

string

highVolumeApiLanguage

string

composerApiLanguage

string

dataModels

array of objects

dataModels

templates

array of objects

templates

outputBehaviors

array of objects

outputBehaviors

deliveryOptions

object

Delivery options on a solution request. On the unified Solution API only
ComposerOutputOptions (EMAIL or DOWNLOAD) and Email are
used. Email and Download are not mutually exclusive: an Email block is accepted with
either mode. The email Composer parameters may also be sent through solutionBehaviors;
when the same parameter arrives both ways, the deliveryOptions value wins and is stored once.

highVolumeDeliveryOptions

object

destinations

array of objects

destinations

customBrandingId

string

masterObject

Master object info: { id: "Account", name: "Account" }.
id = Object API name (stored in Salesforce APXTConga4__Master_Object_Type__c).
name = Display label (resolved from describe API on read, NOT stored).

sampleRecord

Sample record info: { id: "001XXXXXXXXXXXX", name: "Burlington Textiles Corp" }.
id = Salesforce record ID (maps to APXTConga4__Sample_Record_Id__c).
name = Record display name (maps to APXTConga4__Sample_Record_Name__c).

documentTemplates

array of objects

List of document template IDs to associate with the solution.
Max 40 templates per solution (Salesforce flow only).
Maps to: APXTConga4__Conga_Solution_Template__c junction records.

documentTemplates

templateMode

string

Template selection mode: "Fixed" (default) or "Dynamic". The two modes are mutually
exclusive — Fixed selects templates from DocumentTemplates (an empty list is
valid); Dynamic selects them by evaluating DynamicTemplate at button-click
time. Omitted on create defaults to "Fixed"; omitted on update preserves the stored mode.
Switching modes on update must be explicit: send templateMode to switch — supplying
only DynamicTemplate on a Fixed solution is rejected (400). A pre-existing
Apex Dynamic-Template-Selection solution (no stored mode plus a formula-valued
templateid parameter) reads back as "Dynamic". Salesforce solutions only; ignored by
the Platform flow.

dynamicTemplate

string

Dynamic merge-field/formula expression (e.g. "{!Opportunity.Template__c}") or a direct
template id/key list. Required when TemplateMode is "Dynamic"; must be
absent (or empty) when "Fixed". Persisted verbatim and emitted unencoded into the derived
button URL as a templateid parameter. Salesforce solutions only; ignored by the
Platform flow.

dataSources

array of objects

Canonical, type-aware list of data sources (CongaQuery / JsonDataModel / Webhook)
associated with the solution. This is the preferred field for both request and
response and maps 1:1 to the stored DataSourceItem document.
Max 100 data sources per solution.

dataSources

congaQueries

array of objects

DEPRECATED — legacy query-only shape. Still accepted on input (converted to
DataSources internally) and echoed on output for backward
compatibility. Prefer DataSources. Will be removed in a future release.
Maps to: APXTConga4__Conga_Solution_Query__c junction records.

congaQueries

solutionBehaviors

array of objects

List of solution behavior parameters supplied on input (id + value only).
Reference fields (name / category) are DERIVED on read and never accepted here.
Maps to: APXTConga4__Conga_Solution_Parameter__c child records.

solutionBehaviors

Responses

200

200 OK if successful, or 404 Not Found if the solution does not exist.

500