home
Release NotesRelease ResourcesGeneralDeveloper Hub

general

Adobe Sign ServicesAdvantage Platform AdministrationApprovals for Advantage PlatformApprovals for SalesforceBilling for Advantage PlatformBilling for SalesforceCLM for Advantage PlatformCLM for SalesforceContracts for SalesforceCollaborateComposer for Advantage PlatformComposer for SalesforceContractsConga for Google DocsConga Upgrade ProgramContract Intelligence (Standalone)CPQ for Advantage PlatformCPQ for SalesforceDeal MaximizerDigital Commerce for Advantage PlatformDigital Commerce for SalesforceDiscovery AI for Advantage PlatformDiscovery AI for SalesforceDocusign ServiceseSignature Integration with Advantage PlatformGridInvoice GenerationMix FormsOrchestrateOrder Management for Advantage PlatformOrder Management for SalesforcePartner Commerce for Advantage PlatformPartner Commerce for SalesforceQuote GenerationSign for Advantage PlatformSign for SalesforceSmart SearchTurboEnginesX-Author for Contracts 1.0 (Classic)X-Author for ContractsX-Author for Contracts Advanced for Advantage PlatformX-Author for Contracts Advanced for SalesforceX-Author for ExcelX-Author for Migration ManagerRelease NotesGeneral
search
search
Adobe Sign ServicesAdvantage Platform AdministrationApprovals for Advantage PlatformApprovals for SalesforceBilling for Advantage PlatformBilling for SalesforceCLM for Advantage PlatformCLM for SalesforceContracts for SalesforceCollaborateComposer for Advantage PlatformComposer for SalesforceContractsConga for Google DocsConga Upgrade ProgramContract Intelligence (Standalone)CPQ for Advantage PlatformCPQ for SalesforceDeal MaximizerDigital Commerce for Advantage PlatformDigital Commerce for SalesforceDiscovery AI for Advantage PlatformDiscovery AI for SalesforceDocusign ServiceseSignature Integration with Advantage PlatformGridInvoice GenerationMix FormsOrchestrateOrder Management for Advantage PlatformOrder Management for SalesforcePartner Commerce for Advantage PlatformPartner Commerce for SalesforceQuote GenerationSign for Advantage PlatformSign for SalesforceSmart SearchTurboEnginesX-Author for Contracts 1.0 (Classic)X-Author for ContractsX-Author for Contracts Advanced for Advantage PlatformX-Author for Contracts Advanced for SalesforceX-Author for ExcelX-Author for Migration ManagerRelease NotesGeneral

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

search

general

chevron_left

general Contents

