Supported 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.

Key Maps to Type Notes
Message - Text Long This 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.
ContactNameFull Contact First Name and Contact Last Name Text Split into first name (the first word) and last name (all subsequent words); used to populated Contact First Name and Contact Last Name.
ContactNameFirst Contact First Name Text  
ContactNameLast Contact Last Name Text  
ContactNameMaiden Contact Maiden Name Text  
ContactRole Contact Link Role Text  
ContactTitle Contact Title Text  
ContactDateOfBirth Contact Date of Birth Date  
ContactSource Contact Source Text  
ContactMailingList Contact Mailing List Opt-In Boolean  
ContactEmail Contact Email Text When you import this from your Inbox into Light Blue, the label for this email will be your default label.
ContactPhoneHome Contact Phone Text When you import this from your Inbox into Light Blue, the label for this phone number will always be 'Home', regardless of your default.
ContactPhoneWork Contact Phone Text When you import this from your Inbox into Light Blue, the label for this phone number will always be 'Work', regardless of your default.
ContactPhoneMobile Contact Phone Text When you import this from your Inbox into Light Blue, the label for this phone number will always be 'Mobile', regardless of your default.
ContactPhone Contact Phone Number Text  
ContactPhoneType Contact Phone Number Label Text  
ContactWebsite Contact Website Text When you import this from your Inbox into Light Blue, the label for this email will be your default label.
ContactAddress1 Address 1 Text When you import this from your Inbox into Light Blue, the label for this address will be set to your default address type.
ContactAddress2 Address 2 Text When you import this from your Inbox into Light Blue, the label for this address will be set to your default address type.
ContactAddress3 Address 3 Text When you import this from your Inbox into Light Blue, the label for this address will be set to your default address type.
ContactAddressCity Address City Text When you import this from your Inbox into Light Blue, the label for this address will be set to your default address type.
ContactAddressCounty Address County Text ContactAddressCounty 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.
ContactAddressState Address State Text ContactAddressCounty 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.
ContactAddressPostCode Address Post Code Text ContactAddressPostCode 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.
ContactAddressZIPCode Address ZIP Code Text ContactAddressPostCode 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.
ContactAddressCountry Address Country Text When you import this from your Inbox into Light Blue, the label for this address will be set to your default address type.
ContactVATNumber Contact VAT Number Text  
ContactNotes Contact Notes Text Long  
ContactCustomTextX Contact Custom Text X Text X is 1 through 10 (eg ContactCustomText1) and maps to the matching custom field in Light Blue.
ContactCustomDateX Contact Custom Date X Date X is 1 through 5 (eg ContactCustomDate1) and maps to the matching custom field in Light Blue.
ContactCustomAmountX Contact Custom Amount X Currency X is 1 through 5 (eg ContactCustomAmount1) and maps to the matching custom field in Light Blue.
GroupContacts - Boolean If 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.
ShootTitle Shoot Title Text  
ShootType Shoot Type Text Must precisely match an existing shoot type name, or it will be ignored when importing from the Inbox into Light Blue.
ShootDate Session Date Date  
ShootTimeStart Session Start Time Time  
ShootTimeEnd Session End Time Time  
ShootStartTimestamp Session Start Date & Time Timestamp Introduced in Light Blue 5.1
ShootEndTimestamp Session End Date & Time Timestamp Introduced in Light Blue 5.1
ShootLocation Shoot Location Text  
ShootEnquirySource Shoot Enquiry Source Text  
ShootReferralSource Shoot Referral Source Text The 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.
ShootRequests Shoot Requests Text Long When importing, this will be split on end of line characters, with one request created for each line. Blank lines are ignored.
ShootNotes Shoot Notes Text Long  
ShootCustomTextX Shoot Custom Text X Text X is 1 through 10 (eg ShootCustomText1) and maps to the matching custom field in Light Blue.
ShootCustomDateX Shoot Custom Date X Date X is 1 through 5 (eg ShootCustomDate1) and maps to the matching custom field in Light Blue.
ShootCustomAmountX Shoot Custom Amount X Currency X is 1 through 5 (eg ShootCustomAmount1) and maps to the matching custom field in Light Blue.