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

  • Hide organization attributes Show organization attributes
    • The fallback API Version to be used as a default when API calls associated with this Organization do not include an Arta-Version header

    • The legal name for this organization; used as part of Arta's billing and invoicing processes.

    • The display name for this organization. Presented on public pages for this organizations' shipments.

    • name string

      The name for this Organization.

Responses

PATCH /organization
curl \
 -X PATCH https://api.arta.io/organization \
 -H "Content-Type: application/json" \
 -H "Authorization: ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y" \
 -d '{"organization":{"name":"Hudson Street Gallery","api_version":"2021-01-01","company_name":"Hudson Street Collective LLC","display_name":"Hudson Street"}}'
Request example
{
  "organization": {
    "name": "Hudson Street Gallery",
    "api_version": "2021-01-01",
    "company_name": "Hudson Street Collective LLC",
    "display_name": "Hudson Street"
  }
}
Response examples (200)
{
  "id": 4392,
  "name": "Hudson Street Gallery",
  "status": "active",
  "shortcode": "HSC",
  "created_at": "2022-10-23T13:39:12.504731",
  "updated_at": "2023-05-02T23:13:31.193097",
  "api_version": "2021-01-01",
  "company_name": "Hudson Street Collective LLC",
  "display_name": "Hudson Street",
  "billing_terms": "invoicing"
}
Response examples (404)
# Headers
content-type: application/json
x-arta-request-id: FkBjuxbwLLTx4RoAARkx

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