v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB
Records

Create an Attachment on a Record

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

OAuth Scope required: public.records.createAttachments

post/records/{id}/attachments/{key}

Path parameters

idstring 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.

keystring required

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

Query parameters

addressAsObjectboolean

When true, returns addresses as objects instead of strings.

Headers

x-as-user-emailstring
Example:jane.doe@test.com

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.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

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.

Response

200

object required