Skip to main content
PUT
/
attachments
/
{attachment_id}
/
image
Update Attachment Image
curl --request PUT \
  --url https://api.decodahealth.com/attachments/{attachment_id}/image \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --header 'TENANT: <tenant>' \
  --form file='@example-file'
import requests

url = "https://api.decodahealth.com/attachments/{attachment_id}/image"

files = { "file": ("example-file", open("example-file", "rb")) }
headers = {
"TENANT": "<tenant>",
"API-KEY": "<api-key>"
}

response = requests.put(url, files=files, headers=headers)

print(response.text)
const form = new FormData();
form.append('file', '<string>');

const options = {method: 'PUT', headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>'}};

options.body = form;

fetch('https://api.decodahealth.com/attachments/{attachment_id}/image', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.decodahealth.com/attachments/{attachment_id}/image",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"Content-Type: multipart/form-data",
"TENANT: <tenant>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.decodahealth.com/attachments/{attachment_id}/image"

payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("TENANT", "<tenant>")
req.Header.Add("API-KEY", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.decodahealth.com/attachments/{attachment_id}/image")
.header("TENANT", "<tenant>")
.header("API-KEY", "<api-key>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/attachments/{attachment_id}/image")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "gcsPath": "<string>",
  "originalFilename": "<string>",
  "signedUrl": "<string>",
  "name": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "noteId": "<string>",
  "thumbnailSignedUrl": "<string>",
  "annotations": [
    {}
  ],
  "externalId": "<string>",
  "patient": {
    "id": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>",
    "externalId": "<string>",
    "address": "<string>",
    "addressLineTwo": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zipCode": "<string>",
    "country": "<string>",
    "addressValid": true,
    "meta": {},
    "isArchived": true,
    "primaryLocationId": "<string>",
    "gender": "<string>",
    "pronouns": "<string>",
    "preferredName": "<string>",
    "dateOfBirth": "2023-12-25",
    "patientMedications": [
      "<string>"
    ],
    "leadSource": "<string>",
    "onSchedulingBlacklist": true,
    "surchargeDisabled": true,
    "tags": [
      {
        "id": "<string>",
        "name": "<string>",
        "isActive": true,
        "createdDate": "2023-11-07T05:31:56Z",
        "emoji": "<string>",
        "color": "<string>",
        "updatedDate": "2023-11-07T05:31:56Z"
      }
    ],
    "creditBalance": 123,
    "preferredProviderId": "<string>",
    "dosespotPatientId": "<string>"
  },
  "note": {
    "id": "<string>",
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "provider": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>",
      "createdDate": "2023-11-07T05:31:56Z"
    }
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

attachment_id
string
required

Body

multipart/form-data
file
file
required

Response

Successful Response

id
string
required
gcsPath
string
required
originalFilename
string
required
signedUrl
string
required
name
string
required
createdDate
string<date-time>
required
noteId
string | null
thumbnailSignedUrl
string | null
annotations
Annotations · object[] | null
externalId
string | null
patient
PatientSummary · object | null
note
NoteAttachmentNote · object | null
provider
ProviderTiny · object | null
tags
NoteAttachmentTagSummary · object[]