FanBridge API - Reference

https://api.fanbridge.com/[version]/account/me.[format]?token=[token]&signature=[signature]

• id integer Current user ID.
• firstname string Firstname of current user.
• lastname string Lastname of current user.
• band_name string Band name of current user.
• band_image string URL of the band logo.
• band_url integer External URL to access the site of the band.
• subdomain string URL to access the site of the band.
• welcome_message string An additional welcome message from band.

https://api.fanbridge.com/[version]/email_campaign/cancel_schedule.[format]?token=[token]&signature=[signature]

• campaign_id integer (required) Campaign ID.

https://api.fanbridge.com/[version]/email_campaign/create.[format]?token=[token]&signature=[signature]

• type string (required) Campaign type. Allowed types are:
  • plaintext: Plain text format (no styles)
  • html: HTML format (with styles)
  • absplit: HTML format and will be sent using Subject Optimizer
• name string (required) A name for the new campaign. The limit is 100 characters long.
• subject string (required) Campaign email subject. The limit is 100 characters long.
• from integer Email ID address for 'from' field. You can fetch all available email IDs with email_campaign / get_from_addresses method. Default value is '0' (your main email ID).
• content_html string (required if type is 'html' or 'absplit') HTML content of the email body.
• content_text string (required if type is 'plaintext', otherwise this will be created from 'content_html') Plain text content of the email body.
• view_in_browser boolean Whether we want to show a link for accessing the campaign from browser or not. Default value is 'true'.
• facebook_like boolean Whether we want to include a Facebook Like button or not. Default value is 'false'.
• text_links_track boolean Whether we want to track user clicks in links or not. Default value is 'false'.
• tourdates boolean Whether campaign has tourdate info asociated or not. Default value is 'false'.
• ab array (required if type is 'absplit') Subject Optimizer
  • subject_b string (required) Test email subject. This must not be the same as 'subject' param and has a limit of 100 characters.
  • ab_size integer (required) Percentage of your campaign to send between Subject A and Subject B.
    Allowed values are: 5, 10, 20, 30, 40, 50.
  • send_after_period float (required) Waiting time (in days) before the rest of the campaign is sent.
    Allowed values are: 0.5 (12 hours), 1, 2, 3, 4, 5, 10.

• id integer The ID of the newly created campaign.

https://api.fanbridge.com/[version]/email_campaign/create_targeting.[format]?token=[token]&signature=[signature]

• campaign_id integer (required) Campaign ID.
• groups array A bunch of groups IDs to which this campaign will be sent to. You can fetch your available groups with email_group / fetch_all method.
• zip_codes array A bunch of zip groups to which this campaign will be sent to. You can add as much zips groups as you wish. Each zip group must have the following form:
  • zip string (required) Zip code.
  • distance integer Distance ratio. Limits are from 0 to 10000 miles.
• filters array FanRank™ filters for the sending.
  Allowed values are: 'undefined', 'super', 'casual', 'risk'.

https://api.fanbridge.com/[version]/email_campaign/fetch.[format]?token=[token]&signature=[signature]

• campaign_id integer (required) Campaign ID.

• type string Campaign type. Possible values are:
  • plaintext: Plain text format (no styles)
  • html: HTML format (with styles)
  • absplit: HTML format + Subject Optimizer
• name string Campaign name.
• subject string Email subject.
• from integer Email ID address.
• content_html string HTML content of the email body.
• content_text string Plain text content of the email body.
• view_in_browser boolean Whether the link for accessing the campaign from browser is enabled or not.
• facebook_like boolean Whether the Facebook Like button is enabled or not.
• text_links_track boolean Whether user tracking is enabled or not.
• tourdates boolean Whether campaign has tourdate info asociated or not.
• status string Actual status of the campaign, possible values are: 'Scheduled','Sent','Draft','Running'.
• ab array Subject Optimizer
  • subject_b string Test email subject.
  • ab_size integer Percentage of campaign to send between Subject A and Subject B.
    Possible values are: 5, 10, 20, 30, 40, 50.
  • send_after_period float Waiting time (in days) before the rest of the campaign is sent.
    Possible values are: 0.5 (12 hours), 1, 2, 3, 4, 5, 10.

