Release Notes Release Resources General Developer Hub

general

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.

general

chevron_left

general Contents

Features by Release

Conga Upgrade Program

System Requirements and Supported Platforms Matrix

Managed Packages Dependency Matrix

Conga Applications in Salesforce Lightning

Salesforce Multi-Factor Authentication Support for Conga Commerce

Conga Product Glossary

Conga Upgrade Assistant

Product Retirement Schedule

Developer Center

Approvals for Salesforce REST APIs

Billing for Salesforce REST APIs

CLM for Salesforce REST APIs

CPQ for Salesforce REST APIs

Digital Commerce for Salesforce REST APIs

Discovery AI for Salesforce REST APIs

Orchestrate REST APIs

TurboEngines REST APIs

download

Amend Asset

post

/assets/{cartId}/amendAsset

Invoke this API for changing the configuration of assets.

Request

Security: Basic Auth

Path Parameters

cartId

string

required

The reference to the cart Id for the current active cart

Example:

a1I3I000000e7GLUAY

Headers

Content-Type

string

required

Content type of the request body.

Example:

application/json

x-storefront

string

required

The name of the storefront used for the request.

Example:

ECommerce

Body

assetIds

array[string]

Responses

200

Body

responses

200

data

object

Auth

Username

Password

Parameters

Body

{
  "assetIds": [
    "a0e23000000esYBAAY"
  ]
}

1
{
2
  "assetIds": [
3
    "a0e23000000esYBAAY"
4
  ]
5
}

curl --request POST \
  --url https://documentation.conga.com/assets/cartId/amendAsset \
  --header 'Accept: application/json' \
  --header 'Authorization: Basic 123' \
  --header 'Content-Type: application/json' \
  --header 'x-storefront: ' \
  --data '{
  "assetIds": [
    "a0e23000000esYBAAY"
  ]
}'

Response Example

