---
updatedAt: 2026-06-03T14:46:59.000Z
agentTools:
  projectIndex: https://developers.fieldwire.com/llms.txt
---

# Update an account

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Fieldwire Super API",
    "version": "v3"
  },
  "servers": [
    {
      "url": "https://client-api.super.fieldwire.com"
    }
  ],
  "components": {
    "schemas": {
      "account": {
        "type": "object",
        "nullable": false,
        "description": "Information about the account & its owner",
        "required": [
          "id"
        ],
        "additionalProperties": true,
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "nullable": false,
            "description": "ID of the entity"
          },
          "company_address": {
            "type": "string",
            "nullable": true,
            "description": "Address of the company"
          },
          "company_name": {
            "type": "string",
            "nullable": true,
            "description": "Name of the company"
          },
          "has_photo_attachments_toggle": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether photo attachments can be turned on & off"
          },
          "has_tasks_toggle": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether tasks can be turned on & off"
          },
          "is_3d_bim_enabled": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether BIM is enabled"
          },
          "is_submittals_enabled": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether Submittal module is enabled"
          },
          "is_change_orders_enabled": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether Change Orders module is enabled"
          },
          "is_pm_enabled": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether RFI module is enabled"
          },
          "has_pm": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether any PM module is enabled"
          },
          "has_specs": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether specs module is enabled"
          },
          "invoice_email": {
            "type": "string",
            "nullable": true,
            "description": "Email to send the invoice to"
          },
          "owner": {
            "$ref": "#/components/schemas/user"
          }
        }
      },
      "account_update_input": {
        "type": "object",
        "nullable": false,
        "description": "Information about the account to be updated",
        "properties": {
          "account": {
            "type": "object",
            "nullable": false,
            "properties": {
              "company_address": {
                "type": "string",
                "nullable": true,
                "description": "Address of the company"
              },
              "company_name": {
                "type": "string",
                "nullable": true,
                "description": "Name of the company"
              },
              "invoice_email": {
                "type": "string",
                "nullable": true,
                "description": "Email to send the invoice to"
              },
              "owner_user_id": {
                "type": "integer",
                "format": "int32",
                "nullable": false,
                "description": "ID of the user"
              }
            },
            "description": "Information about the account to be updated",
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "user": {
        "type": "object",
        "description": "General information of a user",
        "required": [
          "id",
          "is_email_deliverable",
          "email",
          "first_name",
          "language",
          "last_name",
          "sync_scheme",
          "created_at",
          "updated_at"
        ],
        "nullable": false,
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "ID of user",
            "nullable": false
          },
          "account_id": {
            "type": "integer",
            "format": "int32",
            "nullable": false,
            "description": "ID of the account this user belongs to"
          },
          "invited_by_id": {
            "type": "integer",
            "format": "int32",
            "nullable": true,
            "description": "ID of the user who invited this user to the platform"
          },
          "is_email_deliverable": {
            "type": "boolean",
            "nullable": false,
            "description": "If email can be delivered to this user"
          },
          "company": {
            "type": "string",
            "nullable": true,
            "description": "Name of the company this user belongs to"
          },
          "company_type": {
            "type": "string",
            "nullable": true,
            "enum": [
              "ARCHITECT_SLASH_DESIGNER",
              "GENERAL_CONTRACTOR",
              "OWNER",
              "SPECIALTY_CONTRACTOR",
              "OTHER",
              null
            ],
            "description": "Type of the company this user belongs to"
          },
          "email": {
            "type": "string",
            "nullable": false,
            "description": "Email of this user"
          },
          "first_name": {
            "type": "string",
            "nullable": false,
            "description": "First name of this user"
          },
          "job_title": {
            "type": "string",
            "nullable": true,
            "description": "Title this user holds at their job"
          },
          "language": {
            "type": "string",
            "nullable": false,
            "description": "Preferred language of this user"
          },
          "last_name": {
            "type": "string",
            "nullable": false,
            "description": "Last name of this user"
          },
          "phone_number": {
            "type": "string",
            "nullable": true,
            "description": "Phone number of this user"
          },
          "photo_url": {
            "type": "string",
            "nullable": true,
            "description": "URL where the profile picture of this user lives"
          },
          "email_notifications": {
            "type": "string",
            "enum": [
              "never",
              "daily",
              "instantly",
              null
            ],
            "nullable": true,
            "description": "Email notification preference of this user for delivering task updates"
          },
          "sync_scheme": {
            "type": "string",
            "enum": [
              "smart_cellular",
              "full_cellular"
            ],
            "nullable": false,
            "description": "Synchronization scheme of this user used by the mobile apps"
          },
          "account_role": {
            "type": "string",
            "enum": [
              "account_member",
              "account_admin"
            ],
            "nullable": false,
            "description": "The role of the user in the account they belong to"
          },
          "email_addresses": {
            "type": "array",
            "deprecated": true,
            "nullable": false,
            "description": "Deprecated. Use the \"email\" property instead",
            "items": {
              "type": "object",
              "nullable": false,
              "description": "Email associated with the user account"
            }
          },
          "is_confirmed": {
            "type": "boolean",
            "nullable": false,
            "description": "Whether the user has accepted the invitation if there was one"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the server created this user"
          },
          "current_sign_in_at": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "Last time the user was seen online"
          },
          "in_app_purchase_end_at": {
            "type": "string",
            "format": "date-time",
            "nullable": true,
            "description": "When the in app purchase this user made ends"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "nullable": false,
            "description": "Time when the server last updated this user"
          },
          "trade_type": {
            "type": "string",
            "nullable": true,
            "enum": [
              "CONCRETE",
              "EARTHWORK",
              "ELECTRICAL",
              "FIRE_SUPPRESSION",
              "FRAMING_AND_OR_DRYWALL",
              "HVAC",
              "LOW_VOLTAGE",
              "MECHANICAL",
              "PLUMBING",
              "UTILITIES",
              "OTHER",
              null
            ],
            "description": "Type of the trade this user's company belongs to"
          }
        },
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "jwt": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Access token (JWT) generated using the acquired refresh token (API token). Our [authentication](https://developers.fieldwire.com/docs/authentication) guide covers the steps to generate a valid token"
      }
    }
  },
  "paths": {
    "/account": {
      "patch": {
        "summary": "Update an account",
        "operationId": "update_account",
        "tags": [
          "accounts"
        ],
        "security": [
          {
            "jwt": []
          }
        ],
        "parameters": [],
        "responses": {
          "201": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "example": {
                  "id": 3,
                  "has_tasks_toggle": false,
                  "has_photo_attachments_toggle": false,
                  "company_address": "new_company_address",
                  "company_name": null,
                  "is_3d_bim_enabled": true,
                  "is_submittals_enabled": false,
                  "is_pm_enabled": false,
                  "invoice_city": "San Francisco",
                  "invoice_country": "United States",
                  "invoice_state": "California",
                  "invoice_postal_code": "94080",
                  "invoice_country_iso2": "US",
                  "invoice_email": "new_invoice_email@example.com",
                  "invoice_state_iso2": "CA",
                  "has_specs": true,
                  "has_pm": false,
                  "primary_region": "us",
                  "is_change_orders_enabled": false,
                  "has_workato": false,
                  "owner": {
                    "created_at": "2023-10-17T21:04:50.193Z",
                    "updated_at": "2023-10-17T21:04:50.195Z",
                    "email_addresses": [
                      {
                        "email": "99b77b2c-27fc-4a88-ae6b-a697e3bc41a9@factory.com",
                        "is_primary": true
                      }
                    ],
                    "id": 5,
                    "account_id": 3,
                    "company": "Company",
                    "company_type": null,
                    "email": "99b77b2c-27fc-4a88-ae6b-a697e3bc41a9@factory.com",
                    "first_name": "John",
                    "invited_by_id": null,
                    "is_confirmed": true,
                    "is_email_deliverable": true,
                    "job_title": null,
                    "language": "en",
                    "last_name": "Doe",
                    "phone_number": null,
                    "photo_url": null,
                    "trade_type": null,
                    "current_sign_in_at": "2023-10-17T21:04:50.192Z",
                    "in_app_purchase_end_at": null,
                    "account_role": "account_admin",
                    "email_notifications": "instantly",
                    "sync_scheme": "smart_cellular"
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/account"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/account_update_input"
              }
            }
          },
          "required": true
        }
      }
    }
  }
}
```