Parameters – Optional

The collection ID. Most often the value of this parameter will be the merge field where the collection id is stored. If the value is empty, a new collection will be created.

The collection’s human readable name. Defaults to ‘Unnamed Collection’.

The field to which the collection ID will be saved.

The field to which the collection name will be saved.

The field to which the collection link will be saved.

The gallery ID. Most often the value of this parameter will be the merge field where the gallery id is stored. If the value is empty, a new gallery will be created.

The gallery’s human readable name. Defaults to ‘Unnamed Collection’.

Field to which the password will be saved. requires galleryPassword to be set.

The field to which the gallery ID will be saved.

The field to which the collection name will be saved.

The field to which the gallery link will be saved.

Defaults to ‘everyone.’ Other options are ‘permission’ or ‘private.’

A password to set for the collection.

Field to which the password will be saved. Requires collectionPassword to be set.

Field to which the password will be saved. requires collectionPassword to be set.

Defaults to null, which is view only access. Options are ‘original’ or ‘jpeg’. requires collectionPassword to be set.

Defaults to unlimited. Send any number to set a maximum. Requires collectionPassword and collectionDownloadType to be set.

Field to which the password expiration date will be saved. requires collectionPassword to be set.

A password to set for the gallery. If none is sent, will inherit from collection.

Password Expiration date in any readable format. requires galleryPassword to be set.

Defaults to null, which is view only access. Options are ‘original’ or ‘jpeg’. requires galleryPassword to be set.

Defaults to unlimited. Send any number to set a maximum. Requires galleryPassword and galleryDownloadType to be set.

Field to which the password expiration date will be saved. requires galleryPassword to be set.

The suffix you wish to append to the generated output which may be:

• The text you want to prefix (e.g “NEW2016”)
• The name of a merge field, e.g. ~Contact.Phone3~ or ~Opportunity._ProjectTitle~.

• The recipient’s phone number. If this is not provided, any mobile number within the contact’s record will be attempted.

This parameter allows you to set a future date for the next billing date of the subscription. If no date is passed or if the date is in the past, then the subscription’s default next bill date will be used.

The prefix you wish to prepend to the generated output which may be:

• The text you want to prefix (e.g “NEW2016”)
• The name of a merge field, e.g. ~Contact.Phone3~ or ~Opportunity._ProjectTitle~.

This parameter allows you to select a specific subscription by ID.  You may use Advanced Merge Field notation in combination with prefetch in order to locate the ID.

• The recipient’s phone number. If this is not provided, any mobile number within the contact’s record will be attempted.

• Any contact ID to be used in override scenarios. Overriding creates an accessor to another contact’s data, other than the data associated with the current contact.
  To utilize override data, use Override.Field or ~Override.Field~ notation in plac of the traditional Contact.Field or ~Contact.Field~ notation

• This is a URL to query at the end of the operation. The merge field {result} can be placed anywhere within the URL to include the result of the operation, allowing you to pass the value to another script

Set to 1 to generate a number.

• Also related to the management and deletion of scheduled calls is the “groupName” parameter. By specifying a particular group name, the end-user of our plug-in can delete multiple scheduled calls within one request to our deletion service URL (see: Deleting a Scheduled Call).
• The “groupName” parameter will be stored along with each scheduled call within our system.
• Be mindful of the fact that grouping of scheduled calls should be handled with care to avoid the unintended deletion of some scheduled calls by overzealous grouping.