close

  • Features by Release

  • Conga Upgrade Program

  • chevron_right

    System Requirements and Supported Platforms Matrix

  • Managed Packages Dependency Matrix

  • Conga Applications in Salesforce Lightning

  • Salesforce Multi-Factor Authentication Support for Conga Commerce

  • chevron_right

    Conga Product Glossary

  • chevron_right

    Conga Upgrade Assistant

  • chevron_right

    Product Retirement Schedule

  • expand_more

    Developer Center

    • chevron_right

      Approvals for Salesforce REST APIs

    • chevron_right

      Billing for Salesforce REST APIs

    • chevron_right

      CLM for Salesforce REST APIs

    • expand_more

      CPQ for Salesforce REST APIs

      • expand_more

        CPQ Asset-Based Ordering APIs

        • expand_more

          Assets

          • Swap Assets

            post

          • Terminate Assets

            post

          • Suspend Assets

            post

          • Resume Assets

            post

          • Change Assets

            post
      • chevron_right

        Service CPQ APIs

    • chevron_right

      Digital Commerce for Salesforce REST APIs

    • chevron_right

      Discovery AI for Salesforce REST APIs

    • chevron_right

      Orchestrate REST APIs

    • chevron_right

      Partner Commerce for Salesforce REST APIs

    • chevron_right

      TurboEngines REST APIs

    list_altShow Contents

    chevron_left

    General

    Assets

    chevron_right
    download

    Change Assets

    post
    /services/apexrest/Apttus_WebStore/apttus/v1/assets/{assetId}/change

    Invoke this API for changing the parameters of an asset, associated configuration, and related details.

    When you update a bundle attribute using the Change API, it cascades the updates to a maximum of six level of child options in sub-bundles. This works when you have set the Cascade Shared Attribute Updates setting to True in Config System Properties.

    Request

    Security: Basic Auth

    Path Parameters

    assetId
    string
    required

    The Id of the asset that needs to be changed

    Example:
    a0e3I000000ERLmQAO

    Headers

    Authorization
    string
    required

    authentication token

    Example:
    00DG0000000iqtB!ARUAQHofFrVurFKWS8TcFKmhFM1yiA1VBzEVVAOXDB.5r_rlpxXuj53RnqfY2QKUgsL3N.ge5kmSPN5UcHK9iHckog6eTw.4
    Content-Type
    string
    required

    Content type of the request body.

    Example:
    application/json
    x-storefront
    string
    required

    The name of the storefront being used for the request.

    Example:
    ECommerce

    Body

    Note: Step Property in request body indicates which step to be run. Possible values CHANGE_ASSET, VALIDATE, RUN_CONSTRAINTS, REPRICE.

    ProductAttributeValues
    array[object]
    Step
    string
    SelectedOptions
    array[string]
    CartId
    string
    CancelledOptions
    array[string]
    AmendedAssets
    array[string]

    Responses

    200
    500

    OK

    Body

    responses
    /
    200
    data
    object
    pageErrors
    string
    nextStep
    number
    hasError
    boolean
    Auth
    Username
    :
    Password
    :
    Parameters
    :
    :
    :
    :
    Body
    1
    {
    2
      "ProductAttributeValues": [
    3
        {
    4
          "AssetId": null,
    5
          "AttributeValueExt3SO": {
    6
            "attributes": {
    7
              "type": "Apttus_Config2__ProductAttributeValueExt3__c"
    8
            },
    9
            "TestPAVExt3Field__c": "fieldValue",
    10
            "TestPAVExt3Field2__c": "fieldValue2"
    11
          },
    12
          "AttributeValueExt2SO": {
    13
            "attributes": {
    14
              "type": "Apttus_Config2__ProductAttributeValueExt2__c"
    15
            },
    16
            "TestPAVExt2Field__c": "fieldValue",
    17
            "TestPAVExt2Field2__c": "fieldValue2"
    18
          },
    19
          "AttributeValueExtSO": {
    20
            "attributes": {
    21
              "type": "Apttus_Config2__ProductAttributeValueExt__c"
    22
            },
    23
            "TestPAVExtField__c": "fieldValue",
    24
            "TestPAVExtField2__c": "fieldValue2"
    25
          },
    26
          "AttributeValueSO": {
    27
            "attributes": {
    28
              "type": "Apttus_Config2__ProductAttributeValue__c"
    29
            },
    30
            "Apttus_Config2__Age__c": "10",
    31
            "Apttus_Config2__Vendor__c": "Vendor 1"
    32
          },
    33
          "NullFields": {
    34
            "Apttus_Config2__ProductAttributeValue__c": [
    35
              "Apttus_Config2__Color__c",
    36
              "Field1__c"
    37
            ],
    38
            "Apttus_Config2__ProductAttributeValueExt__c": [
    39
              "fieldExt1__c"
    40
            ],
    41
            "Apttus_Config2__ProductAttributeValueExt2__c": [
    42
              "fieldExt2__c"
    43
            ],
    44
            "Apttus_Config2__ProductAttributeValueExt3__c": [
    45
              "fieldExt3__c"
    46
            ]
    47
          }
    48
        }
    49
      ],
    50
      "Step": "CHANGE_ASSET",
    51
      "SelectedOptions": [
    52
        {
    53
          "StartDate": "2020-10-16",
    54
          "SellingTerm": 12,
    55
          "Quantity": 3,
    56
          "EndDate": "2020-11-14",
    57
          "CustomFields": [
    58
            "LineItem_Custom_field1__c",
    59
            "LineItem_Custom_field2__c"
    60
          ],
    61
          "CustomData": {
    62
            "attributes": {
    63
              "type": "Apttus_Config2__LineItem__c"
    64
            },
    65
            "LineItem_Custom_field1__c": "value1",
    66
            "LineItem_Custom_field2__c": "value2"
    67
          },
    68
          "ComponentProductId": "01t1I000000imxpQAA",
    69
          "ComponentId": "a0z1I000005dSnrQAE",
    70
          "Comments": "description",
    71
          "AttributeValues": [
    72
            {
    73
              "attributes": {
    74
                "type": "Apttus_Config2__ProductAttributeValue__c"
    75
              },
    76
              "IsBundle__c": true
    77
            }
    78
          ]
    79
        }
    80
      ],
    81
      "CartId": "a0p1I000009KLLUQA4",
    82
      "CancelledOptions": [
    83
        "a0p1I000009KLLUQA4"
    84
      ],
    85
      "AmendedAssets": [
    86
        {
    87
          "attributes": {
    88
            "type": "Apttus_Config2__LineItem__c"
    89
          },
    90
          "Apttus_Config2__Quantity__c": 3,
    91
          "LineItemCustomField__C": "value"
    92
        }
    93
      ],
    94
      "NullFields": {
    95
        "AssetId1": [
    96
          "Apttus_Config2__BillingPreferenceId__c",
    97
          "Apttus_Config2__ShipToAccountId__c"
    98
        ],
    99
        "AssetId2": [
    100
          "Apttus_Config2__ShipToAccountId__c"
    101
        ]
    102
      }
    103
    }
    curl --request POST \
      --url https://documentation.conga.com/services/apexrest/Apttus_WebStore/apttus/v1/assets/assetId/change \
      --header 'Accept: application/json' \
      --header 'Authorization: Basic 123' \
      --header 'Content-Type: application/json' \
      --header 'x-storefront: ' \
      --data '{
      "ProductAttributeValues": [
        {
          "AssetId": null,
          "AttributeValueExt3SO": {
            "attributes": {
              "type": "Apttus_Config2__ProductAttributeValueExt3__c"
            },
            "TestPAVExt3Field__c": "fieldValue",
            "TestPAVExt3Field2__c": "fieldValue2"
          },
          "AttributeValueExt2SO": {
            "attributes": {
              "type": "Apttus_Config2__ProductAttributeValueExt2__c"
            },
            "TestPAVExt2Field__c": "fieldValue",
            "TestPAVExt2Field2__c": "fieldValue2"
          },
          "AttributeValueExtSO": {
            "attributes": {
              "type": "Apttus_Config2__ProductAttributeValueExt__c"
            },
            "TestPAVExtField__c": "fieldValue",
            "TestPAVExtField2__c": "fieldValue2"
          },
          "AttributeValueSO": {
            "attributes": {
              "type": "Apttus_Config2__ProductAttributeValue__c"
            },
            "Apttus_Config2__Age__c": "10",
            "Apttus_Config2__Vendor__c": "Vendor 1"
          },
          "NullFields": {
            "Apttus_Config2__ProductAttributeValue__c": [
              "Apttus_Config2__Color__c",
              "Field1__c"
            ],
            "Apttus_Config2__ProductAttributeValueExt__c": [
              "fieldExt1__c"
            ],
            "Apttus_Config2__ProductAttributeValueExt2__c": [
              "fieldExt2__c"
            ],
            "Apttus_Config2__ProductAttributeValueExt3__c": [
              "fieldExt3__c"
            ]
          }
        }
      ],
      "Step": "CHANGE_ASSET",
      "SelectedOptions": [
        {
          "StartDate": "2020-10-16",
          "SellingTerm": 12,
          "Quantity": 3,
          "EndDate": "2020-11-14",
          "CustomFields": [
            "LineItem_Custom_field1__c",
            "LineItem_Custom_field2__c"
          ],
          "CustomData": {
            "attributes": {
              "type": "Apttus_Config2__LineItem__c"
            },
            "LineItem_Custom_field1__c": "value1",
            "LineItem_Custom_field2__c": "value2"
          },
          "ComponentProductId": "01t1I000000imxpQAA",
          "ComponentId": "a0z1I000005dSnrQAE",
          "Comments": "description",
          "AttributeValues": [
            {
              "attributes": {
                "type": "Apttus_Config2__ProductAttributeValue__c"
              },
              "IsBundle__c": true
            }
          ]
        }
      ],
      "CartId": "a0p1I000009KLLUQA4",
      "CancelledOptions": [
        "a0p1I000009KLLUQA4"
      ],
      "AmendedAssets": [
        {
          "attributes": {
            "type": "Apttus_Config2__LineItem__c"
          },
          "Apttus_Config2__Quantity__c": 3,
          "LineItemCustomField__C": "value"
        }
      ],
      "NullFields": {
        "AssetId1": [
          "Apttus_Config2__BillingPreferenceId__c",
          "Apttus_Config2__ShipToAccountId__c"
        ],
        "AssetId2": [
          "Apttus_Config2__ShipToAccountId__c"
        ]
      }
    }'
    Response Example
    1
    {
    2
      "title": "success",
    3
      "status": 200,
    4
      "data": {
    5
        "pageErrors": {
    6
          "warningMessages": [],
    7
          "successMessages": [],
    8
          "pricingResponse": {
    9
            "PendingLineNumbers": [],
    10
            "IsTotalPricePending": false,
    11
            "IsPricePending": false,
    12
            "IsPrePricePending": false,
    13
            "IsPostPricePending": false,
    14
            "ErrorLineNumbers": [],
    15
            "CompletedLineNumbers": []
    16
          },
    17
          "infoMessages": [],
    18
          "errorMessages": [],
    19
          "constraintResult": {
    20
            "NeedMoreProcessing": false,
    21
            "HasPendingWarning": false,
    22
            "HasPendingError": false,
    23
            "ConstraintRuleActions": [],
    24
            "CartId": null
    25
          }
    26
        },
    27
        "nextStep": "VALIDATE",
    28
        "hasError": false
    29
      }
    30
    }
    chevron_leftchevron_right
    chevron_right

    Footer Section

    Explore


    Conga.com
    Legal
    Feedback
    Contact Support

    Copyright © 2025 Conga Corporation • All Rights Reserved

    Cookie Notice

    We use cookies to improve your experience on our site. To find out more, read our cookie policy.