Chilkat Online Tools

Unicode C++ / Salesforce Platform APIs / Update Named Credential

Back to Collection Items

void ChilkatSample(void)
    {
    json.UpdateString(L"masterLabel",L"SamplePrivateLabel");    json.UpdateString(L"type",L"SecuredEndpoint");    json.UpdateString(L"calloutUrl",L"https://api.example.com");    json.UpdateString(L"externalCredentials[0].developerName",L"SampleExternalCredential");    json.UpdateString(L"customHeaders[0].headerName",L"SampleHeader");    json.UpdateString(L"customHeaders[0].headerValue",L"SampleValue");    json.UpdateInt(L"customHeaders[0].sequenceNumber",1);    json.UpdateBool(L"calloutOptions.allowMergeFieldsInBody",false);    json.UpdateBool(L"calloutOptions.allowMergeFieldsInHeader",true);    json.UpdateBool(L"calloutOptions.generateAuthorizationHeader",true);    http.put_AuthToken(L"<access_token>");    json.EmitSb(sbRequestBody);    success = http.HttpSb(L"PUT",L"https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME",sbRequestBody,L"utf-8",L"application/json",resp);    resp.GetBodySb(sbResponseBody);    jResp.LoadSb(sbResponseBody);    jResp.put_EmitCompact(false);    jResp.put_I(i);    headerName = jResp.stringOf(L"customHeaders[i].headerName");    headerValue = jResp.stringOf(L"customHeaders[i].headerValue");    id = jResp.stringOf(L"customHeaders[i].id");    sequenceNumber = jResp.IntOf(L"customHeaders[i].sequenceNumber");    i = i + 1;    i = 0;    count_i = jResp.SizeOfArray(L"externalCredentials");    jResp.put_I(i);    developerName = jResp.stringOf(L"externalCredentials[i].developerName");    id = jResp.stringOf(L"externalCredentials[i].id");    masterLabel = jResp.stringOf(L"externalCredentials[i].masterLabel");    url = jResp.stringOf(L"externalCredentials[i].url");    i = i + 1;    i = 0;    count_i = jResp.SizeOfArray(L"parameters");    jResp.put_I(i);    i = i + 1;
    }

Curl Command

curl -X PUT
	-H "Authorization: Bearer <access_token>"
	-d '{
   "masterLabel": "SamplePrivateLabel",
   "type": "SecuredEndpoint",
   "calloutUrl": "https://api.example.com",
   "externalCredentials": [
      {
         "developerName": "SampleExternalCredential"
      }
   ],
   "customHeaders": [
      {
         "headerName": "SampleHeader",
         "headerValue": "SampleValue",
         "sequenceNumber": 1
      }
   ],
   "calloutOptions": {
      "allowMergeFieldsInBody": false,
      "allowMergeFieldsInHeader": true,
      "generateAuthorizationHeader": true
   }
}'
https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME

Postman Collection Item JSON

{
  "name": "Update Named Credential",
  "request": {
    "method": "PUT",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n   \"masterLabel\": \"SamplePrivateLabel\",\n   \"type\": \"SecuredEndpoint\",\n   \"calloutUrl\": \"https://api.example.com\",\n   \"externalCredentials\": [\n      {\n         \"developerName\": \"SampleExternalCredential\"\n      }\n   ],\n   \"customHeaders\": [\n      {\n         \"headerName\": \"SampleHeader\",\n         \"headerValue\": \"SampleValue\",\n         \"sequenceNumber\": 1\n      }\n   ],\n   \"calloutOptions\": {\n      \"allowMergeFieldsInBody\": false,\n      \"allowMergeFieldsInHeader\": true,\n      \"generateAuthorizationHeader\": true\n   }\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "named-credentials",
        "named-credential-setup",
        ":DEVELOPER_NAME"
      ],
      "variable": [
        {
          "key": "DEVELOPER_NAME",
          "value": ""
        }
      ]
    },
    "description": "Update a named credential."
  },
  "response": [
    {
      "name": "Successful Update Named Credential",
      "originalRequest": {
        "method": "PUT",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n   \"masterLabel\": \"SamplePrivateLabel\",\n   \"type\": \"SecuredEndpoint\",\n   \"calloutUrl\": \"https://api.example.com\",\n   \"externalCredentials\": [\n      {\n         \"developerName\": \"SampleExternalCredential\"\n      }\n   ],\n   \"customHeaders\": [\n      {\n         \"headerName\": \"SampleHeader\",\n         \"headerValue\": \"SampleValue\",\n         \"sequenceNumber\": 1\n      }\n   ],\n   \"calloutOptions\": {\n      \"allowMergeFieldsInBody\": false,\n      \"allowMergeFieldsInHeader\": true,\n      \"generateAuthorizationHeader\": true\n   }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "named-credentials",
            "named-credential-setup",
            ":DEVELOPER_NAME"
          ],
          "variable": [
            {
              "key": "DEVELOPER_NAME",
              "value": "SamplePrivate"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 20 Nov 2023 16:54:57 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-XSS-Protection",
          "value": "1; mode=block"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"calloutOptions\": {\n        \"allowMergeFieldsInBody\": false,\n        \"allowMergeFieldsInHeader\": true,\n        \"generateAuthorizationHeader\": true\n    },\n    \"calloutUrl\": \"https://api.example.com\",\n    \"customHeaders\": [\n        {\n            \"headerName\": \"SampleHeader\",\n            \"headerValue\": \"SampleValue\",\n            \"id\": \"0pv2o000000PAv6AAG\",\n            \"sequenceNumber\": 1\n        }\n    ],\n    \"developerName\": \"SamplePrivate\",\n    \"externalCredentials\": [\n        {\n            \"developerName\": \"SampleExternalCredential\",\n            \"id\": \"0pt2o000000CaU0AAK\",\n            \"masterLabel\": \"Sample External Credential\",\n            \"url\": \"/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential\"\n        }\n    ],\n    \"id\": \"0XA2o000000XaAQGA0\",\n    \"masterLabel\": \"SamplePrivateLabel\",\n    \"parameters\": [],\n    \"type\": \"SecuredEndpoint\",\n    \"url\": \"/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate\"\n}"
    }
  ]
}