Supported API parameters

The full list of parameters which are supported is as follows. This list will be expanded as the API evolves.

If you’re developing your own plugin that works with the Light Blue API, or sending data directly from another service, you should check out the list of advanced parameters that users of our own plugins don’t usually need to use.

KeyMaps toTypeNotes
MessageText LongThis message is displayed in the Inbox, and when you link it to a record in Light Blue it will appear in that record’s Activity panel. If your contact form includes a message field, you should map it to this parameter.
ContactNameFullContact First Name and Contact Last NameTextSplit into first name (the first word) and last name (all subsequent words); used to populated Contact First Name and Contact Last Name.
ContactNameFirstContact First NameText 
ContactNameLastContact Last NameText 
ContactNameMaidenContact Maiden NameText 
ContactRoleContact Link RoleText 
ContactTitleContact TitleText 
ContactDateOfBirthContact Date of BirthDate 
ContactSourceContact SourceText 
ContactMailingListContact Mailing List Opt-InBoolean 
ContactEmailContact EmailTextWhen you import this from your Inbox into Light Blue, the label for this email will be your default label.
ContactPhoneHomeContact PhoneTextWhen you import this from your Inbox into Light Blue, the label for this phone number will always be ‘Home’, regardless of your default.
ContactPhoneWorkContact PhoneTextWhen you import this from your Inbox into Light Blue, the label for this phone number will always be ‘Work’, regardless of your default.
ContactPhoneMobileContact PhoneTextWhen you import this from your Inbox into Light Blue, the label for this phone number will always be ‘Mobile’, regardless of your default.
ContactPhoneContact Phone NumberText 
ContactPhoneTypeContact Phone Number LabelText 
ContactWebsiteContact WebsiteTextWhen you import this from your Inbox into Light Blue, the label for this email will be your default label.
ContactAddress1Address 1TextWhen you import this from your Inbox into Light Blue, the label for this address will be set to your default address type.
ContactAddress2Address 2TextWhen you import this from your Inbox into Light Blue, the label for this address will be set to your default address type.
ContactAddress3Address 3TextWhen you import this from your Inbox into Light Blue, the label for this address will be set to your default address type.
ContactAddressCityAddress CityTextWhen you import this from your Inbox into Light Blue, the label for this address will be set to your default address type.
ContactAddressCountyAddress CountyTextContactAddressCounty and ContactAddressState are interchangeable. When you import this from your Inbox into Light Blue, the label for this address will be set to your default address type.
ContactAddressStateAddress StateTextContactAddressCounty and ContactAddressState are interchangeable. When you import this from your Inbox into Light Blue, the label for this address will be set to your default address type.
ContactAddressPostCodeAddress Post CodeTextContactAddressPostCode and ContactAddressZIPCode are interchangeable. When you import this from your Inbox into Light Blue, the label for this address will be set to your default address type.
ContactAddressZIPCodeAddress ZIP CodeTextContactAddressPostCode and ContactAddressZIPCode are interchangeable. When you import this from your Inbox into Light Blue, the label for this address will be set to your default address type.
ContactAddressCountryAddress CountryTextWhen you import this from your Inbox into Light Blue, the label for this address will be set to your default address type.
ContactVATNumberContact VAT NumberText 
ContactNotesContact NotesText Long 
ContactCustomTextXContact Custom Text XTextX is 1 through 10 (eg ContactCustomText1) and maps to the matching custom field in Light Blue.
ContactCustomDateXContact Custom Date XDateX is 1 through 5 (eg ContactCustomDate1) and maps to the matching custom field in Light Blue.
ContactCustomAmountXContact Custom Amount XCurrencyX is 1 through 5 (eg ContactCustomAmount1) and maps to the matching custom field in Light Blue.
GroupContactsBooleanIf your API request includes multiple contacts (see below), setting GroupContacts to False prevents Light Blue from automatically grouping the contacts for you. GroupContacts defaults to True.
ShootTitleShoot TitleText 
ShootTypeShoot TypeTextMust precisely match an existing shoot type name, or it will be ignored when importing from the Inbox into Light Blue.
ShootDateSession DateDate 
ShootTimeStartSession Start TimeTime 
ShootTimeEndSession End TimeTime 
ShootStartTimestampSession Start Date & TimeTimestampIntroduced in Light Blue 5.1
ShootEndTimestampSession End Date & TimeTimestampIntroduced in Light Blue 5.1
ShootLocationShoot LocationText 
ShootEnquirySourceShoot Enquiry SourceText 
ShootReferralSourceShoot Referral SourceTextThe Shoot Referral Source field is only displayed in Light Blue if the Shoot Enquiry Source field is set to “referral”, so you should make sure that you specify ShootEnquirySource in the same API call as one that uses ShootReferralSource.
ShootRequestsShoot RequestsText LongWhen importing, this will be split on end of line characters, with one request created for each line. Blank lines are ignored.
ShootNotesShoot NotesText Long 
ShootCustomTextXShoot Custom Text XTextX is 1 through 10 (eg ShootCustomText1) and maps to the matching custom field in Light Blue.
ShootCustomDateXShoot Custom Date XDateX is 1 through 5 (eg ShootCustomDate1) and maps to the matching custom field in Light Blue.
ShootCustomAmountXShoot Custom Amount XCurrencyX is 1 through 5 (eg ShootCustomAmount1) and maps to the matching custom field in Light Blue.
Was this article helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Table of Contents