Contacts and Leads

Update A Organization

Update organization

post/v1/organization/{organization_id}

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/organization/{organization_id}
  • Auth: API key in header X-Imobzi-Secret

Path parameters

organization_idstring required

Request body

Example request

{
  "organization": {
    "properties": [
      {
        "field_values": [
          {
            "field_id": "guarantor",
            "type": "boolean",
            "value": "True"
          },
          {
            "field_id": "bail",
            "type": "boolean",
            "value": "False"
          },
          {
            "field_id": "surety_bond",
            "type": "boolean",
            "value": "False"
          },
          {
            "field_id": "bond_application",
            "type": "boolean",
            "value": "True"
          },
          {
            "field_id": "credpago_guarantee",
            "type": "boolean",
            "value": "True"
          },
          {
            "field_id": "iptu",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "condominium",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "water",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "gas",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "light",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "cleaning_fee",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "value_to_fire_insurance",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "approx_fire_insurance_value",
            "type": "float",
            "value": "True"
          },
          {
            "field_id": "high_standard",
            "type": "boolean",
            "value": "True"
          },
          {
            "field_id": "with_plaque",
            "type": "boolean",
            "value": "True"
          },
          {
            "field_id": "exclusivity",
            "type": "boolean",
            "value": "False"
          },
          {
            "field_id": "private",
            "type": "boolean",
            "value": "False"
          }
        ]
      }
    ],
    "field_values": [
      {
        "field_id": "address",
        "type": "string",
        "value": "Rua Funchal, 500"
      },
      {
        "field_id": "address_complement",
        "type": "string",
        "value": "Casa"
      },
      {
        "field_id": "city",
        "type": "string",
        "value": "São Paulo"
      },
      {
        "field_id": "country",
        "type": "string",
        "value": "Brasil"
      },
      {
        "field_id": "marital_status",
        "type": "string",
        "value": "Solteiro (a)"
      },
      {
        "field_id": "municipal_registration",
        "type": "string",
        "value": "685.931.250.233"
      },
      {
        "field_id": "neighborhood",
        "type": "string",
        "value": "Vila Olímpia"
      },
      {
        "field_id": "phone",
        "type": "list",
        "value": [
          {
            "alpha2Code": "br",
            "number": "(11) 9123-4567",
            "type": ""
          }
        ]
      },
      {
        "field_id": "site",
        "type": "string",
        "value": "imobzi.com"
      },
      {
        "field_id": "social_network",
        "type": "list",
        "value": [
          {
            "account": "facebook.com",
            "name": "Facebook"
          }
        ]
      },
      {
        "field_id": "state",
        "type": "string",
        "value": "SP"
      },
      {
        "field_id": "state_registration",
        "type": "string",
        "value": "685.931.250.233"
      },
      {
        "field_id": "trading_name",
        "type": "string",
        "value": "Trading Name"
      },
      {
        "field_id": "zipcode",
        "type": "string",
        "value": "04551-060"
      },
      {
        "field_id": "email",
        "type": "list",
        "value": "example@example.com"
      }
    ]
  }
}

Response

Successful Response

activeboolean nullable

Indicates whether the contact is active

favoriteboolean nullable

Marks the contact as a favorite

fullnamestring nullable

Full name of the contact (required for creation person, contact or lead not required for organization)

namestring nullable

Short name or nickname of the organization (required for creating organization, not required for creating a person, contact or lead)

emailstring nullable

Email address of the contact

contact_typeunknown
created_atstring nullable

Timestamp when the contact was created

databasestring nullable

Associated database name or ID

ageinteger nullable

Age of the contact, if applicable

media_sourcestring nullable

Primary media source associated with the contact

profile_image_urlstring nullable

URL of the contact's profile image

profile_imagestring nullable

Base64 or path to the contact's profile image

tagsstring[]
crisp_people_idstring nullable

ID used by Crisp for chat integrations

db_keystring nullable

Database key or token for internal reference

