---
title: "Replace agent"
method: PUT
path: "/v1/Agents/{id}"
tags: ["Agents"]
---

# Replace agent

`PUT /v1/Agents/{id}`

Replace an existing agent.

## Path parameters

- `id` integer, required

## Request body

- RevAppPostModelsAgent
  - `agent_id` integer — Primary identifier for this agent.
  - `parent_agent_id` integer — Foreign identifier indicating a parent agent.
  - `agent_type_id` integer — Foreign identifier indicating the type of agent.
  - `default_commission_plan_id` integer — Foreign identifier indicating the commission plan assigned to the agent.
  - `address_id` integer — Foreign identifier indicating the address for this agent.
  - `account_number` string — Customizable account identifier.
  - `name` string — Name of the agent or agency.
  - `email` string — Primary contact email (or emails separated by comma).
  - `phone` string — Primary contact phone number.
  - `fax` string — Primary contact fax number.
  - `status` 'ACTIVE' | 'INACTIVE', required — Current status of the agent.
  - `show_unrestricted_packages` boolean — Indicates whether the agent can see packages that are not restricted any particular agent. Even when enabled, packages restricted to a different agent are still hidden.
  - `tax_identification_number` string — Tax identification number (i.e. SSN, EIN).
  - `company_bill_profile_id` integer — Foreign identifier indicating the bill profile associated with this agent.
  - `created_date` string, date-time — Date and time this agent was created.
  - `created_by` integer — Foreign identifier indicating the user who created this agent.
  - `logo_file_id` integer — Foreign identifier indicating the file that contains the agent logo.
  - `fields` RevAppModelsFieldValue[] — List of custom fields and their values.
    - `field_id` integer — Primary identifier for this custom field.
    - `label` string — User-defined identifier representing the custom field.
    - `value` string — Value of the custom field.
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string
  - `links` RevAppComponentsLink[]
    - `rel` string
    - `href` string

## Response `200`

OK

- RevWebAPIModelsSuccess
  - `ok` boolean

## Other responses

- `400` — BadRequest
- `500` — InternalServerError

---

[API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/revisions/135571434f6c/schema)