Company settings

API reference › Team settings

Your company's profile, logo, customer portal look, custom domain, general preferences and list columns.

14 operations

• POSTUpload the customer portal background/v1/api/store/{team_slug}/setting/customer_portal_bgUploads the background image of your customer portal as multipart/form-data, in the field media.
• POSTUpload the customer portal favicon/v1/api/store/{team_slug}/setting/customer_portal_faviconUploads the favicon of your customer portal, the small icon in the browser tab, as multipart/form-data in the field media.
• POSTUpload the team logo/v1/api/store/{team_slug}/setting/photoUploads a new team logo as multipart/form-data, in the field media.
• GETShow team settings/v1/api/store/{team_slug}/settingReturns the team's settings as one object keyed by setting name: PDF and display options, date formats, tax labels, customer portal options and more, with defaults filled in for options the team never changed.
• PUTCheck a custom domain is allowed/v1/api/store/{team_slug}/setting/custom_domain/checkRuns the same checks as "Set the custom domain" without saving anything.
• PUTCheck a custom domain's DNS/v1/api/store/{team_slug}/setting/custom_domain/check_setupChecks that the domain has a CNAME record pointing to domain.yoprint.com, using public DNS.
• GETGet your company details/v1/api/store/{team_slug}/setting/detailReturns your team's profile: name, slug, contact details, timezone, units, logo, customer portal background and favicon, custom domain and plan.
• PUTUpdate company details/v1/api/store/{team_slug}/settingChanges the team's company details: name, email, phone, website, tax number and timezone.
• PUTSet the columns of a list/v1/api/store/{team_slug}/setting/columnSaves 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.
• PUTSet the custom domain/v1/api/store/{team_slug}/setting/custom_domain/updateSets the domain your customer portal is served on, for example shop.example.com or a subdomain of yoprintmerch.com.
• PUTUpdate general settings/v1/api/store/{team_slug}/setting/generalChanges the team's general settings: units and date formats, PDF options, order and quote default dates, customer portal options, approval terms, tax labels, supplier catalogs and inventory automation.
• DELETERemove the customer portal background/v1/api/store/{team_slug}/setting/customer_portal_bgRemoves the customer portal background image.
• DELETERemove the customer portal favicon/v1/api/store/{team_slug}/setting/customer_portal_faviconRemoves the customer portal favicon.
• DELETERemove the team logo/v1/api/store/{team_slug}/setting/photoRemoves the team logo from YoPrint and the customer portal.