BulkGate icon

BulkGate

Interact with the BulkGate API

Address Book → Add Contact

AI-generated

Summary

Add a new contact to the BulkGate address book, specifying contact details and group memberships.

Inputs

  • Groups (required) — One or more group IDs to which the contact will be added.
  • Group Name — Name of a new group to create and add the contact to.
  • Type — Type of contact, either 'person' or 'company'.
  • Phone Mobile (required) — Main phone number of the contact in international format.
  • Phone — Secondary phone number.
  • Title Before — Title before the contact's name.
  • First Name — Contact's first name.
  • Last Name — Contact's last name.
  • Title After — Title after the contact's name.
  • Gender — Gender of the contact; options are male, female, or unknown.
  • Company Name — Name of the company (if contact is a company).
  • Email — Email address of the contact.
  • URL — Website URL of the contact.
  • Street 1 — Primary street address.
  • Street 2 — Secondary street address.
  • City — City of the contact's address.
  • Zip — Postal code.
  • State — State or province.
  • Country — Country code in ISO 3166-1 alpha-2 format.
  • Company Number — Company registration number.
  • Company VAT — Company VAT identification number.
  • Note — Additional notes about the contact.
  • Custom Field 0 — Optional custom field.
  • Custom Field 1 — Optional custom field.
  • Custom Field 2 — Optional custom field.
  • Custom Field 3 — Optional custom field.
  • Custom Field 4 — Optional custom field.
  • Custom Field 5 — Optional custom field.
  • Custom Field 6 — Optional custom field.
  • Custom Field 7 — Optional custom field.
  • Custom Field 8 — Optional custom field.
  • Custom Field 9 — Optional custom field.

Output shape

A single contact record object representing the added contact.

The operation requires at least one group ID or a new group name to associate the contact with groups. Mandatory fields include groups and main phone number. Other fields are optional. The contact is created and assigned to the specified groups or newly created group.

Examples

Example 1: Add individual contact to existing groups with detailed info

Provide one or more group IDs, type as person, required phone number, and optionally name, titles, email, address, gender, and custom fields.

Links

Discussion