The “adjustment” field should provide a relative date format string similar to PHP’s strtotime function. Some valid examples of this value are “+5 weeks” or “second month” or “last day of next month” or “yesterday noon”. (For more possible relative formats, see http://php.net/manual/en/datetime.formats.relative.php.

• When the date & time fields are not based on Eastern Time, the user may designate the appropriate originating timezone with any of the timezone codes/identifiers specified found at http://php.net/manual/en/timezones.php.
• Timezone abbreviations should always be in all capital letters, unless using identifiers. If no timezone is supplied, it is assumed to be Eastern (see list of Supported Time Zone Codes below)

Note:

Common Time Zones:

United States
Code Timezone, State, or Region Notes
ETUS Eastern Time No exclusions
CTUS Central Time No exclusions
MTUS Mountain Time Excluding Arizona
AZUS Arizona (No DST) No exclusions
PTUS Pacific Time No exclusions
ATUS Alaska Time No exclusions
HTUS Hawaii/Aleutian Time Excluding Honolulu
HONOUS Honolulu No exclusions
Australia
Code Timezone, State, or Region Notes
WTAU Western Australia Time; Western Australia Excluding Eucla
EUAU Eucla, Australia Time; Western Australia No exclusions
NCTAU North Central Australia Time; Northern Territory No exclusions
SCTAU South Central Australia Time; South Australia No exclusions
NETAU North Eastern Australia Time; Queensland No exclusions
SETAU South Eastern Australia Time;
New South Wales, Victoria, and Tasmania No exclusions
New Zealand
Code Timezone, State, or Region Notes
NZ New Zealand Time No exclusions
Europe
Code Timezone, State, or Region Notes
WTEU Western European Time Excluding Iceland
CTEU Central European Time No exclusions
ETEU Eastern European Time No exclusions
ICEEU Iceland (No DST) No exclusions
Canada
Code Timezone, State, or Region Notes
PTCA Pacific Time; Yukon and British Columbia No exclusions
MTCA Mountain Time;
part of Nunavut Northwest Territories,
Alberta, Saskatchewan No exclusions
CTCA Central Time;
part of Nunavut, Manitoba, some of Ontario No exclusions
ETCA Eastern Time;
most of Ontario, Quebec, Baffin Island No exclusions
ATCA Atlantic Time; Nova Scotia, New Brunswisk No exclusions
NTCA Newfoundland Time No exclusions

• If you want to automatically adjust the time to a different timezone, supply a timezone code/identifier within this parameter following the same rules that apply to the “timezone” parameter.
• Adjustments made to the date/time with the “adjustment” parameter are made after the timezone conversion is completed.

This is a URL to query at the end of the operation. The merge field {result} can be placed anywhere within the URL to include the result of the operation, allowing you to pass the value to another script.

Filter by any field in an Opportunity, as follows:

• For a number or ID field -> StageID:32
• For a text field -> OpportunityTitle:”My Text” or OpportunityTitle:”My Text%” or OpportunityTitle:”%My Text%”
• For a date field -> NextActionDate:”200409%”
• Filters can be combined to further narrow down a contact’s opportunities.

Note:

• Use % as a wildcard in searches.
• Examples:
  1. StageID:3 will only return opportunities currently at stage #3
  2. StageID:3,AffiliateID:4 will only return opportunities at stage #3 that were referred by affiliate #4
  3. AffiliateID:4,UserID:5 will return opportunities at any stage that originated from affiliate #4 and has been assigned to owner #5
  4. StageID:3,AffiliateID:4,UserID:5 will return opportunities at stage #3 that originated from affiliate #4 and has been assigned to owner #5
  5. StageID:3,AffiliateID:4,UserID:5,OpportunityTitle:”%Pocket Developer%” will return opportunities at stage #3 that originated from affiliate #4, assigned to owner #5 that has “Pocket Developer” in the title

Opportunity filterBy results can be limited by using the values of ‘oldest’/’first’ or ‘newest’/’last’ to limit the result to a single opportunity.

Used in combination with ‘limitTo,’ this parameter allows you to order the resulting opportunity lookup by the values ‘created’ or ‘updated’. (Default ordering is by last updated timestamp.)

The default company name for a contact

This field may contain either:

• A fixed value or constant address/zipcode string (e.g. 29137, United States)
• A contact field that is holding a value that should be retrieved and used as an address/zipcode in the timezone lookup

If this parameter is not present, Time Zone Finder will use the contact’s primary address postal code (and country, if available) to determine the time zone.

Note:

• The field is not limited to a full address string. You can use a zipcode/postal code), postal code and country, or full address (comma separated) can be submitted as an argument.
• If “location”, or any of the aliases, are not included in the POST parameters, the zipcode/postalcode available in the contact’s billing address will be used, as well as the billing country, if available.
• Aliases for location: address, zipCode, postalCode will all work as a parameter if they make more sense to you.

• This field may contain ‘1,’ ‘yes,’ or ‘true’ to return and save the timezone ID (e.g. America/Los_Angeles) in lieu of the timezone abbreviation (e.g. EST).
• Typical timezone identifiers can be found at http://php.net/manual/en/timezones.php

This field should contain one of the following:

1. A time or date & time which is structurally valid along common standards, such as “January 1, 2014 1:04 PM” or “01/01/2014 01:04:33 PM”
2. The text “now” which will result in using the current time
3. A custom field that is holding a date or date/time value such as Anniversary, Birthday, or _MyCustomDate

Note:

Only the time will be extracted from date/time values. Also, if you include a supported timezone code in your time value, please make sure it is using all capital letters (unless it’s an identifier), and that it appears as the last item in the time field. This will be overridden by any timezone values in the timezone parameter, if supplied. If no timezones are designated, assume that all times are in Eastern Time as is the standard with Infusionsoft.