https://api.fanbridge.com/[version]/email_campaign/fetch_all.[format]?token=[token]&signature=[signature]

• offset integer The resultset offset to start. Default value is '0'.
• limit integer The limit amount of results to retrieve. Default and max value is '50'.
• status string Campaign status.

• id integer Campaign ID.
• type string Campaign type. Possible values are:
  • plaintext: Plain text format (no styles)
  • html: HTML format (with styles)
  • absplit: HTML format + Subject Optimizer
• status string Campaign status.
• name string Campaign name.
• subject string Email subject.
• created_on string Campaign creation date in ISO format (YYYY-MM-DD HH:MM:SS) on EST timezone.
• scheduled_on string Campaign schedule date in ISO format (YYYY-MM-DD HH:MM:SS) on EST timezone.
• ab array Subject Optimizer
  • subject_b string Test email subject.
  • ab_size integer Percentage of campaign to send between Subject A and Subject B.
    Possible values are: 5, 10, 20, 30, 40, 50.
  • send_after_period float Waiting time (in days) before the rest of the campaign is sent.
    Possible values are: 0.5 (12 hours), 1, 2, 3, 4, 5, 10.

https://api.fanbridge.com/[version]/email_campaign/get_from_addresses.[format]?token=[token]&signature=[signature]

• id integer Email ID.
• email string Email string.
• name string Band name.

https://api.fanbridge.com/[version]/email_campaign/get_schedule.[format]?token=[token]&signature=[signature]

• campaign_id integer (required) Campaign ID.

• date_time string Date and Time of the scheduled campaign in ISO format (YYYY-MM-DD HH:MM:SS) on EST timezone.

https://api.fanbridge.com/[version]/email_campaign/get_targeting.[format]?token=[token]&signature=[signature]

• campaign_id integer (required) Campaign ID.

• send_to_all boolean Whether campaign was targeted to all subscribers or not.
• groups array Groups to which this campaign will be sent to.
• zip_codes array Zip groups to which this campaign will be sent to.
  • zip string Zip code.
  • distance integer Distance ratio.
• filters array FanRank™ filters for the sending.
  Possible values are: 'undefined', 'super', 'casual', 'risk'.

https://api.fanbridge.com/[version]/email_campaign/schedule.[format]?token=[token]&signature=[signature]

• campaign_id integer (required) Campaign ID.
• date_time string (required) Date and Time to schedule this campaign in ISO format (YYYY-MM-DD HH:MM:SS) on EST timezone. You can use "NOW" to refer to the current date and time.

https://api.fanbridge.com/[version]/email_campaign/target_all.[format]?token=[token]&signature=[signature]

• campaign_id integer (required) Campaign ID.

https://api.fanbridge.com/[version]/email_campaign/update.[format]?token=[token]&signature=[signature]

• campaign_id integer (required) Campaign ID.
• type string (required) Campaign type. Allowed types are:
  • plaintext: Plain text format (no styles)
  • html: HTML format (with styles)
  • absplit: HTML format and will be sent using Subject Optimizer
• name string (required) A name for the new campaign. The limit is 100 characters long.
• subject string (required) Campaign email subject. The limit is 100 characters long.
• from integer Email ID address for 'from' field. You can fetch all available email IDs with email_campaign / get_from_addresses method. Default value is '0' (your main email ID).
• content_html string (required if type is 'html' or 'absplit') HTML content of the email body.
• content_text string (required if type is 'plaintext', otherwise this will be created from 'content_html') Plain text content of the email body.
• content_text_from_html boolean Set to 'true' if you want to automatic update the plain text content from HTML content.
• view_in_browser boolean Whether we want to show a link for accessing the campaign from browser or not. Default value is 'true'.
• facebook_like boolean Whether we want to include a Facebook Like button or not. Default value is 'false'.
• text_links_track boolean Whether we want to track user clicks in links or not. Default value is 'false'.
• tourdates boolean Whether campaign has tourdate info asociated or not. Default value is 'false'.
• ab array (required if type is 'absplit') Subject Optimizer
  • subject_b string (required) Test email subject. This must not be the same as 'subject' param and has a limit of 100 characters.
  • ab_size integer (required) Percentage of your campaign to send between Subject A and Subject B.
    Allowed values are: 5, 10, 20, 30, 40, 50.
  • send_after_period float (required) Waiting time (in days) before the rest of the campaign is sent.
    Allowed values are: 0.5 (12 hours), 1, 2, 3, 4, 5, 10.

