eKyte icon

eKyte

Create and retrieve data from eKyte (tasks, projects, tickets, boards, workspaces, notes, notifications)

Insertion Order → Create Address

AI-generated

Overview

This node operation creates an address record associated with a person in the eKyte system. It is useful for adding detailed address information such as street, number, zip code, district, city, state, and flags indicating if the address is for correspondence or billing. This operation is typically used in scenarios where managing contact or billing addresses for individuals is required, such as customer management or invoicing systems.

Use Case Examples

  1. Adding a new billing address for a customer in a CRM system.
  2. Storing a correspondence address for a contact person in a project management tool.

Properties

Name Meaning
Base URL The base URL for the eKyte API endpoint used for the request.
Email The email address of the eKyte user performing this operation.
Person ID The unique identifier of the person to associate this address record with.
Zip Code The postal or zip code of the address.
Address The street name and address line.
Number The street number of the address.
No Number Indicates whether the address has no street number.
Complement Additional address details such as apartment, suite, or floor number.
District The neighborhood or district of the address.
State ID The unique identifier of the state for the address.
City ID The unique identifier of the city for the address.
Is Correspondence Flag indicating if this address is used for correspondence.
Is Charge Flag indicating if this address is used for billing purposes.
Is Main Flag indicating if this is the primary address record for the person.
Notes Additional notes or observations about this address record.

Output

JSON

  • UserEmail - The email of the user performing the operation.
  • PersonId - The unique identifier of the person associated with the address.
  • IsMain - Indicates if this is the primary address.
  • IsCharge - Indicates if this address is used for billing.
  • IsCorrespondence - Indicates if this address is used for correspondence.
  • Address - The street name and address line.
  • ZipCode - The postal or zip code of the address.
  • Number - The street number of the address, if provided.
  • District - The neighborhood or district of the address.
  • NoNumber - Indicates if the address has no street number.
  • Complement - Additional address details such as apartment or suite number.
  • Notes - Additional notes or observations about the address.
  • CityId - The unique identifier of the city.
  • StateId - The unique identifier of the state.

Dependencies

  • An API key credential for eKyte API authentication

Troubleshooting

  • Ensure the 'Person ID' provided is valid and exists in the eKyte system to avoid errors.
  • Verify that the 'Email' parameter corresponds to a valid eKyte user with permissions to create address records.
  • Check network connectivity and the base URL to ensure the API endpoint is reachable.
  • If the API returns an error, review the error message for details such as missing required fields or invalid data formats.

Discussion