1
{
2
  "title": "success",
3
  "status": 200,
4
  "data": {
5
    "a0e23000000esYBAAY": {
6
      "attributes": {
7
        "type": "Apttus_Config2__LineItem__c",
8
        "url": "/services/data/v53.0/sobjects/Apttus_Config2__LineItem__c/a1301000000BuurAAC"
9
      },
10
      "Apttus_Config2__ConfigurationId__c": "a1I01000000C2vvEAC",
11
      "Apttus_Config2__BaseProductId__c": null,
12
      "Apttus_Config2__HasBaseProduct__c": false,
13
      "Apttus_Config2__LocationId__c": null,
14
      "Apttus_Config2__Uom__c": "Each",
15
      "Apttus_Config2__Quantity__c": 1,
16
      "Apttus_Config2__Term__c": 1,
17
      "Apttus_Config2__SellingTerm__c": 1,
18
      "Apttus_Config2__ProductId__c": "01t1T000005BXo0QAG",
19
      "Apttus_Config2__PriceListId__c": "a171T000005il1XQAQ",
20
      "Apttus_Config2__LineType__c": "Product/Service",
21
      "Apttus_Config2__LineNumber__c": 2,
22
      "Apttus_Config2__LineSequence__c": 2,
23
      "Apttus_Config2__PrimaryLineNumber__c": 2,
24
      "Apttus_Config2__ItemSequence__c": 1,
25
      "Apttus_Config2__OptionSequence__c": 0,
26
      "Apttus_Config2__IsQuantityModifiable__c": true,
27
      "Apttus_Config2__IsPrimaryLine__c": true,
28
      "Apttus_Config2__ProductVersion__c": 1,
29
      "Apttus_Config2__Comments__c": null,
30
      "Apttus_Config2__AdjustmentAmount__c": null,
31
      "Apttus_Config2__AdjustmentType__c": null,
32
      "Apttus_Config2__AssetLineItemId__c": "a0e23000000esYBAAY",
33
      "Apttus_Config2__Description__c": "Basic Launch Pack",
34
      "Apttus_Config2__Customizable__c": false,
35
      "Apttus_Config2__PricingStatus__c": "Pending",
36
      "Apttus_Config2__ConfigStatus__c": "NA",
37
      "Apttus_Config2__ConstraintCheckStatus__c": "NA",
38
      "Apttus_Config2__AllowManualAdjustment__c": true,
39
      "Apttus_Config2__HasAttributes__c": false,
40
      "Apttus_Config2__HasDefaults__c": false,
41
      "Apttus_Config2__HasOptions__c": false,
42
      "Apttus_Config2__BillingPreferenceId__r": {
43
        "attributes": {
44
          "type": "Apttus_Config2__BillingPreference__c",
45
          "url": "/services/data/v53.0/sobjects/Apttus_Config2__BillingPreference__c/a2d19000001VUE4AAO"
46
        },
47
        "Id": "a2d19000001VUE4AAO",
48
        "Apttus_Config2__BillingCycleStart__c": "Ready for Billing Date",
49
        "Apttus_Config2__BillingDayOfMonth2__c": "1st of the Month"
50
      },
51
      "Apttus_Config2__BillToAccountId__r": {
52
        "attributes": {
53
          "type": "Account",
54
          "url": "/services/data/v53.0/sobjects/Account/0015000000Fn6m0AAB"
55
        },
56
        "Id": "0015000000Fn6m0AAB"
57
      },
58
      "Apttus_Config2__AssetLineItemId__r": {
59
        "attributes": {
60
          "type": "Apttus_Config2__AssetLineItem__c",
61
          "url": "/services/data/v53.0/sobjects/Apttus_Config2__AssetLineItem__c/a0e23000000esYBAAY"
62
        },
63
        "Id": "a0e23000000esYBAAY",
64
        "Apttus_Config2__OriginalStartDate__c": "2019-11-18"
65
      },
66
      "Apttus_Config2__AssetQuantity__c": 1,
67
      "Apttus_Config2__AutoRenewalTerm__c": null,
68
      "Apttus_Config2__AdjustedPrice__c": 100,
69
      "Apttus_Config2__BaseExtendedCost__c": 0,
70
      "Apttus_Config2__BaseExtendedPrice__c": 100,
71
      "Apttus_Config2__BasePriceMethod__c": "Per Unit",
72
      "Apttus_Config2__BasePrice__c": 100,
73
      "Apttus_Config2__ChargeType__c": "Standard Price",
74
      "Apttus_Config2__EndDate__c": "2019-11-30",
75
      "Apttus_Config2__ExtendedCost__c": 0,
76
      "Apttus_Config2__ExtendedPrice__c": 100,
77
      "Apttus_Config2__Frequency__c": "One Time",
78
      "Apttus_Config2__IsOptionRollupLine__c": false,
79
      "Apttus_Config2__IsUsageTierModifiable__c": false,
80
      "Apttus_Config2__ListPrice__c": 100,
81
      "Apttus_Config2__NetPrice__c": 100,
82
      "Apttus_Config2__PriceIncludedInBundle__c": false,
83
      "Apttus_Config2__PriceListItemId__c": "a161900000K9cUVAAZ",
84
      "Apttus_Config2__PriceMethod__c": "Per Unit",
85
      "Apttus_Config2__PriceType__c": "One Time",
86
      "Apttus_Config2__PriceUom__c": "Each",
87
      "Apttus_Config2__SellingFrequency__c": "One Time",
88
      "Apttus_Config2__StartDate__c": "2019-11-18",
89
      "Apttus_Config2__IsPrimaryRampLine__c": false,
90
      "Apttus_Config2__BillToAccountId__c": "0015000000Fn6m0AAB",
91
      "Apttus_Config2__BillingFrequency__c": "One Time",
92
      "Apttus_Config2__BillingPreferenceId__c": "a2d19000001VUE4AAO",
93
      "Apttus_Config2__BillingRule__c": "Bill In Advance",
94
      "Apttus_Config2__HideInvoiceDisplay__c": false,
95
      "Apttus_Config2__IsReadOnly__c": false,
96
      "Apttus_Config2__ShipToAccountId__c": "0015000000Fn6m0AAB",
97
      "Apttus_Config2__TaxInclusive__c": false,
98
      "Apttus_Config2__Taxable__c": false,
99
      "Apttus_Config2__AutoRenew__c": false,
100
      "Apttus_Config2__DeltaQuantity__c": 1,
101
      "Apttus_Config2__NetUnitPrice__c": 100,
102
      "Apttus_Config2__SellingUom__c": "Each",
103
      "Apttus_Config2__LineStatus__c": "Amended",
104
      "Apttus_Config2__AttributeValueId__c": null,
105
      "Id": "a1301000000BuurAAC"
106
    }
107
  }
108
}

chevron_right

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.

Amend Asset

Request

Path Parameters

Headers

Body

Responses

Body

Footer Section

Explore