API Reference

You can choose from several different ways to sync data from your web, mobile or desktop application. You may use simple HTTP/GET parameters or serialize the content into HTTP/POST JSON requests with UTF-8 character encoding. A ready-made JavaScript code snippet is the easiest way to get started. All examples are listed below.

Authentication

API key can be passed as a normal request parameter. API key is public - these methods do not provide any access to read your data. To find your API key and personalized documentation with live data examples, please login and select Setup / Integrations / API.

API is asynchronous to ensure reliability and performance. Requests are queued on server before processing. It might take up to one minute before requests are visible in user interface.
0
Create or update a signup
Curl JavaScript jQuery form HTML form JSON
# Copy & run this in your terminal.
curl -s https://growhold.com/api/signup \
     -F key='replace-with-your-api-key' \
     -F email='alex.williams@example.com' \
     -F user-id='user-123' \
     -F first-name='Alex' \
     -F last-name='Williams' \
     -F account-id='example-123' \
     -F account-name='Example Ltd' \
     -F ip-address='requester' \
     -F expires='14'

https://growhold.com/api/signup
Create new or update existing signup in database.
Parameter Value Required Description
key Text  Yes  Your API key 
return URL    Forward request to this address after call is finished 
email Email  Yes  User's email address. 
user-id Text    User's unique identifier. 
first-name Text    First name 
last-name Text    Last name 
title Text    Title 
phone Text    Phone number 
description Text    Description 
website Text    Website 
city Text    City 
country Text    Coyntry 
signup-status Number    Status of the user. See Setup / Integrations / API Reference for possible values. 
account-id Text    Account's unique identifier. 
account-name Text    Account name 
ip-address IP address    Requester's IP address 
optout true | false    If true, all automatic emails are turned off. 
expires Number    Trial expiration time in days. Never expires if empty. 
source Text    Source of the signup. Used with activity rules. 
Log user's action
Curl JavaScript jQuery form HTML form JSON
# Copy & run this in your terminal.
curl -s https://growhold.com/api/action \
     -F key='replace-with-your-api-key' \
     -F email='alex.williams@example.com' \
     -F user-id='user-123' \
     -F action-description='Page view' \
     -F ip-address='requester'

https://growhold.com/api/action
Log user's action. Create new signup if account-id or email does not exist or account-signup-email is given.
Parameter Value Required Description
key Text  Yes  Your API key 
return URL    Forward request to this address after call is finished 
email Email  Yes  User's email address. 
user-id Text    User's unique identifier. 
signup-time Timestamp    Time when customer signed up. 
action-description Text    Describe what user was doing 
account-id Text    Account's identifier for user grouping. 
account-name Text    Name of the account. 
account-customer true |¬†false    Set 'true' if user is already a customer account. 
account-signup-email Email    Email address of the user whom signed up to create this account. 
account-signup-time Timestamp    Time when account was created. 
ip-address IP address    Requester's IP address 
Convert signup into customer and start a subscription
Curl JavaScript jQuery form HTML form JSON
# Copy & run this in your terminal.
curl -s https://growhold.com/api/convert \
     -F key='replace-with-your-api-key' \
     -F email='alex.williams@example.com' \
     -F user-id='user-123' \
     -F first-name='Alex' \
     -F last-name='Williams' \
     -F account-name='Example Ltd' \
     -F account-id='example-123' \
     -F plan-code='example'

