IntroductionUsagePropertiesCustom Field Properties
Introduction
The Feed Object meta for the Agile CRM add-on is an associative array containing the properties which determine how the add-on should process the form submission.
$feed['meta'] = array(
'feedName' => 'Agile CRM Feed 1',
'createContact' => true,
'contactCustomFields' => array(),
'feed_condition_conditional_logic' => true,
'feed_condition_conditional_logic_object' => array(
'conditionalLogic' => array(),
),
);
Usage
We recommend accessing the $feed meta using the rgar() or rgars() functions, e.g.:
$conditional_logic_enabled = rgars( $feed, 'meta/feed_condition_conditional_logic' );
Properties
feedName string
The feed name which appears on the add-ons feeds tab.
createContact boolean
Create new contact. Default is false.
createTask boolean
Create new task. Default is false.
contactStandardFields_first_name string
The ID of the form field containing the contact』s first name.
contactStandardFields_last_name string
The ID of the form field containing the contact』s last name.
contactStandardFields_email_address string
The ID of the form field containing the contact』s email.
contactCustomFields array
A multidimensional array containing the Agile CRM custom fields. See Custom Field Properties.
contactTags string
A comma separated list of tags to be assigned to the contact. Merge tags supported.
updateContactEnable boolean
Should an existing contact be updated if found? Default is false.
updateContactAction string
The update action. Should the contact details be replaced or appended. Possible values: replace or append.
taskSubject string
The task subject line. Merge tags supported.
taskDaysUntilDue integer
The number of days until the task is due.
taskPriority string
The task priority. Possible values: HIGH, NORMAL or LOW.
taskStatus string
The task status. Possible values: YET_TO_START, IN_PROGRESS or COMPLETED.
taskType string
The task type. Possible values: CALL, EMAIL, FOLLOW_UP, MEETING, MILESTONE, SEND, TWEET or OTHER.
taskCreateNote boolean
Should a note be created for the task? Default is false.
taskNoteSubject string
The task note subject. Merge tags supported.
taskNoteDescription string
The task note description. Merge tags supported.
taskAssignToContact boolean
Should the task be assigned to the created contact? Default is false.
feed_condition_conditional_logic boolean
Is the feed condition (conditional logic) setting enabled. Default is false.
feed_condition_conditional_logic_object array
An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.
Custom Field Properties
array(
'key' => 'title',
'value' => '3',
)
Each custom field is an associative array containing the following properties:
key string
The Agile CRM custom field key. Possible values: title, company, email_work, email_personal, phone_work, phone_home, phone_mobile, phone_home_fax, phone_work_fax, phone_other, address_home, address_postal, address_office, website_url, website_skype, website_twitter, website_linkedin, website_facebook, website_xing, website_feed, website_google_plus, website_flickr, website_github, website_youtube or gf_custom.
value string
The ID of the form field or entry meta item containing the value for this custom field.
custom_key string
The custom key. Only used when the custom field key is set to gf_custom.