Update customer file - Streamlined

PUT

/

customers

/

{customer_id}

/

files

/

{id}

Update customer file

curl --request PUT \
  --url https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>' \
  --data '
{
  "filename": "<string>"
}
'

const options = {
  method: 'PUT',
  headers: {
    'X-App-Id': '<api-key>',
    'X-Api-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({filename: '<string>'})
};

fetch('https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files/{id}"

payload = { "filename": "<string>" }
headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files/{id}")

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

request = Net::HTTP::Put.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filename\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "label": "credit_application",
  "label_name": "<string>",
  "category": "<string>",
  "url": "<string>",
  "filename": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-App-Id

string

header

required

App ID for authentication

X-Api-Key

string

header

required

API Key for authentication

Path Parameters

customer_id

string<uuid>

required

The UUID of the customer

id

integer

required

The ID of the file

Body

application/json

label

enum<string>

Allowed labels for customer files.

Available options:

credit_application,

personal_guarantee,

financial_statements,

credit_report,

sales_service_agreement,

payment_terms_agreement,

guarantee_security_agreement,

reseller_certificate,

non_disclosure_agreement,

tax_exemption_certificate,

business_license,

insurance_certificate,

shipping_contract,

bill_of_lading,

delivery_receipt,

memo,

customer_correspondence,

dispute_documentation,

other

filename

string

New filename for the file

Response

File updated. Note: this endpoint returns the file object directly, not wrapped in a file key (unlike GET, POST, and DELETE on this resource). Kept this way for v1 backwards compatibility.

id

integer

label

enum<string>

Allowed labels for customer files.

Available options:

credit_application,

personal_guarantee,

financial_statements,

credit_report,

sales_service_agreement,

payment_terms_agreement,

guarantee_security_agreement,

reseller_certificate,

non_disclosure_agreement,

tax_exemption_certificate,

business_license,

insurance_certificate,

shipping_contract,

bill_of_lading,

delivery_receipt,

memo,

customer_correspondence,

dispute_documentation,

other

label_name

string

Human-readable name for the label.

category

string

Category of the file.

url

string<uri>

URL to download the file.

filename

string

created_at

string<date-time>

updated_at

string<date-time>

⌘I

Update customer file

curl --request PUT \
  --url https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-App-Id: <api-key>' \
  --data '
{
  "filename": "<string>"
}
'

const options = {
  method: 'PUT',
  headers: {
    'X-App-Id': '<api-key>',
    'X-Api-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({filename: '<string>'})
};

fetch('https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files/{id}"

payload = { "filename": "<string>" }
headers = {
    "X-App-Id": "<api-key>",
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

require 'uri'
require 'net/http'

url = URI("https://api.staging.streamlinedpayments.com/api/v1/customers/{customer_id}/files/{id}")

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

request = Net::HTTP::Put.new(url)
request["X-App-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filename\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": 123,
  "label": "credit_application",
  "label_name": "<string>",
  "category": "<string>",
  "url": "<string>",
  "filename": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}