Update a service location (PATCH)

PATCH/v1/api/store/{team_slug}/service_location/{hash_id}

v1Operation ID v1_public_service_location_update_patch

Renames or enables or disables a service location, and returns it. Deleted ones can be changed too.

Use PUT: it checks name. PATCH takes the same body but checks nothing. enable is never checked: send a JSON boolean.

Permission

Needs the Manage Services permission at the level that can update services.

Path parameters

• team_slugstringrequired

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

  • Example your-team
• hash_idstringrequired

  The service location's id (id from List service locations). A hash id from an earlier answer; unique keys and document numbers (such as PO0042) don't work here.

  • Example EDhVUaC6jbLbed

Request body

application/json, required.

• enableboolean
• namestring

Response

200Successful response.

• dataobjectrequired
  Child fields (5)

  • enablebooleanrequired
  • idstringrequired
  • namestring | nullrequired
  • servicesarray of objectsrequired

    The services offered at this location.

    Fields of each item (2)

    • idstringrequired
    • namestring | nullrequired
  • trashedbooleanrequired
• 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 cannot update services. This 403 has a short body, {"message": "Insufficient Permission"}, with no success or error.

  Fix

  Ask a team owner to raise Manage Services for your role.

• 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 service location with this id in the team. error.code is null and error.message names the record type.

  Fix

  Check the id.

Related

• GETGet a service location/v1/api/store/{team_slug}/service_location/{hash_id}

Example request

curl

curl -X PATCH 'https://secure.yoprint.com/v1/api/store/your-team/service_location/EDhVUaC6jbLbed' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "name": "Shirt - Left Chest (small)"  }'

Example response 200

Response

{
  "data": {
    "enable": true,
    "id": "454DGJ3i6EQpq0",
    "name": "Shirt - Left Chest (small)",
    "services": [
      {
        "id": "IIVE3hadAUOmIA",
        "name": "Screen printing"
      }
    ],
    "trashed": false
  },
  "status": 200,
  "success": true
}