Chilkat Online Tools

Delphi (DLL) / Support API / Update a Brand

Back to Collection Items

var

begin
CkHttp_putBasicAuth(http,True);CkHttp_putLogin(http,'login');CkHttp_putPassword(http,'password');CkJsonObject_UpdateString(json,'brand.name','<string>');CkJsonObject_UpdateString(json,'brand.subdomain','<string>');CkJsonObject_UpdateString(json,'brand.active','<boolean>');CkJsonObject_UpdateString(json,'brand.brand_url','<string>');CkJsonObject_UpdateString(json,'brand.created_at','<dateTime>');CkJsonObject_UpdateString(json,'brand.default','<boolean>');CkJsonObject_UpdateString(json,'brand.has_help_center','<boolean>');CkJsonObject_UpdateString(json,'brand.help_center_state','enabled');CkJsonObject_UpdateString(json,'brand.host_mapping','<string>');CkJsonObject_UpdateString(json,'brand.id','<integer>');CkJsonObject_UpdateString(json,'brand.is_deleted','<boolean>');CkJsonObject_UpdateString(json,'brand.logo.content_type','<string>');CkJsonObject_UpdateString(json,'brand.logo.content_url','<string>');CkJsonObject_UpdateString(json,'brand.logo.deleted','<boolean>');CkJsonObject_UpdateString(json,'brand.logo.file_name','<string>');CkJsonObject_UpdateString(json,'brand.logo.height','<string>');CkJsonObject_UpdateString(json,'brand.logo.id','<integer>');CkJsonObject_UpdateString(json,'brand.logo.inline','<boolean>');CkJsonObject_UpdateString(json,'brand.logo.malware_access_override','<boolean>');CkJsonObject_UpdateString(json,'brand.logo.malware_scan_result','<string>');CkJsonObject_UpdateString(json,'brand.logo.mapped_content_url','<string>');CkJsonObject_UpdateString(json,'brand.logo.size','<integer>');CkJsonObject_UpdateString(json,'brand.logo.url','<string>');CkJsonObject_UpdateString(json,'brand.logo.width','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[0].content_type','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[0].content_url','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[0].deleted','<boolean>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[0].file_name','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[0].height','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[0].id','<integer>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[0].inline','<boolean>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[0].malware_access_override','<boolean>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[0].malware_scan_result','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[0].mapped_content_url','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[0].size','<integer>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[0].url','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[0].width','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[1].content_type','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[1].content_url','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[1].deleted','<boolean>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[1].file_name','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[1].height','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[1].id','<integer>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[1].inline','<boolean>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[1].malware_access_override','<boolean>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[1].malware_scan_result','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[1].mapped_content_url','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[1].size','<integer>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[1].url','<string>');CkJsonObject_UpdateString(json,'brand.logo.thumbnails[1].width','<string>');CkJsonObject_UpdateString(json,'brand.signature_template','<string>');CkJsonObject_UpdateString(json,'brand.ticket_form_ids','<array>');CkJsonObject_UpdateString(json,'brand.updated_at','<dateTime>');CkJsonObject_UpdateString(json,'brand.url','<string>');CkJsonObject_EmitSb(json,sbRequestBody);CkHttpResponse_GetBodySb(resp,sbResponseBody);CkJsonObject_LoadSb(jResp,sbResponseBody);CkJsonObject_putEmitCompact(jResp,False);CkJsonObject_putI(jResp,i);content_type := CkJsonObject__stringOf(jResp,'brand.logo.thumbnails[i].content_type');content_url := CkJsonObject__stringOf(jResp,'brand.logo.thumbnails[i].content_url');deleted := CkJsonObject__stringOf(jResp,'brand.logo.thumbnails[i].deleted');file_name := CkJsonObject__stringOf(jResp,'brand.logo.thumbnails[i].file_name');height := CkJsonObject__stringOf(jResp,'brand.logo.thumbnails[i].height');id := CkJsonObject__stringOf(jResp,'brand.logo.thumbnails[i].id');inline := CkJsonObject__stringOf(jResp,'brand.logo.thumbnails[i].inline');malware_access_override := CkJsonObject__stringOf(jResp,'brand.logo.thumbnails[i].malware_access_override');malware_scan_result := CkJsonObject__stringOf(jResp,'brand.logo.thumbnails[i].malware_scan_result');mapped_content_url := CkJsonObject__stringOf(jResp,'brand.logo.thumbnails[i].mapped_content_url');size := CkJsonObject__stringOf(jResp,'brand.logo.thumbnails[i].size');url := CkJsonObject__stringOf(jResp,'brand.logo.thumbnails[i].url');width := CkJsonObject__stringOf(jResp,'brand.logo.thumbnails[i].width');i := i + 1;

Curl Command