https://api.fanbridge.com/[version]/email_campaign/analytics_summary.[format]?token=[token]&signature=[signature]

• campaign_id integer (required) Campaign ID.

• sent integer Count of campaign sent emails.
• unique_opens integer Count of campaign emails unique opened.
• opens integer Count of campaign emails opened.
• bounced integer Count of campaign emails bounced.
• unopens integer Count of campaign emails unopened.
• abuse integer Count of campaign emails abused.
• unsubscribed integer Count of campaign emails unsubscribed.
• forwarded integer Count of campaign emails forwarded.
• links_clicks integer Tracking of links.
  • url string URL of the link clicked.
  • clicks integer Count of clicks of the URL.

https://api.fanbridge.com/[version]/socialnet_campaign/cancel_schedule.[format]?token=[token]&signature=[signature]

• campaign_id integer (required) The campaign ID we want to cancel the schedule.

https://api.fanbridge.com/[version]/socialnet_campaign/create.[format]?token=[token]&signature=[signature]

• name string (required) Name of the socialnet campaign.
• message string (required) Message to be posted in the socialnet.
• date_schedule string (required) Datetime of the schedule.
• accounts array (required) Accounts IDs to post the campaign.
  You can fetch all available accounts with socialnet_campaign / fetch_accounts method.
  • id integer (required) Account ID.

• id integer The new campaign ID.

https://api.fanbridge.com/[version]/socialnet_campaign/fetch_accounts.[format]?token=[token]&signature=[signature]

• id integer Account ID.
• name string The name you use to login to this account.
• network string The name of this network. Ie.: "facebook".
• type string The type of the network.

https://api.fanbridge.com/[version]/email_group/create.[format]?token=[token]&signature=[signature]

• name string (required) The name of the new group.
• description string A description for the group.
• public boolean Indicates if we want the group to be public.

• id integer New group ID.

https://api.fanbridge.com/[version]/email_group/fetch_all.[format]?token=[token]&signature=[signature]

• offset integer The resultset offset to start. Default value is '0'.
• limit integer The limit amount of results to retrieve. Default value is '15'.

• id integer Group Id.
• name string Group name.
• public boolean Whther group scope is public or not.
• description string Group description.
• count integer The amount of members in the group.
• created_on string Group creation date in ISO format (YYYY-MM-DD HH:MM:SS) on EST timezone.

https://api.fanbridge.com/[version]/subscriber/add.[format]?token=[token]&signature=[signature]

• firstname string Subscriber firstname.
• lastname string Subcriber lastname.
• email string (required) Subscriber email address.
• address string Subscriber main address.
• address2 string Subscriber secondary address.
• zip_code integer Subscriber zip code info.
• city string Subscriber city name.
• state string Subscriber state name. You can fetch all available states with region / get_states method.
• country string Subscriber country ISO code. You can fetch all available countries with region / get_countries method.
• cellphone string Subscriber cellphone number.
• carrier integer (required if cellphone is provided) Cellphone carrier.
  You can fetch all available carrier IDs with text_subscriber / get_carriers method.
• year integer Subscriber age.
• gender string Subscriber gender.
  Allowed values are: female, male
• format string Email sending format.
  Allowed values are: html, text
• ip string Detected subscriber IP address. Default value is IP detected by the server.
• myspace_url string Subscriber MySpace URL.
• twitter_url string Subscriber Twitter URL.
• notes string Some usefull description.
• groups array Groups for adding the subscriber to.

• id integer The ID of the newly added subscriber.

https://api.fanbridge.com/[version]/subscriber/count.[format]?token=[token]&signature=[signature]

• zip_codes array A bunch of zip groups to get members count from. Each zip group must have the following form:
  • zip string (required) Zip code.
  • distance integer Distance ratio. Limits are from 0 to 10000 miles.

• count integer The total subscribers count.

• zip string Zip code.
• distance integer Distance ratio.
• count integer Members count for this zip code and ratio.

