Chilkat Online Tools

Go / Support API / Create Brand

Back to Collection Items

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

    http := chilkat.NewHttp()
    var success bool

    http.SetBasicAuth(true)
    http.SetLogin("login")
    http.SetPassword("password")

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

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

    // {
    //   "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>"
    //   }
    // }

    json := chilkat.NewJsonObject()
    json.UpdateString("brand.name","<string>")
    json.UpdateString("brand.subdomain","<string>")
    json.UpdateString("brand.active","<boolean>")
    json.UpdateString("brand.brand_url","<string>")
    json.UpdateString("brand.created_at","<dateTime>")
    json.UpdateString("brand.default","<boolean>")
    json.UpdateString("brand.has_help_center","<boolean>")
    json.UpdateString("brand.help_center_state","enabled")
    json.UpdateString("brand.host_mapping","<string>")
    json.UpdateString("brand.id","<integer>")
    json.UpdateString("brand.is_deleted","<boolean>")
    json.UpdateString("brand.logo.content_type","<string>")
    json.UpdateString("brand.logo.content_url","<string>")
    json.UpdateString("brand.logo.deleted","<boolean>")
    json.UpdateString("brand.logo.file_name","<string>")
    json.UpdateString("brand.logo.height","<string>")
    json.UpdateString("brand.logo.id","<integer>")
    json.UpdateString("brand.logo.inline","<boolean>")
    json.UpdateString("brand.logo.malware_access_override","<boolean>")
    json.UpdateString("brand.logo.malware_scan_result","<string>")
    json.UpdateString("brand.logo.mapped_content_url","<string>")
    json.UpdateString("brand.logo.size","<integer>")
    json.UpdateString("brand.logo.url","<string>")
    json.UpdateString("brand.logo.width","<string>")
    json.UpdateString("brand.logo.thumbnails[0].content_type","<string>")
    json.UpdateString("brand.logo.thumbnails[0].content_url","<string>")
    json.UpdateString("brand.logo.thumbnails[0].deleted","<boolean>")
    json.UpdateString("brand.logo.thumbnails[0].file_name","<string>")
    json.UpdateString("brand.logo.thumbnails[0].height","<string>")
    json.UpdateString("brand.logo.thumbnails[0].id","<integer>")
    json.UpdateString("brand.logo.thumbnails[0].inline","<boolean>")
    json.UpdateString("brand.logo.thumbnails[0].malware_access_override","<boolean>")
    json.UpdateString("brand.logo.thumbnails[0].malware_scan_result","<string>")
    json.UpdateString("brand.logo.thumbnails[0].mapped_content_url","<string>")
    json.UpdateString("brand.logo.thumbnails[0].size","<integer>")
    json.UpdateString("brand.logo.thumbnails[0].url","<string>")
    json.UpdateString("brand.logo.thumbnails[0].width","<string>")
    json.UpdateString("brand.logo.thumbnails[1].content_type","<string>")
    json.UpdateString("brand.logo.thumbnails[1].content_url","<string>")
    json.UpdateString("brand.logo.thumbnails[1].deleted","<boolean>")
    json.UpdateString("brand.logo.thumbnails[1].file_name","<string>")
    json.UpdateString("brand.logo.thumbnails[1].height","<string>")
    json.UpdateString("brand.logo.thumbnails[1].id","<integer>")
    json.UpdateString("brand.logo.thumbnails[1].inline","<boolean>")
    json.UpdateString("brand.logo.thumbnails[1].malware_access_override","<boolean>")
    json.UpdateString("brand.logo.thumbnails[1].malware_scan_result","<string>")
    json.UpdateString("brand.logo.thumbnails[1].mapped_content_url","<string>")
    json.UpdateString("brand.logo.thumbnails[1].size","<integer>")
    json.UpdateString("brand.logo.thumbnails[1].url","<string>")
    json.UpdateString("brand.logo.thumbnails[1].width","<string>")
    json.UpdateString("brand.signature_template","<string>")
    json.UpdateString("brand.ticket_form_ids","<array>")
    json.UpdateString("brand.updated_at","<dateTime>")
    json.UpdateString("brand.url","<string>")

    http.SetRequestHeader("Content-Type","application/json")
    http.SetRequestHeader("Accept","application/json")

    resp := http.PostJson3("https://example.zendesk.com/api/v2/brands","application/json",json)
    if http.LastMethodSuccess() == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        json.DisposeJsonObject()
        return
    }

    sbResponseBody := chilkat.NewStringBuilder()
    resp.GetBodySb(sbResponseBody)

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := resp.StatusCode()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(resp.Header())
        fmt.Println("Failed.")
        resp.DisposeHttpResponse()
        http.DisposeHttp()
        json.DisposeJsonObject()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        return
    }

    resp.DisposeHttpResponse()

    // Sample JSON response:
    // (Sample code for parsing the JSON response is shown below)

    // {
    //   "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>"
    //   }
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var content_type *string = new(string)
content_    var url *string = new(string)
    var deleted *string = new(string)
    var file_name *string = new(string)
    var height *string = new(string)
    var id *string = new(string)
    var inline *string = new(string)
    var malware_access_override *string = new(string)
    var malware_scan_result *string = new(string)
