HIPE icon

HIPE

Interact with HIPE API

address → Update

AI-generated

Summary

Update an existing address identified by its Address ID with new details such as company affiliation and location information.

Inputs

  • Address ID (required) — ID of the address to update.
  • Company ID — ID of the company associated with the address.
  • Address — Street address or primary address information.
  • City — City of the address.
  • Country — Country of the address.
  • First Complementary Address — Additional first line of address information.
  • Second Complementary Address — Additional second line of address information.
  • Name — Name or label for the address.
  • State — State or province of the address.
  • Zip Code — Postal or zip code of the address.
  • External ID — External identifier for the address.
  • Options — Additional optional parameters for the update (customizable fields).
  • Async Mode — Whether to perform the update asynchronously, returning a job ID instead of waiting for the operation to complete.

Output shape

a single updated address record or, if Async Mode is enabled, an object containing a job ID representing the asynchronous operation

If asynchronous mode is enabled, the node returns immediately with a job ID, and the address update completes in the background. Otherwise, it waits and returns the updated address data upon completion.

Examples

Example 1: Update the city and zip code of an address by its ID, synchronously.

Set 'Address ID' to the target address, provide new 'City' and 'Zip Code' values, leave 'Async Mode' as false.

Example 2: Initiate an asynchronous update to an address’ complementary address lines.

Provide 'Address ID', set 'First Complementary Address' and/or 'Second Complementary Address', enable 'Async Mode'.

Links

Discussion