Upload an automation action parameter attachment

curl --request POST \
  --url https://clarus-api.com/api/automation_action_parameters/{automation_action_parameter_id}/attachment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/octet-stream' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '"<string>"'

import requests

url = "https://clarus-api.com/api/automation_action_parameters/{automation_action_parameter_id}/attachment"

payload = "<string>"
headers = {
    "Authorization": "Bearer <token>",
    "X-Clarus-Subdomain": "<api-key>",
    "Content-Type": "application/octet-stream"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Clarus-Subdomain': '<api-key>',
    'Content-Type': 'application/octet-stream'
  },
  body: JSON.stringify('<string>')
};

fetch('https://clarus-api.com/api/automation_action_parameters/{automation_action_parameter_id}/attachment', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": "<string>"
}

{
  "errors": [
    {
      "code": 123,
      "symbol": "<string>",
      "details": "<string>",
      "source": "<string>",
      "context": {}
    }
  ]
}

POST

api

automation_action_parameters

{automation_action_parameter_id}

attachment

Upload an automation action parameter attachment

curl --request POST \
  --url https://clarus-api.com/api/automation_action_parameters/{automation_action_parameter_id}/attachment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/octet-stream' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '"<string>"'

import requests

url = "https://clarus-api.com/api/automation_action_parameters/{automation_action_parameter_id}/attachment"

payload = "<string>"
headers = {
    "Authorization": "Bearer <token>",
    "X-Clarus-Subdomain": "<api-key>",
    "Content-Type": "application/octet-stream"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Clarus-Subdomain': '<api-key>',
    'Content-Type': 'application/octet-stream'
  },
  body: JSON.stringify('<string>')
};

fetch('https://clarus-api.com/api/automation_action_parameters/{automation_action_parameter_id}/attachment', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": "<string>"
}

{
  "errors": [
    {
      "code": 123,
      "symbol": "<string>",
      "details": "<string>",
      "source": "<string>",
      "context": {}
    }
  ]
}

Binary Upload

This endpoint uses binary upload (not JSON:API). Send the file contents as the raw request body.

Required Headers

Header	Description	Example
`Content-Disposition`	Filename of the upload	`attachment; filename="body.html"`
`Content-Type`	MIME type of the file	`text/html`

cURL Example

curl -X POST https://clarus-api.com/api/automation_action_parameters/42/attachment \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "X-Clarus-Subdomain: acme-warehouse" \
  -H "Content-Disposition: attachment; filename=\"body.html\"" \
  -H "Content-Type: text/html" \
  --data-binary @body.html

Authorizations

Authorization

string

header

required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

X-Clarus-Subdomain

string

header

required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

automation_action_parameter_id

integer

required

The unique identifier of the automation action parameter

Body

application/octet-stream

The file contents

Response

Attachment uploaded successfully

⌘I

​Binary Upload

​Required Headers

​cURL Example

Authorizations

Path Parameters

Body

Response

Binary Upload

Required Headers

cURL Example