mapped_content_    var url *string = new(string)
    var size *string = new(string)
    var url *string = new(string)
    var width *string = new(string)

    Name := jResp.StringOf("brand.name")
    Subdomain := jResp.StringOf("brand.subdomain")
    Active := jResp.StringOf("brand.active")
    Brand_url := jResp.StringOf("brand.brand_url")
    Created_at := jResp.StringOf("brand.created_at")
    Default := jResp.StringOf("brand.default")
    Has_help_center := jResp.StringOf("brand.has_help_center")
    Help_center_state := jResp.StringOf("brand.help_center_state")
    Host_mapping := jResp.StringOf("brand.host_mapping")
    Id := jResp.StringOf("brand.id")
    Is_deleted := jResp.StringOf("brand.is_deleted")
    Content_type := jResp.StringOf("brand.logo.content_type")
    Content_url := jResp.StringOf("brand.logo.content_url")
    Deleted := jResp.StringOf("brand.logo.deleted")
    File_name := jResp.StringOf("brand.logo.file_name")
    Height := jResp.StringOf("brand.logo.height")
    LogoId := jResp.StringOf("brand.logo.id")
    Inline := jResp.StringOf("brand.logo.inline")
    Malware_access_override := jResp.StringOf("brand.logo.malware_access_override")
    Malware_scan_result := jResp.StringOf("brand.logo.malware_scan_result")
    Mapped_content_url := jResp.StringOf("brand.logo.mapped_content_url")
    Size := jResp.StringOf("brand.logo.size")
    v_Url_Ref.html">Url := jResp.StringOf("brand.logo.url")
    Width := jResp.StringOf("brand.logo.width")
    Signature_template := jResp.StringOf("brand.signature_template")
    Ticket_form_ids := jResp.StringOf("brand.ticket_form_ids")
    Updated_at := jResp.StringOf("brand.updated_at")
    brandUrl := jResp.StringOf("brand.url")
    i := 0
    count_i := jResp.SizeOfArray("brand.logo.thumbnails")
    for i < count_i {
        jResp.SetI(i)
        content_type = jResp.StringOf("brand.logo.thumbnails[i].content_type")
        content_url = jResp.StringOf("brand.logo.thumbnails[i].content_url")
        deleted = jResp.StringOf("brand.logo.thumbnails[i].deleted")
        file_name = jResp.StringOf("brand.logo.thumbnails[i].file_name")
        height = jResp.StringOf("brand.logo.thumbnails[i].height")
        id = jResp.StringOf("brand.logo.thumbnails[i].id")
        inline = jResp.StringOf("brand.logo.thumbnails[i].inline")
        malware_access_override = jResp.StringOf("brand.logo.thumbnails[i].malware_access_override")
        malware_scan_result = jResp.StringOf("brand.logo.thumbnails[i].malware_scan_result")
        mapped_content_url = jResp.StringOf("brand.logo.thumbnails[i].mapped_content_url")
        size = jResp.StringOf("brand.logo.thumbnails[i].size")
        url = jResp.StringOf("brand.logo.thumbnails[i].url")
        width = jResp.StringOf("brand.logo.thumbnails[i].width")
        i = i + 1
    }


    http.DisposeHttp()
    json.DisposeJsonObject()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

Curl Command

curl  -u login:password -X POST
	-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

Postman Collection Item JSON

{
  "name": "Create Brand",
  "request": {
    "method": "POST",
    "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",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "brands"
      ]
    },
    "description": "#### Allowed for\n- Admins"
  },
  "response": [
    {
      "name": "Successful response",
      "originalRequest": {
        "method": "POST",
        "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "brands"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_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}"
    }
  ]
}