---
title: "Update arm profile"
method: PATCH
path: "/v1/arm-profiles/{id}"
tags: ["Arm profile management"]
---

# Update arm profile

`PATCH /v1/arm-profiles/{id}`

## Request

- Base URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/protect/integration`
- URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/protect/integration/v1/arm-profiles/{id}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ubiquiti/apis/unifi-protect-api/docs/v1/arm-profiles/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Update an existing arm profile. Only available when using local alarm manager.

## Path parameters

- `id` string, required: The primary key of armProfile

## Request body

- object
  - `name` string: Name of the arm profile.
  - `automations` AutomationId[]: List of automation IDs associated with this arm profile.
  - `schedules` ArmSchedule[]: List of arm schedules.
    - `start` string, required: Cron expression for the start time.
    - `end` string, required: Cron expression for the end time.
  - `recordEverything` boolean: Whether to record everything when this arm profile is active.
  - `activationDelay` union: Activation delay in milliseconds. Allowed values: 0 (none), 60000 (1 min), 300000 (5 min), 600000 (10 min).
    - 0
    - 60000
    - 300000
    - 600000

## Response `200`

Success response

- ArmProfile
  - `id` string, required: The primary key of armProfile
  - `name` string, required: Name of the arm profile.
  - `automations` AutomationId[], required: List of automation IDs associated with this arm profile.
  - `creator` string, required: The primary key of user
  - `schedules` ArmSchedule[], required: List of arm schedules.
    - `start` string, required: Cron expression for the start time.
    - `end` string, required: Cron expression for the end time.
  - `recordEverything` boolean, required: Whether to record everything when this arm profile is active.
  - `activationDelay` union, required: Activation delay in milliseconds. Allowed values: 0 (none), 60000 (1 min), 300000 (5 min), 600000 (10 min).
    - 0
    - 60000
    - 300000
    - 600000
  - `createdAt` number, required: Arm profile creation time.
  - `updatedAt` number, required: Arm profile update time.

## Other responses

- `default`: Error response

---

[API](https://skmtc.dev/ubiquiti/apis/unifi-protect-api.md) - [All operations](https://skmtc.dev/ubiquiti/apis/unifi-protect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ubiquiti/apis/unifi-protect-api/revisions/e341e1381db1?raw)