The “adjustment” field should provide a relative date/time format string that complies with the following documentation: http://www.php.net//manual/en/datetime.formats.relative.php. Some valid examples of this value are “+5 weeks” or “second month” or “last day of next month” or “yesterday noon” or “+2 hours” etc

When the date & time fields are not based on Eastern Time, the user may designate the appropriate originating timezone with any of the supported timezone codes/identifiers specified in the “Supported Timezone Codes” section.

Note:

Timezone abbreviations should always be in all capital letters, unless using identifiers. If no timezone is supplied, it is assumed to be Eastern

In the event that the user would prefer to have a time automatically adjusted to some other timezone, they may supply a timezone code/identifier within this parameter following the same rules that apply to the timezone parameter above.

Note:

Adjustments made to the date/time with the “adjustment” parameter are made after the timezone conversion is completed.

• Scheduled delay calls can be deleted at a future date by making reference to a specific “key” or ID that is assigned to each call. To allow for such an event, the user may specify a field in which to store the scheduled call’s “key” for future usage (see: Deleting a Scheduled Call)
• The “saveKeyTo” parameter should contain this storage field name, which can be any standard Infusionsoft field or custom field, in any valid table, and as usual does support our Advanced Merge Field Notation.

This value should be of the following:

1. An Infusionsoft dateTime field, such as Contact._WebinarDateTime or Contact.DateCreated
2. A text string representing a valid time or date and time, such as “January 1, 2014 1:04 PM” or “01/01/2014 01:04:33 PM” or “1:04 PM”
3. An Infusionsoft text field (standard or custom) containing a valid text representation of a time or date and time
4. The text “now” which will result in using the current time

Note:

• Do not use tildes around field names in “date” or “saveTo” values.
• If you merge in a dateTime field for this value, only the time will be extracted. Also, if you include a supported timezone code in your time value, please make sure it is using all capital letters (unless it’s an identifier), and that it appears as the last item in the time field. This will be overridden by any timezone values in the timezone parameter, if supplied. If no timezones are designated, assume that all times are in Eastern Time as is the standard with Infusionsoft.

• Any contact ID to be used in override scenarios. Overriding creates an accessor to another contact’s data, other than the data associated with the current contact.
• To utilize override data, use Override.Field or ~Override.Field~ notation in place of the traditional Contact.Field or ~Contact.Field~ notation

The field where you want to save the password. Enter the field name without tildes, e.g. Contact._MyPassword.

Note:

If this parameter is not used, the password will be saved to the Contact.Password field.

Set to 1 if you want to include the following special characters as part of the password: !@#$%^&*()

Set to 1 if you want to include the following extra special characters as part of the password: -_ []{}~`+=,.;:/?|

Set the number characters you want the password to be. Default is 8.

Note:

If this parameter is not used, the password will be eight characters long.

For ‘register’ action. The field to save the Title/Subject of the webinar to.

For ‘register’ action. Field to save the webinar date or date & time to.

For ‘register’ action. Field to save the registrant’s JoinURL to.

A “from” address for the outgoing e-mail.

Note:

• If the “from” address is omitted, the fixed value within the e-mail template will be used.
• If no “from” e-mail is found either as a parameter in the HTTP post or designated in the email template, “noreply@infusionsoft.com” will be used by default.

An e-mail, or comma separated list of e-mails, that will receive a carbon copy of the outgoing e-mail. This value can be

• a fixed email or list of emails
• a standard Infusionsoft merge field that contains an email or list of emails
• Advanced Merge Field Notation used to retrieve data from fields on records other than the contact record (e.g. Order, Invoice, Company or Opportunity)

An e-mail, or comma separated list of e-mails, that will receive a blind carbon copy of the outgoing e-mail. This value can be

• a fixed email or list of emails
• a standard Infusionsoft merge field that contains an email or list of emails
• Advanced Merge Field Notation used to retrieve data from fields on records other than the contact record (e.g. Order, Invoice, Company or Opportunity)

Set this to “true” if you want Pocket Developer to delete the contact that is created when no contact exists for an email address in to, from, cc or bcc. Default is set to false.

Note:

Pocket Developer adds a tag (Pocket Developer -> Created by Email Anyone Anytime) to all contacts it creates for the purpose of sending an email.

This parameter allows you to select a specific subscription by ID.  You may use Advanced Merge Field notation in combination with prefetch in order to locate the ID.

This parameter allows you to set a future date for the next billing date of the subscription.  If no date is passed or if the date is in the past, then the subscription’s default next bill date will be used.

This parameter allows you to select a specific subscription by ID.  You may use Advanced Merge Field notation in combination with prefetch in order to locate the ID.