Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New ChilkatHttp
Dim success As Long
http.BasicAuth = 1
http.Login = "login"
http.Password = "password"
http.SetRequestHeader "Accept","application/json"
Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequest("POST","https://example.zendesk.com/api/v2/uploads")
If (http.LastMethodSuccess = 0) Then
Debug.Print http.LastErrorText
Exit Sub
End If
Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)
Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0
Debug.Print "Response Body:"
Debug.Print jResp.Emit()
Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
Debug.Print "Response Header:"
Debug.Print resp.Header
Debug.Print "Failed."
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "upload": {
' "attachment": {
' "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>"
' }
' ]
' },
' "attachments": [
' {
' "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>"
' }
' ]
' },
' {
' "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>"
' }
' ]
' }
' ],
' "token": "<string>"
' }
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim content_type As String
Dim content_url As String
Dim deleted As String
Dim file_name As String
Dim height As String
Dim id As String
Dim inline As String
Dim malware_access_override As String
Dim malware_scan_result As String
Dim mapped_content_url As String
Dim size As String
Dim url As String
Dim width As String
Dim j As Long
Dim count_j As Long
Dim Content_type As String
Content_type = jResp.StringOf("upload.attachment.content_type")
Dim Content_url As String
Content_url = jResp.StringOf("upload.attachment.content_url")
Dim Deleted As String
Deleted = jResp.StringOf("upload.attachment.deleted")
Dim File_name As String
File_name = jResp.StringOf("upload.attachment.file_name")
Dim Height As String
Height = jResp.StringOf("upload.attachment.height")
Dim Id As String
Id = jResp.StringOf("upload.attachment.id")
Dim Inline As String
Inline = jResp.StringOf("upload.attachment.inline")
Dim Malware_access_override As String
Malware_access_override = jResp.StringOf("upload.attachment.malware_access_override")
Dim Malware_scan_result As String
Malware_scan_result = jResp.StringOf("upload.attachment.malware_scan_result")
Dim Mapped_content_url As String
Mapped_content_url = jResp.StringOf("upload.attachment.mapped_content_url")
Dim Size As String
Size = jResp.StringOf("upload.attachment.size")
Dim v_Url As String
v_Url = jResp.StringOf("upload.attachment.url")
Dim Width As String
Width = jResp.StringOf("upload.attachment.width")
Dim Token As String
Token = jResp.StringOf("upload.token")
Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("upload.attachment.thumbnails")
Do While i < count_i
jResp.I = i
content_type = jResp.StringOf("upload.attachment.thumbnails[i].content_type")
content_url = jResp.StringOf("upload.attachment.thumbnails[i].content_url")
deleted = jResp.StringOf("upload.attachment.thumbnails[i].deleted")
file_name = jResp.StringOf("upload.attachment.thumbnails[i].file_name")
height = jResp.StringOf("upload.attachment.thumbnails[i].height")
id = jResp.StringOf("upload.attachment.thumbnails[i].id")
inline = jResp.StringOf("upload.attachment.thumbnails[i].inline")
malware_access_override = jResp.StringOf("upload.attachment.thumbnails[i].malware_access_override")
malware_scan_result = jResp.StringOf("upload.attachment.thumbnails[i].malware_scan_result")
mapped_content_url = jResp.StringOf("upload.attachment.thumbnails[i].mapped_content_url")
size = jResp.StringOf("upload.attachment.thumbnails[i].size")
url = jResp.StringOf("upload.attachment.thumbnails[i].url")
width = jResp.StringOf("upload.attachment.thumbnails[i].width")
i = i + 1
Loop
i = 0
count_i = jResp.SizeOfArray("upload.attachments")
Do While i < count_i
jResp.I = i
content_type = jResp.StringOf("upload.attachments[i].content_type")
content_url = jResp.StringOf("upload.attachments[i].content_url")
deleted = jResp.StringOf("upload.attachments[i].deleted")
file_name = jResp.StringOf("upload.attachments[i].file_name")
height = jResp.StringOf("upload.attachments[i].height")
id = jResp.StringOf("upload.attachments[i].id")
inline = jResp.StringOf("upload.attachments[i].inline")
malware_access_override = jResp.StringOf("upload.attachments[i].malware_access_override")
malware_scan_result = jResp.StringOf("upload.attachments[i].malware_scan_result")
mapped_content_url = jResp.StringOf("upload.attachments[i].mapped_content_url")
size = jResp.StringOf("upload.attachments[i].size")
url = jResp.StringOf("upload.attachments[i].url")
width = jResp.StringOf("upload.attachments[i].width")
j = 0
count_j = jResp.SizeOfArray("upload.attachments[i].thumbnails")
Do While j < count_j
jResp.J = j
content_type = jResp.StringOf("upload.attachments[i].thumbnails[j].content_type")
content_url = jResp.StringOf("upload.attachments[i].thumbnails[j].content_url")
deleted = jResp.StringOf("upload.attachments[i].thumbnails[j].deleted")
file_name = jResp.StringOf("upload.attachments[i].thumbnails[j].file_name")
height = jResp.StringOf("upload.attachments[i].thumbnails[j].height")
id = jResp.StringOf("upload.attachments[i].thumbnails[j].id")
inline = jResp.StringOf("upload.attachments[i].thumbnails[j].inline")
malware_access_override = jResp.StringOf("upload.attachments[i].thumbnails[j].malware_access_override")
malware_scan_result = jResp.StringOf("upload.attachments[i].thumbnails[j].malware_scan_result")
mapped_content_url = jResp.StringOf("upload.attachments[i].thumbnails[j].mapped_content_url")
size = jResp.StringOf("upload.attachments[i].thumbnails[j].size")
url = jResp.StringOf("upload.attachments[i].thumbnails[j].url")
width = jResp.StringOf("upload.attachments[i].thumbnails[j].width")
j = j + 1
Loop
i = i + 1
Loop
Curl Command
curl -u login:password -X POST
-H "Accept: application/json"
https://example.zendesk.com/api/v2/uploads
Postman Collection Item JSON
{
"name": "Upload Files",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/uploads",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"uploads"
]
},
"description": "Uploads a file that can be attached to a ticket comment. It doesn't attach the file to the comment. For details and examples, see [Attaching ticket comments with the API](/documentation/ticketing/using-the-zendesk-api/adding-ticket-attachments-with-the-api).\n\nThe endpoint has a required `filename` query parameter. The parameter specifies what the file will be named when attached to the ticket comment (to give the agent more context about the file). The parameter does not specify the file on the local system to be uploaded. While the two names can be different, their file extensions must be the same. If they don't match, the agent's browser or file reader could give an error when attempting to open the attachment.\n\nThe `Content-Type` header must contain a recognized MIME type that correctly describes the type of the uploaded file. Failing to send a recognized, correct type may cause undesired behavior. For example, in-browser audio playback may be interrupted by the browser's security mechanisms for MP3s uploaded with an incorrect type.\n\nAdding multiple files to the same upload is handled by splitting requests and passing the API token received from the first request to each subsequent request. The token is valid for 3 days.\n\n**Note**: Even if [private attachments](https://support.zendesk.com/hc/en-us/articles/204265396) are enabled in the Zendesk Support instance, uploaded files are visible to any authenticated user at the `content_URL` specified in the [JSON response](#json-format) until the upload token is consumed. Once a file is associated with a ticket or post, visibility is restricted to users with access to the ticket or post with the attachment.\n\n#### Allowed For\n\n* End users\n"
},
"response": [
{
"name": "Created response",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/uploads",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"uploads"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"upload\": {\n \"attachment\": {\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 \"attachments\": [\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 \"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 {\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 ],\n \"token\": \"<string>\"\n }\n}"
}
]
}