https://api.fanbridge.com/[version]/subscriber/import.[format]?token=[token]&signature=[signature]

• id integer The ID of the newly started import.

https://api.fanbridge.com/[version]/subscriber/cancel_import.[format]?token=[token]&signature=[signature]

• import_id integer (required) Import ID.

https://api.fanbridge.com/[version]/subscriber/import_status.[format]?token=[token]&signature=[signature]

• import_id integer (required) Import ID.

• status string Current status of the process. Possible values are:
  • pending: Import process is waiting to start.
  • running: Import process is running.
  • canceled: Import process was canceled.
  • finished: Import process was finished.
• progress mixed The progress percentage of the process if running; empty otherwise.
• report array Current statistics for the current import process.
  • msl integer Master supression list: Users not allowed to send emails to.
  • fan_unsubscribed integer Subscribers that were previously unsubscribed by themselves.
  • bounces integer Rejected subscribers by the system (unexistent email probably).
  • invalid_address integer Subscribers with invalid email addresses.
  • updated integer Updated subscribers.
  • success integer Added subscribers.

https://api.fanbridge.com/[version]/tour_calendar/fetch.[format]?token=[token]&signature=[signature]

• id integer (required) Show ID.

• id integer Show ID.
• name string Name of the show.
• date_time string Date and Time of the show.
• doors_time string Show doors time.
• price integer Show price.
• currency string Currency type.
• ticket_purchase_url string Web page where you can purchease tickets.
• age_minimum string Minimum age for accessing the show.
• additional string Additional info.
• details string Show FanBridge page.
• show_external_last_updated string Last show update.
• venue array Show venue.
  • name string Venue name.
  • address string Venue address.
  • address2 string Another venue address.
  • city string Venue city.
  • state string Venue state.
  • state_abbv string Venue state abbreviation.
  • zip_code integer Venue zip code.
  • country_code string Venue country code.
  • country_name string Venue country name.
  • phone string Contact phone.
  • url string Venue URL.
• source array Show source.
  • source. string Source type.
  • artist_external_identifier string Third part artist identifier.
  • show_external_identifier string Third part show identifier.

https://api.fanbridge.com/[version]/tour_calendar/fetch_upcoming.[format]?token=[token]&signature=[signature]

• date string Date to retrieve shows from, in date ISO format (YYYY-MM-DD) on EST timezone. You can use "NOW" to refer to the current date.

• array Retrieves all shows for a user.
  • id integer Show ID.
  • name string Name of the show.
  • date_time string Date and Time of the show.
  • doors_time string Show doors time.
  • price integer Show price.
  • currency string Currency type.
  • ticket_purchase_url string Web page where you can purchease tickets.
  • age_minimum string Minimum age for accessing the show.
  • additional string Additional info.
  • details string Show FanBridge page.
  • show_external_last_updated string Last show update.
  • venue array Show venue.
    • name string Venue name.
    • address string Venue address.
    • address2 string Another venue address.
    • city string Venue city.
    • state string Venue state.
    • state_abbv string Venue state abbreviation.
    • zip_code integer Venue zip code.
    • country_code string Venue country code.
    • country_name string Venue country name.
    • phone string Contact phone.
    • url string Venue URL.
  • source array Show source.
    • source. string Source type.
    • artist_external_identifier string Third part artist identifier.
    • show_external_identifier string Third part show identifier.

https://api.fanbridge.com/[version]/tour_calendar/fetch_all.[format]?token=[token]&signature=[signature]

• offset integer The resultset offset to start. Default value is '0'.
• limit integer The limit amount of results to retrieve. Default value is '50'.

• array Retrieves all shows for a user.
  • id integer Show ID.
  • name string Name of the show.
  • date_time string Date and Time of the show.
  • doors_time string Show doors time.
  • price integer Show price.
  • currency string Currency type.
  • ticket_purchase_url string Web page where you can purchease tickets.
  • age_minimum string Minimum age for accessing the show.
  • additional string Additional info.
  • details string Show FanBridge page.
  • show_external_last_updated string Last show update.
  • venue array Show venue.
    • name string Venue name.
    • address string Venue address.
    • address2 string Another venue address.
    • city string Venue city.
    • state string Venue state.
    • state_abbv string Venue state abbreviation.
    • zip_code integer Venue zip code.
    • country_code string Venue country code.
    • country_name string Venue country name.
    • phone string Contact phone.
    • url string Venue URL.
  • source array Show source.
    • source. string Source type.
    • artist_external_identifier string Third part artist identifier.
    • show_external_identifier string Third part show identifier.

