Chilkat Online Tools

Ruby / DocuSign REST API / Create a Workspace

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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 = Chilkat::CkJsonObject.new()
json.UpdateString("workspaceName","sample string 1")
json.UpdateString("workspaceDescription","sample string 2")
json.UpdateString("status","sample string 3")

# Adds the "Authorization: Bearer {{accessToken}}" header.
http.put_AuthToken("{{accessToken}}")
http.SetRequestHeader("Accept","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/v2.1/accounts/{{accountId}}/workspaces","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X POST
	-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

Postman Collection Item JSON

{
  "name": "Create a Workspace",
  "request": {
    "method": "POST",
    "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",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "workspaces"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    },
    "description": "Creates a new workspace."
  },
  "response": [
  ]
}