Chilkat Online Tools

PureBasic / DocuSign REST API / Updates an existing brand.

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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"
    ;   }
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"brandCompany","sample string 1")
    CkJsonObject::ckUpdateString(json,"brandId","sample string 2")
    CkJsonObject::ckUpdateString(json,"brandName","sample string 3")
    CkJsonObject::ckUpdateString(json,"isOverridingCompanyName","sample string 4")
    CkJsonObject::ckUpdateString(json,"isSendingDefault","sample string 5")
    CkJsonObject::ckUpdateString(json,"isSigningDefault","sample string 6")
    CkJsonObject::ckUpdateString(json,"links[0].linkType","sample string 1")
    CkJsonObject::ckUpdateString(json,"links[0].urlOrMailTo","sample string 2")
    CkJsonObject::ckUpdateString(json,"links[0].linkText","sample string 3")
    CkJsonObject::ckUpdateString(json,"links[0].showLink","sample string 4")
    CkJsonObject::ckUpdateString(json,"emailContent[0].emailContentType","sample string 1")
    CkJsonObject::ckUpdateString(json,"emailContent[0].content","sample string 2")
    CkJsonObject::ckUpdateString(json,"emailContent[0].emailToLink","sample string 3")
    CkJsonObject::ckUpdateString(json,"emailContent[0].linkText","sample string 4")
    CkJsonObject::ckUpdateString(json,"logos.primary","sample string 1")
    CkJsonObject::ckUpdateString(json,"logos.secondary","sample string 2")
    CkJsonObject::ckUpdateString(json,"logos.email","sample string 3")
    CkJsonObject::ckUpdateString(json,"resources.email","sample string 1")
    CkJsonObject::ckUpdateString(json,"resources.sending","sample string 2")
    CkJsonObject::ckUpdateString(json,"resources.signing","sample string 3")
    CkJsonObject::ckUpdateString(json,"resources.signingCaptive","sample string 4")

    ; Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttp::setCkAuthToken(http, "{{accessToken}}")
    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    sbRequestBody.i = CkStringBuilder::ckCreate()
    If sbRequestBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckEmitSb(json,sbRequestBody)

    resp.i = CkHttp::ckPTextSb(http,"PUT","https://domain.com/v2.1/accounts/{{accountId}}/brands/{{brandId}}",sbRequestBody,"utf-8","application/json",0,0)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbRequestBody)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)


    ProcedureReturn
EndProcedure

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": [
  ]
}