deal_rotation_idstring nullable

ID of the rotation rule for deals

last_updated_atnumber nullable

Timestamp of the last update

member_databasestring nullable

Database ID of the member who owns the contact

member_register_idstring nullable

Registration ID of the member

network_group_member_sharedboolean nullable

Indicates if the contact is shared via a network group

privateboolean nullable

If true, this contact is private to the creator

payerboolean nullable

Indicates if this contact is a payer (e.g., in a rental deal)

image_urlstring nullable

URL of a custom image for the contact

review_pendingboolean nullable

Indicates if the contact is pending review

revision_keystring nullable

Key used to control revisions or updates

typestring nullable

Organizations type

chat_idstring nullable
account_idstring nullable
cnpjstring nullable

Company CNPJ (required if CPF is not provided)

cpfstring nullable

Personal CPF (required if CNPJ is not provided)

not_search_profile_pictureboolean nullable

Skip automatic profile picture lookup

tags_in_databoolean nullable

Flag to indicate if tags are already embedded in the data

ignore_reassign_managerboolean nullable

Indicates whether the contact can have a manager reassigned on rotations

locationstring nullable

Example response

{
  "properties": [
    {
      "field_values": [
        {
          "field_id": "guarantor",
          "type": "boolean",
          "value": "True"
        },
        {
          "field_id": "bail",
          "type": "boolean",
          "value": "False"
        },
        {
          "field_id": "surety_bond",
          "type": "boolean",
          "value": "False"
        },
        {
          "field_id": "bond_application",
          "type": "boolean",
          "value": "True"
        },
        {
          "field_id": "credpago_guarantee",
          "type": "boolean",
          "value": "True"
        },
        {
          "field_id": "iptu",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "condominium",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "water",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "gas",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "light",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "cleaning_fee",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "value_to_fire_insurance",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "approx_fire_insurance_value",
          "type": "float",
          "value": "True"
        },
        {
          "field_id": "high_standard",
          "type": "boolean",
          "value": "True"
        },
        {
          "field_id": "with_plaque",
          "type": "boolean",
          "value": "True"
        },
        {
          "field_id": "exclusivity",
          "type": "boolean",
          "value": "False"
        },
        {
          "field_id": "private",
          "type": "boolean",
          "value": "False"
        }
      ]
    }
  ],
  "field_values": [
    {
      "field_id": "address",
      "type": "string",
      "value": "Rua Funchal, 500"
    },
    {
      "field_id": "address_complement",
      "type": "string",
      "value": "Casa"
    },
    {
      "field_id": "city",
      "type": "string",
      "value": "São Paulo"
    },
    {
      "field_id": "country",
      "type": "string",
      "value": "Brasil"
    },
    {
      "field_id": "marital_status",
      "type": "string",
      "value": "Solteiro (a)"
    },
    {
      "field_id": "municipal_registration",
      "type": "string",
      "value": "685.931.250.233"
    },
    {
      "field_id": "neighborhood",
      "type": "string",
      "value": "Vila Olímpia"
    },
    {
      "field_id": "phone",
      "type": "list",
      "value": [
        {
          "alpha2Code": "br",
          "number": "(11) 9123-4567",
          "type": ""
        }
      ]
    },
    {
      "field_id": "site",
      "type": "string",
      "value": "imobzi.com"
    },
    {
      "field_id": "social_network",
      "type": "list",
      "value": [
        {
          "account": "facebook.com",
          "name": "Facebook"
        }
      ]
    },
    {
      "field_id": "state",
      "type": "string",
      "value": "SP"
    },
    {
      "field_id": "state_registration",
      "type": "string",
      "value": "685.931.250.233"
    },
    {
      "field_id": "trading_name",
      "type": "string",
      "value": "Trading Name"
    },
    {
      "field_id": "zipcode",
      "type": "string",
      "value": "04551-060"
    },
    {
      "field_id": "email",
      "type": "list",
      "value": "example@example.com"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.