https://growhold.com/api/convert
Converts signed up user into customer account and creates the first subscription.
Parameter Value Required Description
key Text  Yes  Your API key 
return URL    Forward request to this address after call is finished 
email Email  Yes  User's email address. 
user-id Text    User's unique identifier. 
first-name Text    First name 
last-name Text    Last name 
title Text    Title 
phone Text    Phone number 
description Text    Description 
account-name Text    Account name 
account-id Text  Yes  Account ID. Creates a new account if not found.  
account-id-add Text    Add secondary account ID. Call method multiple times to add more. Useful for integration ID mappings.  
account-description Text    Account description 
account-website Text    Account website 
account-employees Number    Number of employees 
account-city Text    City 
account-country Text    Coyntry 
plan-code Text  Yes  API code for selected plan 
plan-quantity Number    Subscription quantity. 1 if left empty. 
plan-charge Number #.#    Subscription charge. Overrides plan charge. 
plan-fee Number #.#    Subscription fee. Overrides plan fee. 
plan-auto-renew true | false    If true, subscription is repeated until canceled 
ip-address IP address    Requester's IP address 
optout true | false    If true, all automatic emails are turned off. 
Create or update account.
Curl JavaScript jQuery form HTML form JSON
# Copy & run this in your terminal.
curl -s https://growhold.com/api/account \
     -F key='replace-with-your-api-key' \
     -F account-name='Example Ltd' \
     -F account-id='example-123'

https://growhold.com/api/account
Create new or update existing account details in database.
Parameter Value Required Description
key Text  Yes  Your API key 
return URL    Forward request to this address after call is finished 
account-name Text    Account name 
account-id Text  Yes  Account ID. Creates a new account if not found.  
account-id-add Text    Add secondary account ID. Call method multiple times to add more. Useful for integration ID mappings.  
account-status Number    Status of the account. See Setup / Integrations / API Reference for possible values. 
account-description Text    Account description 
account-website Text    Account website 
account-employees Number    Number of employees 
account-city Text    City 
account-country Text    Coyntry 
account-signup-time Timestamp    Time when account was created. 
Create or update user
Curl JavaScript jQuery form HTML form JSON
# Copy & run this in your terminal.
curl -s https://growhold.com/api/user \
     -F key='replace-with-your-api-key' \
     -F email='alex.williams@example.com' \
     -F user-id='user-123' \
     -F first-name='Alex' \
     -F last-name='Williams'

https://growhold.com/api/user
Create new or update existing user details in database.
Parameter Value Required Description
key Text  Yes  Your API key 
return URL    Forward request to this address after call is finished 
email Email  Yes  User's email address. 
user-id Text    User's unique identifier. 
first-name Text    First name 
last-name Text    Last name 
title Text    Title 
phone Text    Phone number 
description Text    Description 
city Text    City 
country Text    Coyntry 
signup-time Timestamp    Time when user signed up. 
optout true | false    If true, all automatic emails are turned off. 
Create new subscription
Curl JavaScript jQuery form HTML form JSON
# Copy & run this in your terminal.
curl -s https://growhold.com/api/subscribe \
     -F key='replace-with-your-api-key' \
     -F account-id='example-123' \
     -F plan-code='example'

https://growhold.com/api/subscribe
Create new subscription. To upgrade or downgrade a subscription cancel the current one and then create a new.
Parameter Value Required Description
key Text  Yes  Your API key 
return URL    Forward request to this address after call is finished 
account-id Text  Yes  Account ID. Creates a new account if not found.  
plan-code Text  Yes  API code for selected plan 
plan-quantity Number    Subscription quantity. 1 if left empty. 
plan-charge Number #.#    Subscription charge. Overrides plan charge. 
plan-fee Number #.#    Subscription fee. Overrides plan fee. 
plan-auto-renew true | false    If true, subscription is repeated until canceled 
Cancel subscription
Curl JavaScript jQuery form HTML form JSON
# Copy & run this in your terminal.
curl -s https://growhold.com/api/unsubscribe \
     -F key='replace-with-your-api-key' \
     -F account-id='example-123' \
     -F plan-code='example'

https://growhold.com/api/unsubscribe
Turn off auto-renew and end current subscription when expires.
Parameter Value Required Description
key Text  Yes  Your API key 
return URL    Forward request to this address after call is finished 
account-id Text  Yes  Account ID. Creates a new account if not found.  
plan-code Text  Yes  API code for selected plan 
at-period-end true | false    If false, subscription is canceled today. 

 

Helsinki - New York - Wien
Copyright © 2008-2018 Guavacloud Inc  |  Site Index