Set the columns of a list

PUT/v1/api/store/{team_slug}/setting/column

v1Operation ID v1_public_setting_column_update

Saves which columns one of the team's lists shows in the web app, for everyone on the team: sales orders, quotes, purchase orders, customers, jobs or shipments.

value replaces the saved setting for that list. Its shape is the web app's own: read the current column setting first and send it back changed. Returns the full settings object.

Permission

Needs the Manage Settings permission. The team owner always has it.

Business rules

Always send key and value. The server doesn't require them, but without key the value is saved under an empty name.

Path parameters

team_slugstringrequired
Your team slug, shown as Team ID next to your API key in Profile.
- Example your-team

Request body

application/json, required.

keystringrequired
- One of: "sales_order", "quote", "purchase_order", "customer", "job", "shipment"
valuearray | objectrequired
The column setting for that list, as the web app saves it (a JSON array or object). It replaces what was saved.

Response

200Successful response.

dataobjectrequired
The team's settings: the saved general settings (the keys "Update general settings" takes, with their defaults), column (list columns), cust_msg_status (the add-on), the three payment webhook addresses, the read-only customer portal sign-in and payment minimum fields below, and the payment gateway values stored for the team, which can include secret keys (sensitive; treat as private). A team that never changed its date formats reads pdf_date_format: "std" and web_date_format: "us", values outside the list the update takes.
Child fields (13)
- columnobject | array
  List columns, by list name (sales_order, quote, ...). An empty array [] when none is saved.
- cust_msg_statusboolean
  Whether the customer message statuses add-on is on.
- customer_portal_account_login_availableboolean
  Read only: whether customers can sign in to your customer portal with an email account. True when your plan includes the customer portal.
- customer_portal_rolloutobject
  Read only: where the customer portal's move to email-account sign-in stands for your team. YoPrint sets the dates; you can't change them here.
  Child fields (6)
  - account_onlybooleanrequired
    True when customers must sign in with an email account: a portal link alone no longer opens the portal.
  - all_teams_atstring (date-time) | nullrequired
    From when every team is account-only (UTC), or null when not set.
  - configuration_warningstring | nullrequired
    Set when YoPrint's own rollout dates are inconsistent; null normally.
    One of: "new_teams_cutoff_not_before_all_teams_cutoff", "invalid_rollout_date"
  - legacy_access_allowedbooleanrequired
    The opposite of account_only: portal links still open the portal.
  - new_teams_atstring (date-time) | nullrequired
    From when new teams are account-only (UTC), or null when not set.
  - reasonstringrequired
    transition: links still work. new_team_cutoff: the team was created after the date for new teams. all_teams_cutoff: the date for every team has passed.
    One of: "transition", "new_team_cutoff", "all_teams_cutoff"
- pagination_per_pageinteger
- payment_amount_policiesmap of objects
  Read only: the same for each of your currencies, deleted ones included, keyed by ISO code (orders keep the currency they were made in). [] when the team has none.
  Fields of each item (3)
  - minimum_paymentdecimal pairrequired
    A decimal pair whose value is a string: the amount is value ÷ 10^dp ({"value": "1000", "dp": 3} is 1.00). YoPrint refuses smaller payments.
    See Money and quantities.
  - currencystringrequired
  - minimum_remaining_balancenullrequired
    Always null here.
- payment_amount_policyobject | null
  Read only: the smallest payment YoPrint takes in your default currency, or null when the team has no default currency.
  Child fields (3)
  - minimum_paymentdecimal pairrequired
    A decimal pair whose value is a string: the amount is value ÷ 10^dp ({"value": "1000", "dp": 3} is 1.00). YoPrint refuses smaller payments.
    See Money and quantities.
  - currencystringrequired
  - minimum_remaining_balancenullrequired
    Always null here.
- paypal_webhook_urlstring (uri)
  The same for PayPal.
- pdf_date_formatstring
  Date format on PDFs. std is the default for a team that never changed it; PDFs show it like other_1 (05 Nov 2026). A team whose saved settings have no date format reads other_1. "Update general settings" accepts only the other five values.
  - One of: "std", "default", "british_standard", "us_standard", "international", "other_1"
- shipping_label_create_cost_line_itemboolean
  Whether "Create Shipping Cost Line Item" starts checked when someone buys a shipping label in the web app. true until changed.
- square_webhook_urlstring (uri)
  The same for Square.
- stripe_webhook_urlstring (uri)
  The address to give Stripe for this team's payment webhooks.
- web_date_formatstring
  Date format in the web app. us is the default for a team that never changed it; the web app shows it like default (Nov 05, 2026). A team whose saved settings have no date format reads default. "Update general settings" accepts only the other five values.
  - One of: "us", "default", "british_standard", "us_standard", "international", "other_1"
statusintegerrequired
successbooleanrequired

Errors

401The API key is missing or wrong (unauthenticated).
403You are not allowed to do this. api_access_not_in_plan: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only {"message": "Insufficient Permission"}. Other refusals use the error envelope, with unauthorized or user_is_not_authorized.
When
Your role lacks Manage Settings. The body is {"message": "Insufficient Permission"}, without the error envelope.
Fix
Use the key of a member whose role has Manage Settings, or the owner's.
404Not found. page_not_found: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. code: null, with a message that starts "No query results for": there is no record with that id.
422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
When
key is not one of the six lists, or value is not an array (validation_failed).
Fix
Send one of the listed keys and an array.

Notes

Treat the response as sensitive: besides your preferences it can carry the payment gateway values stored for the team. Don't log or share it.

PUTUpdate general settings/v1/api/store/{team_slug}/setting/general

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/setting/column' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "key": "sales_order",    "value": [      {        "field": "customer",        "visible": true      }    ]  }'

Example response 200

{
  "data": {
    "column": {
      "sales_order": [
        {
          "field": "customer",
          "visible": true
        }
      ]
    },
    "cust_msg_status": false,
    "customer_portal_account_login_available": true,
    "customer_portal_rollout": {
      "account_only": false,
      "all_teams_at": null,
      "configuration_warning": null,
      "legacy_access_allowed": true,
      "new_teams_at": null,
      "reason": "transition"
    },
    "default_pricing_strategy": "job_separately",
    "dimension": "in",
    "enable_stock_management": true,
    "pagination_per_page": 50,
    "payment_amount_policies": {
      "USD": {
        "currency": "USD",
        "minimum_payment": {
          "dp": 3,
          "value": "1000"
        },
        "minimum_remaining_balance": null
      }
    },
    "payment_amount_policy": {
      "currency": "USD",
      "minimum_payment": {
        "dp": 3,
        "value": "1000"
      },
      "minimum_remaining_balance": null
    },
    "paypal_webhook_url": "https://secure.yoprint.com/api/store/your-team/webhook/v1/payment/paypal",
    "pdf_date_format": "us_standard",
    "pdf_sales_order_display_option": [
      "job_summary"
    ],
    "shipping_label_create_cost_line_item": true,
    "square_webhook_url": "https://secure.yoprint.com/api/store/your-team/webhook/v1/payment/square",
    "stripe_webhook_url": "https://secure.yoprint.com/api/store/your-team/webhook/v1/payment/stripe",
    "web_date_format": "default",
    "weight": "lbs"
  },
  "status": 200,
  "success": true
}

AI agents: read /llms.txt; add .md to any page URL for its Markdown. Guides and concepts in one file: /llms-full.txt.

Download the OpenAPI spec Support: support@yoprint.com yoprint.com