Chilkat Online Tools

Foxpro / DocuSign REST API / Updates an existing brand.

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp

* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
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.

* {
*   "brandCompany": "sample string 1",
*   "brandId": "sample string 2",
*   "brandName": "sample string 3",
*   "colors": [
*     {}
*   ],
*   "isOverridingCompanyName": "sample string 4",
*   "isSendingDefault": "sample string 5",
*   "isSigningDefault": "sample string 6",
*   "landingPages": [
*     {}
*   ],
*   "links": [
*     {
*       "linkType": "sample string 1",
*       "urlOrMailTo": "sample string 2",
*       "linkText": "sample string 3",
*       "showLink": "sample string 4"
*     }
*   ],
*   "emailContent": [
*     {
*       "emailContentType": "sample string 1",
*       "content": "sample string 2",
*       "emailToLink": "sample string 3",
*       "linkText": "sample string 4"
*     }
*   ],
*   "logos": {
*     "primary": "sample string 1",
*     "secondary": "sample string 2",
*     "email": "sample string 3"
*   },
*   "resources": {
*     "email": "sample string 1",
*     "sending": "sample string 2",
*     "signing": "sample string 3",
*     "signingCaptive": "sample string 4"
*   }
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("brandCompany","sample string 1")
loJson.UpdateString("brandId","sample string 2")
loJson.UpdateString("brandName","sample string 3")
loJson.UpdateString("isOverridingCompanyName","sample string 4")
loJson.UpdateString("isSendingDefault","sample string 5")
loJson.UpdateString("isSigningDefault","sample string 6")
loJson.UpdateString("links[0].linkType","sample string 1")
loJson.UpdateString("links[0].urlOrMailTo","sample string 2")
loJson.UpdateString("links[0].linkText","sample string 3")
loJson.UpdateString("links[0].showLink","sample string 4")
loJson.UpdateString("emailContent[0].emailContentType","sample string 1")
loJson.UpdateString("emailContent[0].content","sample string 2")
loJson.UpdateString("emailContent[0].emailToLink","sample string 3")
loJson.UpdateString("emailContent[0].linkText","sample string 4")
loJson.UpdateString("logos.primary","sample string 1")
loJson.UpdateString("logos.secondary","sample string 2")
loJson.UpdateString("logos.email","sample string 3")
loJson.UpdateString("resources.email","sample string 1")
loJson.UpdateString("resources.sending","sample string 2")
loJson.UpdateString("resources.signing","sample string 3")
loJson.UpdateString("resources.signingCaptive","sample string 4")

* Adds the "Authorization: Bearer {{accessToken}}" header.
loHttp.AuthToken = "{{accessToken}}"
loHttp.SetRequestHeader("Accept","application/json")

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("PUT","https://domain.com/v2.1/accounts/{{accountId}}/brands/{{brandId}}",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "brandCompany": "sample string 1",
  "brandId": "sample string 2",
  "brandName": "sample string 3",
  "colors": [
    {}
  ],
  "isOverridingCompanyName": "sample string 4",
  "isSendingDefault": "sample string 5",
  "isSigningDefault": "sample string 6",
  "landingPages": [
    {}
  ],
  "links": [
    {
      "linkType": "sample string 1",
      "urlOrMailTo": "sample string 2",
      "linkText": "sample string 3",
      "showLink": "sample string 4"
    }
  ],
  "emailContent": [
    {
      "emailContentType": "sample string 1",
      "content": "sample string 2",
      "emailToLink": "sample string 3",
      "linkText": "sample string 4"
    }
  ],
  "logos": {
    "primary": "sample string 1",
    "secondary": "sample string 2",
    "email": "sample string 3"
  },
  "resources": {
    "email": "sample string 1",
    "sending": "sample string 2",
    "signing": "sample string 3",
    "signingCaptive": "sample string 4"
  }
}'
https://domain.com/v2.1/accounts/{{accountId}}/brands/{{brandId}}

Postman Collection Item JSON

{
  "name": "Updates an existing brand.",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"brandCompany\": \"sample string 1\",\n  \"brandId\": \"sample string 2\",\n  \"brandName\": \"sample string 3\",\n  \"colors\": [\n    {}\n  ],\n  \"isOverridingCompanyName\": \"sample string 4\",\n  \"isSendingDefault\": \"sample string 5\",\n  \"isSigningDefault\": \"sample string 6\",\n  \"landingPages\": [\n    {}\n  ],\n  \"links\": [\n    {\n      \"linkType\": \"sample string 1\",\n      \"urlOrMailTo\": \"sample string 2\",\n      \"linkText\": \"sample string 3\",\n      \"showLink\": \"sample string 4\"\n    }\n  ],\n  \"emailContent\": [\n    {\n      \"emailContentType\": \"sample string 1\",\n      \"content\": \"sample string 2\",\n      \"emailToLink\": \"sample string 3\",\n      \"linkText\": \"sample string 4\"\n    }\n  ],\n  \"logos\": {\n    \"primary\": \"sample string 1\",\n    \"secondary\": \"sample string 2\",\n    \"email\": \"sample string 3\"\n  },\n  \"resources\": {\n    \"email\": \"sample string 1\",\n    \"sending\": \"sample string 2\",\n    \"signing\": \"sample string 3\",\n    \"signingCaptive\": \"sample string 4\"\n  }\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/brands/{{brandId}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "brands",
        "{{brandId}}"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "brandId",
          "value": "{{brandId}}"
        }
      ]
    }
  },
  "response": [
  ]
}