Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcHeaderName
LOCAL lcHeaderValue
LOCAL lnSequenceNumber
LOCAL lnAllowMergeFieldsInBody
LOCAL lnAllowMergeFieldsInHeader
LOCAL lnGenerateAuthorizationHeader
LOCAL lcCalloutUrl
LOCAL lcDeveloperName
LOCAL lcId
LOCAL lcMasterLabel
LOCAL lcV_type
LOCAL lcUrl
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat.Http')
* Use this online tool to generate code from sample JSON: Generate Code to Create JSON
* The following JSON is sent in the request body.
* {
* "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
* }
* }
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("masterLabel","SamplePrivateLabel")
loJson.UpdateString("type","SecuredEndpoint")
loJson.UpdateString("calloutUrl","https://api.example.com")
loJson.UpdateString("externalCredentials[0].developerName","SampleExternalCredential")
loJson.UpdateString("customHeaders[0].headerName","SampleHeader")
loJson.UpdateString("customHeaders[0].headerValue","SampleValue")
loJson.UpdateInt("customHeaders[0].sequenceNumber",1)
loJson.UpdateBool("calloutOptions.allowMergeFieldsInBody",0)
loJson.UpdateBool("calloutOptions.allowMergeFieldsInHeader",1)
loJson.UpdateBool("calloutOptions.generateAuthorizationHeader",1)
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)
loResp = CreateObject('Chilkat.HttpResponse')
lnSuccess = loHttp.HttpSb("PUT","https://domain.com/services/data/v{{version}}/named-credentials/named-credential-setup/:DEVELOPER_NAME",loSbRequestBody,"utf-8","application/json",loResp)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loResp
CANCEL
ENDIF
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loResp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* Sample JSON response:
* (Sample code for parsing the JSON response is shown below)
* {
* "calloutOptions": {
* "allowMergeFieldsInBody": false,
* "allowMergeFieldsInHeader": true,
* "generateAuthorizationHeader": true
* },
* "calloutUrl": "https://api.example.com",
* "customHeaders": [
* {
* "headerName": "SampleHeader",
* "headerValue": "SampleValue",
* "id": "0pv2o000000PAv6AAG",
* "sequenceNumber": 1
* }
* ],
* "developerName": "SamplePrivate",
* "externalCredentials": [
* {
* "developerName": "SampleExternalCredential",
* "id": "0pt2o000000CaU0AAK",
* "masterLabel": "Sample External Credential",
* "url": "/services/data/v58.0/named-credentials/external-credentials/SampleExternalCredential"
* }
* ],
* "id": "0XA2o000000XaAQGA0",
* "masterLabel": "SamplePrivateLabel",
* "parameters": [
* ],
* "type": "SecuredEndpoint",
* "url": "/services/data/v58.0/named-credentials/named-credential-setup/SamplePrivate"
* }
* Sample code for parsing the JSON response...
* Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lnAllowMergeFieldsInBody = loJResp.BoolOf("calloutOptions.allowMergeFieldsInBody")
lnAllowMergeFieldsInHeader = loJResp.BoolOf("calloutOptions.allowMergeFieldsInHeader")
lnGenerateAuthorizationHeader = loJResp.BoolOf("calloutOptions.generateAuthorizationHeader")
lcCalloutUrl = loJResp.StringOf("calloutUrl")
lcDeveloperName = loJResp.StringOf("developerName")
lcId = loJResp.StringOf("id")
lcMasterLabel = loJResp.StringOf("masterLabel")
lcV_type = loJResp.StringOf("type")
lcUrl = loJResp.StringOf("url")
i = 0
lnCount_i = loJResp.SizeOfArray("customHeaders")
DO WHILE i < lnCount_i
loJResp.I = i
lcHeaderName = loJResp.StringOf("customHeaders[i].headerName")
lcHeaderValue = loJResp.StringOf("customHeaders[i].headerValue")
lcId = loJResp.StringOf("customHeaders[i].id")
lnSequenceNumber = loJResp.IntOf("customHeaders[i].sequenceNumber")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("externalCredentials")
DO WHILE i < lnCount_i
loJResp.I = i
lcDeveloperName = loJResp.StringOf("externalCredentials[i].developerName")
lcId = loJResp.StringOf("externalCredentials[i].id")
lcMasterLabel = loJResp.StringOf("externalCredentials[i].masterLabel")
lcUrl = loJResp.StringOf("externalCredentials[i].url")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("parameters")
DO WHILE i < lnCount_i
loJResp.I = i
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody
RELEASE loResp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
