---
title: "PUT /organizations/{id}"
method: PUT
path: "/organizations/{id}"
tags: ["organizations"]
---

# PUT /organizations/{id}

`PUT /organizations/{id}`

Update a specific organization by ID.

## Path parameters

- `id` integer, required

## Request body

- PutOrganizations — Update a specific organization by ID.
  - `name` string — Display name (Nome fantasia).
  - `legalName` string — Legal name (Razão social).
  - `cnpj` string — Legal document number (CNPJ).
  - `description` string — Your description of this organization.
  - `logo` string, url — Logo image URL.
  - `website` string, url — Homepage URL.
  - `ranking` 0 | 1 | 2 | 3 | 4 | 5 — Ranking displayed as stars in the organization page.
  - `author` integer — User ID of the author of this organization.
  - `ownerUser` integer — User ID or email of the owner of this organization.
  - `contact` object — Contact information.
    - `email` string, email — Contact email.
    - `work` string — Work phone number.
    - `mobile` string — Mobile phone number.
    - `fax` string — Fax number.
    - `whatsapp` string — WhatsApp phone number. Include country code (DDI) and area code (DDD).
    - `facebook` string, url — Facebook page URL.
    - `twitter` string, url — Twitter profile URL.
    - `instagram` string, url — Instagram profile URL.
    - `linked_in` string, url — LinkedIn profile URL.
    - `skype` string — Skype username.
  - `address` object — Address information.
    - `postal_code` string — Postal code (CEP).
    - `country` string — Country name.
    - `district` string — District name (city division).
    - `state` 'AC' | 'AL' | 'AP' | 'AM' | 'BA' | 'CE' | 'DF' | 'ES' | 'GO' | 'MA' | 'MT' | 'MS' | 'MG' | 'PA' | 'PB' | 'PR' | 'PE' | 'PI' | 'RJ' | 'RN' | 'RS' | 'RO' | 'RR' | 'SC' | 'SP' | 'SE' | 'TO' — State abbreviation. Only Brazilian states supported.
    - `street_name` string — Street name.
    - `street_number` integer — Building number.
    - `additional_info` string — Additional address info.
    - `city` integer — City ID or name.
  - `leadOrigin` integer — Lead origin ID or name.
  - `category` integer — Category ID or name.
  - `sector` integer — Sector ID or name.
  - `products` integer[] — Array of product IDs.
  - `allowedUsers` integer[] — Array of IDs of users that should be able to see this organization.
  - `allowToAllUsers` true — Set true if this organization should be visible to all users.
  - `customFields` object — Custom Fields information. A key-value map where each key is the identifier (name) of a custom field and the value is the desired content. Example: { "customFields": { "custom_field_identifier_1" : "desired value", "custom_field_identifier_2" : "desired value 2" } }

## Response `200`

OK

- object
  - `data` OrganizationEntity
    - `id` integer — Organization ID.
    - `accountId` integer — Account ID.
    - `name` string — Display name (Nome fantasia).
    - `legalName` string — Legal name (Razão social).
    - `email` string, email — Contact email.
    - `cnpj` string — Document number (CNPJ).
    - `description` string — Organization description.
    - `logo` object — Logo image URLs.
      - `full` string, url — Full sized logo image URL.
      - `thumb` string, url — Thumb sized logo image URL.
      - `thumb_large` string, url — Large thumb sized logo image URL.
    - `ranking` 0 | 1 | 2 | 3 | 4 | 5 — Numeric ranking.
    - `website` string, url — Homepage URL.
    - `createdAt` unknown
    - `updatedAt` unknown
    - `products` ProductEntity[] — Associated products.
      - `id` integer — Product ID.
      - `name` string — Product name.
      - `code` string — Product code.
      - `categoryId` integer — Product category id.
      - `price` number, double — Product price.
      - `active` boolean — Product active.
      - `createdAt` unknown
    - `contact` object — Contact information.
      - `email` string, email — Email address.
      - `work` string — Formatted work phone number.
      - `mobile` string — Formatted mobile phone number.
      - `fax` string — Formatted fax number.
      - `ramal` string — Phone line branch number.
      - `radio` string — Radio phone number.
      - `whatsapp` string — WhatsApp phone number.
      - `facebook` string, url — Facebook profile URL.
      - `twitter` string, url — Twitter profile URL.
      - `linkedIn` string, url — LinkedIn profile URL.
      - `skype` string — Skype username.
      - `instagram` string, url — Instagram profile URL.
    - `address` object — Address information.
      - `country` string — Country name.
      - `district` string — District (city subdivision) name.
      - `streetName` string — Street name.
      - `streetNumber` integer — Building number.
      - `additionalInfo` string — Additional address info.
      - `postalCode` string — Postal code (CEP).
      - `state` 'AC' | 'AL' | 'AP' | 'AM' | 'BA' | 'CE' | 'DF' | 'ES' | 'GO' | 'MA' | 'MT' | 'MS' | 'MG' | 'PA' | 'PB' | 'PR' | 'PE' | 'PI' | 'RJ' | 'RN' | 'RS' | 'RO' | 'RR' | 'SC' | 'SP' | 'SE' | 'TO' — State abbreviation.
      - `city` string — City name.
    - `category` object — Associated category.
      - `id` integer — Category ID.
      - `name` string — Category name.
    - `leadOrigin` object — Associated lead origin.
      - `id` integer — Lead origin ID.
      - `name` string — Lead origin name.
    - `sector` object — Associated sector.
      - `id` integer — Sector ID.
      - `name` string — Sector name.
    - `people` LeanPersonEntity[] — First page of people in this organization.
      - `id` integer — Person ID.
      - `name` string — Person name.
      - `email` string, email — Email address.
    - `author` object — User that created this organization.
      - `accountId` integer — Account ID.
      - `id` integer — User ID.
      - `name` string — User name.
    - `ownerUser` object — User that currently owns this organization.
      - `accountId` integer — Account ID.
      - `id` integer — User ID.
      - `name` string — User name.
    - `allowedUsers` LeanUserEntity[] — Users allowed to view this organization.
      - `accountId` integer — Account ID.
      - `id` integer — User ID.
      - `name` string — User name.
    - `customFields` object — Custom fields.
    - `_webUrl` string, url — Web platform URL.

---

[API](https://skmtc.net/agendor/apis/agendor-api.md) · [All operations](https://skmtc.net/agendor/apis/agendor-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/agendor/agendor-api/versions/0d4d34ee9ad4/schema)