Chilkat Online Tools

delphiDll / DocuSign REST API / Update Workspace

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;

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

http := CkHttp_Create();

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "workspaceName": "sample string 1",
//   "workspaceDescription": "sample string 2",
//   "status": "sample string 3"
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'workspaceName','sample string 1');
CkJsonObject_UpdateString(json,'workspaceDescription','sample string 2');
CkJsonObject_UpdateString(json,'status','sample string 3');

// Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_putAuthToken(http,'{{accessToken}}');
CkHttp_SetRequestHeader(http,'Accept','application/json');

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

resp := CkHttp_PTextSb(http,'PUT','https://domain.com/v2.1/accounts/{{accountId}}/workspaces/{{workspaceId}}',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(json);
CkStringBuilder_Dispose(sbRequestBody);

Curl Command

curl -X PUT
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "workspaceName": "sample string 1",
  "workspaceDescription": "sample string 2",
  "status": "sample string 3"
}'
https://domain.com/v2.1/accounts/{{accountId}}/workspaces/{{workspaceId}}

Postman Collection Item JSON

{
  "name": "Update Workspace",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"workspaceName\": \"sample string 1\",\n  \"workspaceDescription\": \"sample string 2\",\n  \"status\": \"sample string 3\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/workspaces/{{workspaceId}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "workspaces",
        "{{workspaceId}}"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "workspaceId",
          "value": "{{workspaceId}}"
        }
      ]
    },
    "description": "Updates information about a specific workspace."
  },
  "response": [
  ]
}