--- title: "Update a user" method: POST path: "/users/{id}" tags: ["User"] --- # Update a user `POST /users/{id}` Modify the settings of a user. ## Path parameters - `id` string, required — The unique ID of the resource. ## Request body - object - `email` string — The email address. - `display_name` string — The display name of user. - `enabled` boolean — Allows temporarily disabling the extension. - `mobile_phone` string — The mobile phone number of user. - `work_phone` string — The office phone number of user. - `home_phone` string — The home phone number of user. - `address` string — The address. - `department` string — The department of user. - `enable_audio_recording` boolean — Records all calls and saves audio recordings on server. - `enable_video_recording` boolean — Records all calls and saves video recordings on server. - `enable_dnd` boolean — Enable `Do Not Disturb` or not. - `enable_acb` boolean — Enable `Automatic Callback` or not. - `enable_hot_desking` boolean — Enable hot desking feature or not. - `anonymous_outbound_calls` boolean — Always make outbound anonymous calls or not. - `delivery_outbound_cid` boolean — Always delivery outbound caller ID or not. - `sms` 'DISABLE' | 'ALLOW' | 'ALLOW_WITH_SENDER_ID' — The preferred configuration for SMS/MMS. Note: Only users with `UserManagement::Users` privilege can change this property. - `DISABLE`: Disable user SMS/MMS feature. - `ALLOW`: Enable user SMS/MMS feature but with outbound caller ID. - `ALLOW_WITH_SENDER_ID`: Enable user SMS/MMS but with trunk sender ID. - `outbound_caller_ids` object[] — A collection of outbound caller IDs. - `provider_id` string — The unique ID of the resource. - `caller_id` string — Outbound caller id. - `description` string — The descriptive information about this outbound caller id. - `custom_options` string — Some custom configuration options serialized as json string - `office_hours` object - `mode` 'GLOBAL' | 'CUSTOM' — The office hours mode can be either: - `GLOBAL`: Use global office hours. - `CUSTOM`: Use specific office hours. - `monday` object - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time. - `ranges` object[] — Multiple start and end time periods make up the working time. - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`. - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`. - `tuesday` object - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time. - `ranges` object[] — Multiple start and end time periods make up the working time. - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`. - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`. - `wednesday` object - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time. - `ranges` object[] — Multiple start and end time periods make up the working time. - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`. - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`. - `thursday` object - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time. - `ranges` object[] — Multiple start and end time periods make up the working time. - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`. - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`. - `friday` object - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time. - `ranges` object[] — Multiple start and end time periods make up the working time. - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`. - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`. - `saturday` object - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time. - `ranges` object[] — Multiple start and end time periods make up the working time. - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`. - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`. - `sunday` object - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time. - `ranges` object[] — Multiple start and end time periods make up the working time. - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`. - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`. - `available_office_hours_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'RING_ANYWAY' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `RING_ANYWAY`: Ring anyway. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `available_non_office_hours_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'RING_ANYWAY' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `RING_ANYWAY`: Ring anyway. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `available_no_answer_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `timeout` integer — Duration that the call will remain ringing when no one answered, in seconds. - `busy_office_hours_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'RING_ANYWAY' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `RING_ANYWAY`: Ring anyway. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `busy_non_office_hours_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'RING_ANYWAY' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `RING_ANYWAY`: Ring anyway. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `busy_no_answer_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `timeout` integer — Duration that the call will remain ringing when no one answered, in seconds. - `dnd_office_hours_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `dnd_non_office_hours_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `away_office_hours_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `away_non_office_hours_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `lunch_office_hours_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `lunch_non_office_hours_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `trip_office_hours_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `trip_non_office_hours_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `offline_office_hours_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `offline_non_office_hours_forward_rule` object - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `custom_forward_rules` object[] - `action` 'FORWARD_TO_NUMBER' | 'FORWARD_TO_VOICEMAIL' | 'RING_ANYWAY' | 'HANGUP' — Forward action includes: - `FORWARD_TO_NUMBER`: Forward to the specified number - `FORWARD_TO_VOICEMAIL`: Forward to the specified voicemail. - `RING_ANYWAY`: Ring anyway. - `HANGUP`: Finish call - `number` string — Specify the forwarding destination number. Can be either: - Extension number: The extension number of PortSIP PBX. - External number: The numeric sequence of numbers, with or without a plus sign at the beginning. - `caller_id` string — Specify the caller ID mask. - `type` 'ALL_HOURS' | 'SPECIFIC_HOURS' | 'OUTSIDE_SPECIFIC_HOURS' — Specify hours mode for forward rule: - `ALL_HOURS`: - `SPECIFIC_HOURS`: - `OUTSIDE_SPECIFIC_HOURS`: - `hours` object — Specify hours for this custom forward rule. - `monday` object - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time. - `ranges` object[] — Multiple start and end time periods make up the working time. - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`. - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`. - `tuesday` object - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time. - `ranges` object[] — Multiple start and end time periods make up the working time. - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`. - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`. - `wednesday` object - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time. - `ranges` object[] — Multiple start and end time periods make up the working time. - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`. - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`. - `thursday` object - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time. - `ranges` object[] — Multiple start and end time periods make up the working time. - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`. - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`. - `friday` object - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time. - `ranges` object[] — Multiple start and end time periods make up the working time. - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`. - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`. - `saturday` object - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time. - `ranges` object[] — Multiple start and end time periods make up the working time. - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`. - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`. - `sunday` object - `enabled` boolean — When enabled, all day is working time, when disabled, all day is vacation time. - `ranges` object[] — Multiple start and end time periods make up the working time. - `from` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "09:00". Must be earlier than `to`. - `to` string — The start time for office hour with format `HH:MM` in 24 hour clock, such as "17:00". Must be later than `from`. - `voicemail_prompt` string — BCP 47 Language Tags (The Internet Best Current Practices (BCP) for language tags). A language tag is composed of a sequence of one or more subtags such as language, region, variant and script subtags. When a language tag is comprised of more than one subtag, the subtag values are separated by the "-" character. You will most commonly find language tags written with 2 subtags - language and region. For example: en-US. - `enable_voicemail_pin` boolean — Whether the PIN is required to access voice mail of extension. - `voicemail_pin` string — The PIN number for accessing. The PIN policies include: 1. A sequence of numbers 6-10 digits in length. 2. No repeating numbers (e.g. "111", "222") 3. No sequential numbers (e.g. "012", "789") - `enable_voicemail_notify` boolean — Enable voicemail to email notify. - `voicemail_play_datetime` 'DISABLE' | '12_HOUR_CLOCK' | '24_HOUR_CLOCK' — Announces Date and Time of Message. - `DISABLE`: Do not read; - `12_HOUR_CLOCK`: Read in 12-hour clock; - `24_HOUR_CLOCK`: Read in 24-hour clock. - `interface` 'WEB_DOMAIN' | 'PUBLIC_IPV4' | 'PUBLIC_IPV6' | 'PRIVATE_IPV4' | 'PRIVATE_IPV6' | 'SBC_DOMAIN' — The interface type for QR code or auto provisioning. Can be neither: - `WEB_DOMAIN`: - `PUBLIC_IPV4`: - `PUBLIC_IPV6`: - `PRIVATE_IPV4`: - `PRIVATE_IPV6`: - `SBC_DOMAIN`: - `preferred_transport` 'UDP' | 'TCP' | 'TLS' — The transport protocol: Can be either: - `UDP`: - `TCP`: - `TLS`: - `blfs` object[] — A collection of BLFs. - `key` string — The key of BLF. - `value` string — The value of BLF. - `first_name` string — The first name of BLF. - `last_name` string — The last name of BLF. ## Response `200` OK ## Other responses - `4XX` — Error --- [API](https://skmtc.net/portsip/apis/portsip-pbx-rest-api.md) · [All operations](https://skmtc.net/portsip/apis/portsip-pbx-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portsip/portsip-pbx-rest-api/revisions/577415d4a3d5/schema)