Arta API Reference

Update an Organization

PATCH /organization

Update the Organization associated with the API Key in the Authorization header

Headers

Authorization string Required

Authorize your API calls with an Arta API token

application/json

Body

organization object
Hide organization attributes Show organization attributes
- api_version string
  
  The fallback API Version to be used as a default when API calls associated with this Organization do not include an Arta-Version header
- company_name string
  
  The legal name for this organization; used as part of Arta's billing and invoicing processes.
- display_name string
  
  The display name for this organization. Presented on public pages for this organizations' shipments.
- name string
  
  The name for this Organization.

Responses

• 200 application/json

Successful Organization update response
Hide headers attributes Show headers attributes
- content-type string
- x-arta-request-id string
  
  A unique identifier for the Arta API call
Hide response attributes Show response attributes object
- api_version string
- billing_terms string
- company_name string
- created_at string
- display_name string
- id integer(int64)
- name string
- shortcode string
- status string
- updated_at string
• 404 application/json

Resource Not Found
Hide headers attributes Show headers attributes
- content-type string
- x-arta-request-id string
  
  A unique identifier for the Arta API call
Hide response attribute Show response attribute object
- errors object
  
  Hide errors attribute Show errors attribute
  
  detail string

PATCH /organization

curl \
 -X PATCH https://api.arta.io/organization \
 -H "Content-Type: application/json" \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
 -d '{"organization":{"api_version":"2021-01-01","company_name":"Hudson Street Collective LLC","display_name":"Hudson Street","name":"Hudson Street Gallery"}}'

Request example

# Headers
Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y

# Payload
{
  "organization": {
    "api_version": "2021-01-01",
    "company_name": "Hudson Street Collective LLC",
    "display_name": "Hudson Street",
    "name": "Hudson Street Gallery"
  }
}

Response examples (200)

# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "api_version": "2021-01-01",
  "billing_terms": "invoicing",
  "company_name": "Hudson Street Collective LLC",
  "created_at": "2022-10-23T13:39:12.504731",
  "display_name": "Hudson Street",
  "id": 4392,
  "name": "Hudson Street Gallery",
  "shortcode": "HSC",
  "status": "active",
  "updated_at": "2023-05-02T23:13:31.193097"
}

Response examples (404)

# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

# Payload
{
  "errors": {
    "detail": "string"
  }
}