API documentation | API docs for agents | OpenAPI 3.1

prepare-upload

ark.prepare_organization_logo_upload

Creates a signed PNG upload URL for replacing the organization online logo or paper/PDF logo at the canonical storage path.

Availability: Expanded preview
Scopes: admin:write
ARK permissions: None
Team visibility: Not entity-scoped
Idempotency-Key: Required for this write
Approval: No MCP approval on REST API-token calls
Rate limit: API credential and organization budgets

Parameters

Idempotency-Keyheaderstringrequired: Required for external write operations. Reuse the same key only for exact retries of the same request body.; min length: 1; max length: 200

Request body

logoTypestringrequired

standard is the online app logo. paper is the logo used for PDFs and documents.

one of: standard, paper

fileNamestring

min length: 1; max length: 200

mimeTypestring

default: "image/png"

Example request

Shell

curl -X POST 'https://arktms.com/api/v1/organization/logos/prepare-upload' \
  -H "Authorization: Bearer $ARK_API_TOKEN" \
  -H "Idempotency-Key: <unique-key>" \
  -H "Content-Type: application/json" \
  -d '{
  "logoType": "standard"
}'

Success response

Prepared organization logo upload

objectstringrequired

one of: api_response

okbooleanrequired

one of: true

api_versionstringrequired

one of: 2026-05-31

request_idstringrequired

dataobjectrequired

data.logoTypestringrequired

standard is the online app logo. paper is the logo used for PDFs and documents.

one of: standard, paper

data.filePathstringrequired

data.displayNamestringrequired

data.fileNamestringrequired

data.mimeTypestringrequired

data.pendingUploadIdstringrequired

format: uuid

data.signedUrlstringrequired

format: uri

data.tokenstringrequired

data.upsertbooleanrequired

one of: true

Errors

HTTP 400: Invalid request
HTTP 401: Authentication required
HTTP 403: Permission, scope, team, or entitlement denied
HTTP 409: Idempotency conflict or in-progress retry
HTTP 422: Invalid request