curl  -u login:password -X PUT
	-H "Content-Type: application/json"
	-H "Accept: application/json"
	-d '{
  "brand": {
    "name": "<string>",
    "subdomain": "<string>",
    "active": "<boolean>",
    "brand_url": "<string>",
    "created_at": "<dateTime>",
    "default": "<boolean>",
    "has_help_center": "<boolean>",
    "help_center_state": "enabled",
    "host_mapping": "<string>",
    "id": "<integer>",
    "is_deleted": "<boolean>",
    "logo": {
      "content_type": "<string>",
      "content_url": "<string>",
      "deleted": "<boolean>",
      "file_name": "<string>",
      "height": "<string>",
      "id": "<integer>",
      "inline": "<boolean>",
      "malware_access_override": "<boolean>",
      "malware_scan_result": "<string>",
      "mapped_content_url": "<string>",
      "size": "<integer>",
      "url": "<string>",
      "width": "<string>",
      "thumbnails": [
        {
          "content_type": "<string>",
          "content_url": "<string>",
          "deleted": "<boolean>",
          "file_name": "<string>",
          "height": "<string>",
          "id": "<integer>",
          "inline": "<boolean>",
          "malware_access_override": "<boolean>",
          "malware_scan_result": "<string>",
          "mapped_content_url": "<string>",
          "size": "<integer>",
          "url": "<string>",
          "width": "<string>"
        },
        {
          "content_type": "<string>",
          "content_url": "<string>",
          "deleted": "<boolean>",
          "file_name": "<string>",
          "height": "<string>",
          "id": "<integer>",
          "inline": "<boolean>",
          "malware_access_override": "<boolean>",
          "malware_scan_result": "<string>",
          "mapped_content_url": "<string>",
          "size": "<integer>",
          "url": "<string>",
          "width": "<string>"
        }
      ]
    },
    "signature_template": "<string>",
    "ticket_form_ids": "<array>",
    "updated_at": "<dateTime>",
    "url": "<string>"
  }
}'
https://example.zendesk.com/api/v2/brands/:brand_id

Postman Collection Item JSON

{
  "name": "Update a Brand",
  "request": {
    "method": "PUT",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"brand\": {\n    \"name\": \"<string>\",\n    \"subdomain\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"brand_url\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"has_help_center\": \"<boolean>\",\n    \"help_center_state\": \"enabled\",\n    \"host_mapping\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"is_deleted\": \"<boolean>\",\n    \"logo\": {\n      \"content_type\": \"<string>\",\n      \"content_url\": \"<string>\",\n      \"deleted\": \"<boolean>\",\n      \"file_name\": \"<string>\",\n      \"height\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"inline\": \"<boolean>\",\n      \"malware_access_override\": \"<boolean>\",\n      \"malware_scan_result\": \"<string>\",\n      \"mapped_content_url\": \"<string>\",\n      \"size\": \"<integer>\",\n      \"url\": \"<string>\",\n      \"width\": \"<string>\",\n      \"thumbnails\": [\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\"\n        },\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\"\n        }\n      ]\n    },\n    \"signature_template\": \"<string>\",\n    \"ticket_form_ids\": \"<array>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}",
      "options": {
        "raw": {
          "headerFamily": "json",
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{baseUrl}}/api/v2/brands/:brand_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "brands",
        ":brand_id"
      ],
      "variable": [
        {
          "key": "brand_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Returns an updated brand.\n\n#### Allowed for\n* Admins\n\n#### Updating a Brand's Image\nA brand image can be updated by uploading a local file using the update brand endpoint. See the **Using curl** sections below for more information."
  },
  "response": [
    {
      "name": "Successful response",
      "originalRequest": {
        "method": "PUT",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          },
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"brand\": {\n    \"name\": \"<string>\",\n    \"subdomain\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"brand_url\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"has_help_center\": \"<boolean>\",\n    \"help_center_state\": \"enabled\",\n    \"host_mapping\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"is_deleted\": \"<boolean>\",\n    \"logo\": {\n      \"content_type\": \"<string>\",\n      \"content_url\": \"<string>\",\n      \"deleted\": \"<boolean>\",\n      \"file_name\": \"<string>\",\n      \"height\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"inline\": \"<boolean>\",\n      \"malware_access_override\": \"<boolean>\",\n      \"malware_scan_result\": \"<string>\",\n      \"mapped_content_url\": \"<string>\",\n      \"size\": \"<integer>\",\n      \"url\": \"<string>\",\n      \"width\": \"<string>\",\n      \"thumbnails\": [\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\"\n        },\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\"\n        }\n      ]\n    },\n    \"signature_template\": \"<string>\",\n    \"ticket_form_ids\": \"<array>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}",
          "options": {
            "raw": {
              "headerFamily": "json",
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{baseUrl}}/api/v2/brands/:brand_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "brands",
            ":brand_id"
          ],
          "variable": [
            {
              "key": "brand_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"brand\": {\n    \"name\": \"<string>\",\n    \"subdomain\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"brand_url\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"has_help_center\": \"<boolean>\",\n    \"help_center_state\": \"enabled\",\n    \"host_mapping\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"is_deleted\": \"<boolean>\",\n    \"logo\": {\n      \"content_type\": \"<string>\",\n      \"content_url\": \"<string>\",\n      \"deleted\": \"<boolean>\",\n      \"file_name\": \"<string>\",\n      \"height\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"inline\": \"<boolean>\",\n      \"malware_access_override\": \"<boolean>\",\n      \"malware_scan_result\": \"<string>\",\n      \"mapped_content_url\": \"<string>\",\n      \"size\": \"<integer>\",\n      \"url\": \"<string>\",\n      \"width\": \"<string>\",\n      \"thumbnails\": [\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\"\n        },\n        {\n          \"content_type\": \"<string>\",\n          \"content_url\": \"<string>\",\n          \"deleted\": \"<boolean>\",\n          \"file_name\": \"<string>\",\n          \"height\": \"<string>\",\n          \"id\": \"<integer>\",\n          \"inline\": \"<boolean>\",\n          \"malware_access_override\": \"<boolean>\",\n          \"malware_scan_result\": \"<string>\",\n          \"mapped_content_url\": \"<string>\",\n          \"size\": \"<integer>\",\n          \"url\": \"<string>\",\n          \"width\": \"<string>\"\n        }\n      ]\n    },\n    \"signature_template\": \"<string>\",\n    \"ticket_form_ids\": \"<array>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}