API - Create/Update Lead with Zapier

Zapier can create or update leads in your account whenever something happens in another app, such as a form being submitted on your website. This article walks through the setup and lists every field you can fill in.


Setup Steps

  1. Create an API Key.
  2. Copy the key.
  3. Add a new Zap in Zapier.
  4. Set up the trigger.
  5. Set up the action with "InflatableOffice" and select the latest version.
  6. Choose the event:
    • Create Simple Lead creates a lead from a short list of fields. It cannot update a lead.
    • Create Update Lead creates a lead, or updates one, using the full list of fields.
  7. Link up your IO account using the API key created in step 1.
  8. Fill out at least the required fields marked by an asterisk.
  9. Test the action.
  10. Publish the Zap.

Below is a video walkthrough of this process.

Note: the API key needs permission to create leads. Open the key under Settings > API Keys and set Leads Create to Full Access. Each lead Zapier creates or updates counts as an API transaction. See API - Transaction Charges.


Create Simple Lead

Below is a list of all possible fields when creating a simple lead through a Zapier action. This Zapier action is not capable of updating a lead, only creating one.

FieldRequiredDescription
NameNoName of the customer
Mobile PhoneNoCustomer phone number, saved in the cell phone field. We will format this if we can. You can send numbers only
EmailNoCustomer email address
MessageNoThe message or question from the customer, saved to notes on the lead
Lead Date/TimeYesThis is the date and time of the lead. We require a Unix timestamp for it. See the Zapier timestamp values below
Event DurationYesDefault: 1. The customer event duration in hours. If a simple lead form, you can put any decimal value here or take the default of 1
Postal CodeYesThe customer postal or zip code for the lead. You can use your company's postal code if you aren't gathering it from your customer
Item NamesYesDefault: Contact Form-1-0. We require an item that the customer is interested in. In the case of a simple lead, use any text, and we will create that item if it doesn't exist. Use the format "Item Name-Quantity-Price"
Tax ExemptYesDefault: No. Whether the customer is tax exempt or not. Not relevant for simple lead entry
LocationNoDefault: 0. If you are using a multi-location account, use this ID to make sure the lead is created in the appropriate location. A zero can be used if you are not using a multi-location account

Zapier Timestamp Values

The following Zapier values put in a timestamp of when the Zap runs:

ValueWhat it gives you
{{zap_meta_timestamp}}Unix timestamp
{{zap_meta_est_iso}}, {{zap_meta_edt_iso}}ISO-8601 format for Eastern Standard Time (EST) and Eastern Daylight Time (EDT)
{{zap_meta_cst_iso}}, {{zap_meta_cdt_iso}}ISO-8601 format for Central time (CST and CDT)
{{zap_meta_mst_iso}}, {{zap_meta_mdt_iso}}ISO-8601 format for Mountain time (MST and MDT)
{{zap_meta_pst_iso}}, {{zap_meta_pdt_iso}}ISO-8601 format for Pacific time (PST and PDT)

Create/Update Lead

Below is a list of all possible fields when creating or updating a lead through a Zapier action.

Required Fields

FieldDescription
DateThe date the lead came in. The format must match your account date format setting on Settings > Preferences > Account Details
TimeDefault: 12:00pm. Time the lead came in
Postal CodeThe customer postal or zip code for the lead. You can use your company's postal code if you aren't gathering it from your customer
Item NamesDefault: Contact Form-1-0. We require an item that the customer is interested in. In the case of a simple lead, use any text, and we will create that item if it doesn't exist. Use the format "Item Name-Qty-Price:Option Name-Qty-Price|Next Item-Qty-Price"
Tax ExemptWhether the customer is tax exempt or not. Not relevant for simple lead entry
Event DurationDefault: 1. The customer event duration in hours. If a simple lead form, you can put any decimal value here or take the default of 1
Location IDDefault: 0. If you are using a multi-location account, use this ID to make sure the lead is created in the appropriate location. A zero can be used if you are not using a multi-location account

Customer Fields

FieldDescription
NameName of the customer
Mobile PhoneCustomer phone number, saved in the cell phone field. We will format this if we can. You can send numbers only
EmailCustomer email address
Customer IDIf you want to link this lead to a specific customer and update their information, you can do that by supplying the customer ID. Otherwise, we will attempt to match or create a new customer record
OrganizationThe customer's company or organization
Customer Street, Customer City, Customer ZipThe customer's address
Customer StateWe require 2 letter abbreviations for US accounts. For international accounts, abbreviations are encouraged but not required
Customer CountryWe generally use 2 letter country abbreviations
Customer Home PhoneCustomer phone number, saved in the home phone field. We will format this if we can. You can send numbers only
Customer Work PhoneCustomer phone number, saved in the office phone field. We will format this if we can. You can send numbers only
Customer FaxCustomer fax number, used in the fax field. We will format this number, so you can send numbers only
Customer TagsComma delimited tags that you would like attached to a customer
Clear Customer TagsWe can clear tags on a customer when saving if you would like
Customer TypeThis should match one of the customer types you've defined in your account
Customer NotesThese notes travel with the customer, not the lead, and are generally private

Event Fields

FieldDescription
MessageThe message or question from the customer, saved to notes on the lead
Start Time StampThis is a Unix timestamp that, when set, will override the Date and Time fields. Because Zapier doesn't allow us to require either Date/Time or Start Time Stamp, you will have to enter date and time values as well as this value if you are using it
Event Name, Venue NameName of the event and of the venue
Event Street, Event City, Event CountyThe event address
Event StateWe require 2 letter abbreviations for US accounts. For international accounts, abbreviations are encouraged but not required
Event CountryWe generally use 2 letter abbreviations for this field
Venue ContactMost will use this for a phone number, but it can contain other text
SurfaceIt is best to match one of the surfaces you have set in your account
Delivery TypeIt is best to match one of the delivery types you have set in your account
Number of GuestsThis field can be used for other data
Sales Rep IDIf you want to assign a sales rep, you can put their ID in this field
ReferralIt is best to match one of the referrals you have set in your account
Additional Notes 1, Additional Notes 2These notes are saved with the lead
Venue NotesThese notes are saved with the venue
Lead StatusYou can set a lead status. It should match the statuses available in your account. If you do not, we use your account settings to determine a status

Pricing Fields

FieldDescription
Calculate PricesIf you do not want us to use your settings to calculate prices, set to 0 or false. If you do, we save only what you send. You must pass prices in if you choose this
Calculate Line ItemsIf you do not want us to use your settings to calculate line items other than rentals, set to 0 or false. If you do, we save only what you send. You must pass prices in if you choose this
Staff Cost, Distance Charge, Surface Fee, Delivery Method FeeUsed to set prices for common fees
Coupon CodeA coupon code to apply to the lead
Coupon AmountIf not requesting us to calculate prices, you can send a coupon amount to use when sending a Coupon Code
Fee IDUse this to add a fee by ID
Fee AmountUse with Fee ID to set an amount for the selected fee
Admin AdjustmentUse this to adjust the total of the lead via the admin discount value
Tax RateWe will apply the appropriate tax rate when we have address information. You can override by sending the rate
Sales TaxMostly used when updating or sending a lead that you have calculated all values for

Related Links

Is this article helpful?
1 0 0