v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB

crm-v1-organizations

Atualizar empresa

put/organizations/{organization_id}

Path parameters

organization_idstring required

ID da empresa.

Request body

Example request

{
  "organization": {
    "name": "Empresa X atualizada",
    "organization_custom_fields": [
      {
        "custom_field_id": "646e73a3651e44000f352486",
        "value": "Valor de exemplo"
      }
    ],
    "organization_segments": [
      "NOME_DO_SEGMENTO1"
    ],
    "resume": "resumo da empresa",
    "url": "http://google.com/",
    "user_id": "5d1e122a572a6c0034f2e595"
  }
}

Response

Success

_idstring

{"stackTrail":"paths:/organizations/{organization_id}:put:responses:200:content:application/json:schema:properties:address","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/organizations/{organization_id}:put:responses:200:content:application/json:schema:properties:address_latitude","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/organizations/{organization_id}:put:responses:200:content:application/json:schema:properties:address_longitude","oasType":"schema","type":"unknown"}

created_atstring

follower_idsstring[]

last_activity_atstring date-time

namestring

resumestring

updated_atstring

urlstring

user_idstring

Example response

{
  "_id": "64d3eb38e42434000114c4bf",
  "contacts": [
    {
      "_id": "64d3eb38e42434000114c4c2",
      "created_at": "2023-08-09T16:38:32.650-03:00",
      "deal_ids": [
        "64d3eb38e42434000114c4c6"
      ],
      "import_id": "64d3eaae77683a001952701d",
      "instance_id": "5b75b4235bdc75002b1b656f",
      "name": "NAME",
      "organization_id": "64d3eb38e42434000114c4bf",
      "updated_at": "2023-08-09T16:38:33.480-03:00",
      "user_id": "618e6cb8a97d2c00178307ba",
      "user_ids": [
        "618e6cb8a97d2c00178307ba"
      ]
    }
  ],
  "created_at": "2023-08-09T16:38:32.461-03:00",
  "follower_ids": [
    "618e6cb8a97d2c00178307ba"
  ],
  "followers": [
    {
      "_id": "5ba93b409bc80e003145f6d9",
      "created_at": "2018-09-24T16:30:08.048-03:00",
      "email": "EMAIL",
      "name": "NAME",
      "updated_at": "2023-08-17T15:02:32.188-03:00"
    }
  ],
  "name": "NAME",
  "organization_custom_fields": [
    {
      "_id": "64eccafbbe76ee000db57125",
      "custom_field_id": "646e73a3651e44000f352486",
      "value": "48484848"
    }
  ],
  "organization_segments": [
    {
      "_id": "60379d41f55752000b83d330",
      "created_at": "2021-02-25T09:51:13.513-03:00",
      "instance_id": "5b75b4235bdc75002b1b656f",
      "name": "NAME",
      "organization_ids": [
        "6398814ee9bb8c0010f0fde5"
      ],
      "updated_at": "2022-12-13T10:42:38.875-03:00"
    }
  ],
  "resume": "resumo da empresa",
  "updated_at": "2023-08-28T13:27:39.018-03:00",
  "url": "http://google.com/",
  "user": {
    "_id": "5d1e122a572a6c0034f2e595",
    "name": "NAME"
  },
  "user_id": "5d1e122a572a6c0034f2e595"
}