Update company details

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

v1Operation ID v1_public_setting_update

Changes the team's company details: name, email, phone, website, tax number and timezone. Returns the team, as Get your company details does.

Send only the fields to change. On this operation null clears email, phone, website and tax_number; name and timezone can't be cleared. An empty or blank string clears a field too.

Permission

Needs the Manage Settings permission.

Business rules

• name and timezone, when sent, must not be empty or null. timezone must be a name PHP knows, such as America/New_York: any other text is 422 (error.fields.timezone: "The timezone must be a timezone name, such as America/New_York.").
• email, when not null, must be an email address.
• Surrounding spaces are trimmed from email, phone, website and tax_number.

Side effects

• New PDFs and emails use the new details.

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.

• emailstring (email) | null

  The company email. null clears it.

• namestring

  The company name. Can't be empty or null.

  • At least 1 character
• onboard_statusstring

  Used by the web app's onboarding. Leave it out.

• phonestring | null

  null clears it.

• phone_countrystring

  The phone number's country code, such as US. An empty value is ignored.

• tax_numberstring | null

  The team's tax or VAT number. null clears it.

• timezonestring

  A timezone name such as America/New_York. Can't be empty or null. An unknown name is refused with 422: "The timezone must be a timezone name, such as America/New_York."

• websitestring | null

  null clears it.

Response

200Successful response.

• dataobjectrequired

  The team, with its plan.

  Child fields (25)

  • idstringrequired
  • namestringrequired
  • payment_gatewayarray of objectsrequired

    The gateways customers can pay through, with only their public identifiers. Empty when the plan has no payment integration.

  • planobjectrequired

    The team's YoPrint plan: type (paid, trial or free), active, detail and features. The same as on Get your company details.

    Child fields (4)

    • activeboolean
    • detailobject
    • featuresobject
    • typestring
      • One of: "paid", "trial", "free"
  • slugstringrequired

    The {team_slug} in every path.

  • timezonestringrequired
  • channel_idinteger

    The team's number, used by YoPrint's live-update channel.

  • custom_domainstring | null
  • customer_portal_bgstring | null
  • dimensionstring | null

    The length unit.

  • emailstring | null
  • favicon_urlstring | null

    The customer portal favicon, or null when none is uploaded.

  • ga_idstring | null
  • logo_urlstring | null
  • onboard_statusstring | null
  • phonestring | null
  • phone_countrystring | null
  • plan_regionstring | null
  • printavo_importer_availableboolean
  • printavo_importer_enabledboolean
  • seededboolean
  • tax_numberstring | null
  • trial_expires_atstring (date-time)
  • websitestring | null
  • weightstring | null

    The weight unit.

• statusintegerrequired
• successbooleanrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

  When

  The API key is missing or wrong.

  Fix

  Send your personal API key as Authorization: Bearer YOUR_API_KEY.

• 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 permission group lacks Manage Settings. This 403 has a short body, {"message": "Insufficient Permission"}, without success or error.

  Fix

  Ask the team owner to give your permission group Manage Settings.

• 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

  name or timezone is empty or null, timezone is not a timezone name, or email is not an email address. error.code is validation_failed, and error.fields names each field with its messages.

  Fix

  Fix the fields listed in error.fields and send the request again.

Related

• GETGet your company details/v1/api/store/{team_slug}/setting/detail
• GETShow team settings/v1/api/store/{team_slug}/setting

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/setting' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "email": "alex@example.com",    "name": "Northwind Apparel",    "phone": "+1 201 555 0123",    "website": null  }'

Example response 200

Response

{
  "data": {
    "channel_id": 1001,
    "custom_domain": null,
    "customer_portal_bg": null,
    "dimension": "in",
    "email": "alex@example.com",
    "favicon_url": null,
    "ga_id": null,
    "id": "s8D8dfOtRdUiRt",
    "logo_url": null,
    "name": "Northwind Apparel",
    "onboard_status": "completed",
    "payment_gateway": [],
    "phone": "+1 201 555 0123",
    "phone_country": "US",
    "plan": {
      "active": true,
      "detail": {
        "active": true,
        "name": "Pro",
        "need_to_select_plan": false,
        "status": "active"
      },
      "features": {
        "user_limit": 10
      },
      "type": "paid"
    },
    "plan_region": "US",
    "printavo_importer_available": false,
    "printavo_importer_enabled": false,
    "seeded": true,
    "slug": "your-team",
    "tax_number": null,
    "timezone": "America/New_York",
    "trial_expires_at": "2026-11-03T15:00:00+00:00",
    "website": null,
    "weight": "lbs"
  },
  "status": 200,
  "success": true
}