GuidesAPI ReferenceRecipes
API Reference
Request a Demo

Create an Attachment on a Record

post
https://na1.ironcladapp.com/public/api/v1/records//attachments/

Create an attachment on a specified record at the specified attachment key.

OAuth Scope required: public.records.createAttachments

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID or Ironclad ID of the Record. For an explanation of Record IDs or Ironclad IDs and how to find them, see Getting Started.

string
required
Defaults to signedCopy

The attachment key at which to store the attachment. This can be any arbitrary string.

Query Params
boolean
Defaults to false

When true, returns addresses as objects instead of strings.

Body Params
file

Must be a binary. Base64 is not accepted at this time.

metadata
object

The metadata property's value must be {"filename": "[YOUR_FILE_NAME]"}

Headers
string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Responses

Updated 10 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 days ago