Save your preferences for this team

POST/v1/api/store/{team_slug}/current_user_preference

v1Operation ID v1_public_current_user_preference_update

Merges preference into your saved preferences on this team and returns the result. The merge is one level deep: each top-level key you send replaces that key whole, and keys you leave out stay as they were.

Keys can't be removed: a null value, at any depth, is dropped before it reaches YoPrint, except under a few key names YoPrint keeps nulls for on every request (such as start_date, due_date or billing_address_id), which are saved as null. These settings drive the YoPrint web app, so changing keys it uses changes what you see there.

Permission

Your own preferences only.

Business rules

• Send preference as a JSON object. Nothing inside it is checked. Left out, empty, false or 0, nothing changes.

Side effects

• Your other open YoPrint tabs pick up the change.

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, optional.

• preferenceobject

  Top-level keys to set. Send an object. Left out or empty, nothing changes and the answer is your current preferences.

Response

200Successful response.

• dataobject | arrayrequired

  All your preferences after the merge. An empty array [] when there are none.

  Child fields (3)

  • column_orderobject | array

    Grid column layouts, keyed by the web app's grid name. Each value is that grid's list of column states. An empty one reads back as [].

  • sales_order_open_behaviorobject | array

    How the web app opens a sales order from each place. An empty one reads back as [].

    Child fields (3)

    • global_searchstring
      • One of: "preview_window", "full_page", "new_tab"
    • related_linkstring
      • One of: "preview_window", "full_page", "new_tab"
    • sales_order_liststring
      • One of: "preview_window", "full_page", "new_tab"
  • versionnumber

    The web app's version of these settings.

• 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.

• 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.

• 500A business rule refused the request (see the operation's errors), or something failed inside YoPrint. Refusals use the error envelope with a code such as action_not_allowed; an unexpected failure answers {"message": "Server Error"}. Repeating a refusal gets the same answer; after an unexpected failure, read the record back before you retry a change.

  When

  preference is a string, a number or true instead of an object: a server error, not a 422. Empty values ("", 0, false) change nothing instead.

  Fix

  Send an object.

Related

• GETGet your preferences for this team/v1/api/store/{team_slug}/current_user_preference

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/current_user_preference' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "preference": {      "sales_order_open_behavior": {        "global_search": "new_tab",        "related_link": "preview_window",        "sales_order_list": "full_page"      }    }  }'

Example response 200

Response

{
  "data": {
    "sales_order_open_behavior": {
      "global_search": "new_tab",
      "related_link": "preview_window",
      "sales_order_list": "full_page"
    },
    "version": 1
  },
  "status": 200,
  "success": true
}