---
updatedAt: 2026-04-27T16:09:54.000Z
agentTools:
  projectIndex: https://developer.deputy.com/llms.txt
---

# Update an existing area

Update an existing area.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Deputy V2 API",
    "version": "1.0",
    "description": "\n\nFiltered to publicly-authenticated routes only (APIAuthenticator). Scoped-OAuth routes and internal JWT routes are excluded — see the separate \"Deputy V2 Scoped API\" spec for scoped endpoints."
  },
  "servers": [
    {
      "url": "https://{subdomain}.{region}.deputy.com/api",
      "description": "Deputy tenant",
      "variables": {
        "subdomain": {
          "default": "your-subdomain",
          "description": "Your Deputy tenant subdomain"
        },
        "region": {
          "default": "deputy",
          "enum": [
            "au",
            "eu",
            "na",
            "deputy"
          ],
          "description": "Deputy region: au, eu, na, or deputy (AU default)"
        }
      }
    }
  ],
  "components": {
    "schemas": {
      "AreaProfileUpdateResponse": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "data": {
            "$ref": "#/components/schemas/v2modelAreaProfile"
          }
        },
        "title": "Update Area response"
      },
      "modelAreaProfileLocationGeo": {
        "type": "object",
        "properties": {
          "latitude": {
            "type": "number",
            "format": "double"
          },
          "longitude": {
            "type": "number",
            "format": "double"
          }
        }
      },
      "modelAreaType": {
        "type": "string",
        "enum": [
          "DEFAULT_AREA",
          "AREA_WITH_GEO"
        ],
        "default": "DEFAULT_AREA"
      },
      "tenantlocationv2modelAddress": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "title": "Address Id"
          },
          "street": {
            "type": "string",
            "title": "Street address line"
          },
          "state": {
            "type": "string",
            "title": "State code, e.g: 'CA' for California or 'NSW' for New South Wales"
          },
          "postcode": {
            "type": "string",
            "title": "Postcode"
          },
          "country": {
            "type": "string",
            "title": "Country code, e.g: 'US' for the United States of America, 'AU' for Australia"
          },
          "verifiedAt": {
            "type": "string",
            "format": "date-time",
            "title": "Timestamp of when the address was last verified"
          },
          "note": {
            "type": "string",
            "title": "Note"
          },
          "print": {
            "type": "string",
            "title": "[read-only] Print address in a single line string"
          }
        },
        "title": "Address data as response"
      },
      "v2modelAreaProfile": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "title": "Area ID"
          },
          "name": {
            "type": "string",
            "title": "Area name"
          },
          "locationId": {
            "type": "integer",
            "format": "int32",
            "title": "Location ID"
          },
          "parentId": {
            "type": "integer",
            "format": "int32",
            "title": "Parent ID"
          },
          "workType": {
            "type": "string",
            "title": "Area work type"
          },
          "isActive": {
            "type": "boolean",
            "title": "If Area is active"
          },
          "exportCode": {
            "type": "string",
            "title": "Area export code"
          },
          "addressId": {
            "type": "integer",
            "format": "int32",
            "title": "Area address ID"
          },
          "contactId": {
            "type": "integer",
            "format": "int32",
            "title": "Area contact ID"
          },
          "rosterSortOrder": {
            "type": "integer",
            "format": "int32",
            "title": "Sort order of area in roster"
          },
          "isOnRoster": {
            "type": "boolean",
            "title": "If Area appears on roster"
          },
          "color": {
            "type": "string",
            "title": "Assigned Area color"
          },
          "areaType": {
            "$ref": "#/components/schemas/modelAreaType",
            "title": "Area type"
          },
          "createdById": {
            "type": "integer",
            "format": "int32",
            "title": "Employee ID of who created the shift"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "title": "Timestamp when the Area was created"
          },
          "modifiedAt": {
            "type": "string",
            "format": "date-time",
            "title": "Timestamp when the Area was modified"
          },
          "address": {
            "$ref": "#/components/schemas/tenantlocationv2modelAddress",
            "title": "Address object"
          },
          "geo": {
            "$ref": "#/components/schemas/modelAreaProfileLocationGeo"
          }
        },
        "title": "Area profile"
      }
    },
    "securitySchemes": {
      "ApiToken": {
        "type": "apiKey",
        "in": "header",
        "name": "OAuth"
      }
    }
  },
  "paths": {
    "/management/v2/areas/{id}": {
      "put": {
        "summary": "Update an existing area",
        "operationId": "AreaProfileV2Controller_update",
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AreaProfileUpdateResponse"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "tags": [
          "Area Profile"
        ],
        "description": "Update an existing area.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/v2modelAreaProfile"
              }
            }
          }
        }
      }
    }
  },
  "security": [
    {
      "ApiToken": []
    }
  ]
}
```