Chilkat Online Tools

lianja / Support API / Delete Custom Object Field

Back to Collection Items

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

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "login"
loHttp.Password = "password"

loResp = loHttp.QuickRequest("DELETE","https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id")
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp

Curl Command

curl  -u login:password -X DELETE
https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id

Postman Collection Item JSON

{
  "name": "Delete Custom Object Field",
  "request": {
    "method": "DELETE",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_objects",
        ":custom_object_key",
        "fields",
        ":custom_object_field_key_or_id"
      ],
      "variable": [
        {
          "key": "custom_object_key",
          "value": "<string>"
        },
        {
          "key": "custom_object_field_key_or_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Deletes a field with the specified key.\n#### Allowed For\n* Admins"
  },
  "response": [
    {
      "name": "No content response",
      "originalRequest": {
        "method": "DELETE",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_objects",
            ":custom_object_key",
            "fields",
            ":custom_object_field_key_or_id"
          ],
          "variable": [
            {
              "key": "custom_object_key"
            },
            {
              "key": "custom_object_field_key_or_id"
            }
          ]
        }
      },
      "status": "No Content",
      "code": 204,
      "_postman_previewlanguage": "text",
      "header": [
      ],
      "cookie": [
      ],
      "body": null
    }
  ]
}