https://api.fanbridge.com/[version]/fan_question/create.[format]?token=[token]&signature=[signature]

• question string (required) The question to do.
• weekly_digest boolean Whether we want to subscribe the fan to the FanBridge newsletter. Default value is 'false'.
• ip string Fan detected IP address. Default value is detected IP from server.
• subscriber_id integer If the fan is already a subscriber of the account, you can provide they subscriber ID to identify them. Otherwise, the question will be sent as "Anonymous".

• fanquestion_id integer New fan question ID.

https://api.fanbridge.com/[version]/fan_question/fetch.[format]?token=[token]&signature=[signature]

• id integer (required) Fan Question ID.

• id integer Fan Question ID.
• answered boolean Whether the question has been answered or not.
• media_type string The text type of the question.
• question string Text of the question.
• date_question string The date the question was made.
• default_question string The automatic question made for the system on subscribing.
• status string The status of the question. Possible values are:
  • read: Question has been already chcked.
  • unread: Question has not been checked yet.
  • deleted: Question has been deleted.
• answer string Text of the answer.
• date_answer string The date the question was answered.
• subscriber_id integer ID of the user that made the question.
• email string [Deprecated]
• subscriber_email string Subscriber email.
• user_id integer User ID.
• subscriber_enabled boolean Whether the subscriber is enabled or not.
• subscribed boolean Whether the subscriber is email subscribed or not.
• question_to_post string Question for posting.

https://api.fanbridge.com/[version]/fan_question/fetch_all.[format]?token=[token]&signature=[signature]

• offset integer Records offset to start from. Default value is '0'.
• limit integer Limit of results to get for a page. Default value is '100'.
• type string Whether we should apply a filter for results. Possible values are:
  • answered: All answered questions.
  • unanswered: All unanswered questions.
  • all: All questions (default).

• array A bunch of Fan Questions. Each group has the following fields:
  • id integer Fan Question ID.
  • answered boolean Whether the question has been answered or not.
  • media_type string The text type of the question.
  • question string Text of the question.
  • date_question string The date the question was made.
  • default_question string The automatic question made for the system on subscribing.
  • status string The status of the question. Possible values are:
    • read: Question has been already chcked.
    • unread: Question has not been checked yet.
    • deleted: Question has been deleted.
  • answer string Text of the answer.
  • date_answer string The date the question was answered.
  • email string [Deprecated]
  • subscriber_email string Subscriber email.

https://api.fanbridge.com/[version]/fan_question/count.[format]?token=[token]&signature=[signature]

• type integer Type of Fan Question to count.

• count integer The total of filtered (or not) Fan Questions.

https://api.fanbridge.com/[version]/fan_question/update.[format]?token=[token]&signature=[signature]

• id integer (required) Fan Question ID.
• answer string (required) The text of the answer.
• edit boolean Whether we are updating an already answered question or not.

https://api.fanbridge.com/[version]/fan_question/delete.[format]?token=[token]&signature=[signature]

• id integer (required) Fan Question ID.

https://api.fanbridge.com/[version]/fan_question/mark_as_read.[format]?token=[token]&signature=[signature]

• id integer (required) Fan Question ID.

https://api.fanbridge.com/[version]/region/get_states.[format]?token=[token]&signature=[signature]

• id integer State ID.
• name string State name.
• abbv string State abbreviation name.

https://api.fanbridge.com/[version]/region/get_countries.[format]?token=[token]&signature=[signature]

• iso string Country ISO code.
• name string Country name.

https://api.fanbridge.com/[version]/text_subscriber/get_carriers.[format]?token=[token]&signature=[signature]

• id integer Carrier ID.
• carrier string Carrier name.

https://api.fanbridge.com/[version]/utils/get_date_time.[format]?token=[token]&signature=[signature]

• date_time string FanBridge server date and time in ISO format (YYYY-MM-DD HH:MM:SS) on EST timezone.