Update a currency

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

v1Operation ID v1_public_currency_update_put

Changes a currency's name, code or symbol, and returns it. Send only the fields to change.

Changing the default currency's symbol changes how amounts show on PDFs and emails made afterwards, and in formatted amounts. Changing its iso changes the code sent to integrations.

Permission

Needs the Manage Settings permission.

Business rules

• iso, when sent, is exactly 3 characters.
• default is ignored.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The currency's id: a hash id from an earlier answer. Only hash ids work here; anything else answers 404 page_not_found.

  • Example Y3WvW4mbyTw1sO

Request body

application/json, required.

• auto_rateboolean

  Stored but not used or returned.

• defaultboolean

  Ignored.

• isostring

  The three-letter ISO 4217 code, such as CAD. YoPrint checks only that it is 3 characters long, and saves it in capitals.

  • Exactly 3 characters
• namestring
• ratenumber

  Stored but not used or returned.

  • Greater than 0
• symbolstring

Response

200Successful response.

• dataobjectrequired
  Child fields (6)

  • defaultbooleanrequired

    Whether it is the team's currency.

  • idstringrequired
  • isostringrequired

    The three-letter ISO 4217 code, in capitals.

  • namestringrequired
  • symbolstringrequired
  • trashedbooleanrequired
• 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.

  When

  No currency with that id on this team (error.code is null and error.message starts "No query results"), the id is not one of this team's hash ids, or you are not a member of the team (both page_not_found).

  Fix

  Use an id from the list operation and check the team slug.

• 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

  iso is not 3 characters, or rate is 0 or less. 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

• GETShow a currency/v1/api/store/{team_slug}/setting/currency/{hash_id}

Example request

curl

curl -X PUT 'https://secure.yoprint.com/v1/api/store/your-team/setting/currency/Y3WvW4mbyTw1sO' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "symbol": "US$"  }'

Example response 200

Response

{
  "data": {
    "default": true,
    "id": "Y3WvW4mbyTw1sO",
    "iso": "USD",
    "name": "US Dollar",
    "symbol": "US$",
    "trashed": false
  },
  "status": 200,
  "success": true
}