If you're headed to PLMA stop by our booth F118 and meet the team. We'll be handing out our new t-shirts!
Login

Flavor Studio API

  • API Reference
  • Authentication
  • Rate Limiting
  • Projects
  • Recipes
  • Ingredients
  • Taste Tests
  • CRM Customers
  • CRM Settings
  • CRM Opportunities
  • CRM Contracts
  • CRM Activities
  • CRM Contacts
  • CRM Products
  • CRM Purchase Orders
  • Organizations
  • Countries
  • Webhooks
  • Errors

API Reference

Flavor Studio’s API has predictable, resource-oriented URLs, and uses JSON to indicate API errors. To authenticate it uses HTTP Basic Auth. We support cross-origin resource sharing, allowing you to interact securely with our API from a client-side web application (though you should never expose your private API key in any public website's client-side code). JSON is returned by all API responses, including errors.

Base URL

Authentication

You access the Flavor Studio API using API keys that represent the required credentials. Authenticate your organization when using the API by including your API public and API private keys in the request. You can generate API keys by enabling the API on the Settings tab of the Admin page in Flavor Studio. Do not share your secret API keys in publicly accessible areas such GitHub, client-side code, and so forth. Since API Keys can be independently revoked, you have complete control of the lifecycle of your API credentials. Disabling the API from the Settings tab will permanently delete your API keys and render them unusable.

Flavor Studio generates a new public and private key pair each time that the API is enabled.

Authentication to the API is performed via HTTP Basic Auth. Provide your public API key as the Basic Auth username value and private API key as Basic Auth password value.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Authenticated Request

Rate Limiting

Please note that there is a daily limit of 1,000 API calls per organization for all endpoints, except for the ingredients endpoints, which have a higher daily limit of 2,000 API calls per organization. This limit is designed to ensure optimal performance for all organizations. Be mindful of this limit when integrating with our API.

You can always monitor your usage, as each API response includes a remaining_daily_api_requests parameter, which indicates the number of calls you have left for the day.

For ingredient endpoints, the response includes a remaining_daily_ingredient_requests parameter, which tracks the remaining calls specific to those endpoints.

If your organization requires higher usage, please contact our support team to discuss your needs.

Projects

The Projects API offers endpoints to retrieve comprehensive information about projects managed within the system.

Each project contains essential information such as its name, due date, priority, and a brief description.

Users can interact with projects by adding contacts, forming teams, and assigning project leaders.

Each project is linked to a customer and includes status updates and progress indicators.

Endpoints

List all Projects

Returns a list of projects. The projects are returned sorted by project unique id, with the most recently created products appearing first.

URL Parameters
  • page integer optional

    Sets the page. Default: 1

  • step integer optional

    Defines how many results are listed for the current page. Max Value: 1000, Default: 10

  • order string optional

    Enum [project_uid, project_name, start_date, end_date, project_description, project_status, priority, volume_lbs, revenue, approved, approval_date, created, modified], Default: project_uid

  • odirection string optional

    Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc

  • filter string optional

    Filter results by keyword.

  • datefilter date [YYYY-MM-DD] optional

    Filter results by date.

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/projects
Using URL Parameters
Using URL Segments
JSON Response
  • section string

    Returns a requested section: projects.

  • projects array

    Project details are listed here. Each project contains the overview data, stages, tasks, repository files and folders.

  • projects_total integer

    Returns of total number of projects based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field.

  • odirection string

    Returns a requested order direction. [asc, desc]

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Get Project

Retrieves the details of an existing project. Set the unique project ID from either a project creation request or the project list request.

URL Parameters
  • id integer required

    Set the project unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/project/{id}
JSON Response
  • section string

    Returns a requested section: projects.

  • section_uid integer

    Project ID

  • action string

    [get]

  • data array

    Project details are listed here.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Recipes

The Recipes API provides a comprehensive set of endpoints for managing and retrieving detailed information about recipes within the system.

Users can access and manipulate recipes, which include essential details such as the recipe name, versions and ingredient manipulation, following by recipe Yield/Cost data, notes and tags.

Endpoints

List all Recipes

Returns a list of recipes. The recipes are returned sorted by recipe unique id, with the most recently created recipes appearing first.

URL Parameters
  • user string optional

    Defines the user's email address, for example john.doe@example.com.

  • page integer optional

    Sets the page. Default: 1

  • step integer optional

    Defines how many results are listed for the current page. Max Value: 1000, Default: 10

  • order string optional

    Enum Enum [unique_id, recipe_name, created, last_modified], Default: unique_id

  • odirection string optional

    Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc

  • filter string optional

    Filter results by keyword.

  • datefilter date [YYYY-MM-DD] optional

    Filter results by date.

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/recipes
Using URL Parameters
Using URL Segments
JSON Response
  • section string

    Returns a requested section: recipes.

  • recipes array

    Recipe details are listed here. Each recipes contains essential recipe details containing recipe versions with it's ingredients data.

  • recipe_total integer

    Returns of total number of recipes based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field.

  • odirection string

    Returns a requested order direction. [asc, desc]

  • user_name string

    Returns a requested user's name.

  • user_email string

    Returns a requested user's email address.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Get Recipe

Retrieves the details of an existing recipe. Set the unique recipe ID from either a recipe creation request or the recipe list request.

URL Parameters
  • id integer required

    Set the recipe unique id

  • region string optional

    Set the Composition rounding region. Can be "us" or "canada". Default value is "us".

  • dv string optional

    Set a daily value calculation method. In case of "us" region the DV% values can be "adult", "children", "infant" or "pregnant-women". In case of "canada" region the DV% value can be "adult", "children" or "infant". Default value is "adult";

  • quantities string optional

    Set the total quantity for composition calculation which can be "serving-size" or "100g-sample". Default value is "serving-size";

  • values string optional

    Set the nutrient quantity rounding method which can be "unrounded", "rounded" or "rounded_restaurant". Default value is "rounded";

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/recipe/{id}
Using URL Parameters
Using URL Segments
JSON Response
  • section string

    Returns a requested section: recipes.

  • section_uid integer

    Recipe ID

  • action string

    [get]

  • data array

    Recipe details are listed here.

  • region string

    Returns a requested region. ["us", "canada"]

  • dv string

    Returns a requested DV% value. ["adult", "children", "infant", "pregnant-women"]

  • quantities string

    Returns a requested quantity value. ["serving-size", "100g-sample"]

  • values string

    Returns a requested quantity value rounding method. ["unrounded", "rounded", "rounded_restaurant"]

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Recipe

Creates a new recipe.

Body Parameters
  • recipe_name string required

    Recipe Name.

  • yield_cost object optional

    Yield/Cost.

    • serving_size string optional

      Serving size.

    • serving_weight_gram string optional

      Serving weight (g) - If this one is present servings_per_container can't be.

    • servings_per_container string optional

      Servings / Container - If this one is present serving_weight_gram can't be.

  • procedure string optional

    Procedure.

  • ingredient_statement object optional

    Ingredient statement.

    • english_statement string optional

      English statement.

    • french_statement string optional

      French statement.

  • notes string optional

    Notes.

  • ingredients object optional

    List of recipe ingredients.

    • ingredient_id string required

      Ingredient id.

    • unit string required

      Ingredient units (Your organizations active units).

    • qty string required

      Ingredient quantity in recipe.

    • name string optional

      Ingredients new name in recipe.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/recipe/
cURL Request
JSON Response
  • section string

    Returns a requested section: recipes.

  • section_uid integer

    Newly created recipe ID.

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created recipe data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Ingredients

The Ingredients API provides a comprehensive set of endpoints for managing and retrieving detailed information about ingredients within the system.

Users can access and manipulate ingredients, which include essential details such as the ingredient name, Code, Category, Supplier, Cost/Unit and Date.

Each Ingredient has it's General data, Nutrients/Allergens data, Ingredient Statement and Procurement data.

Endpoints

List all Ingredients

Returns a list of ingredients. The ingredients are returned sorted by ingredient name in descending order.

URL Parameters
  • page integer optional

    Sets the page. Default: 1

  • step integer optional

    Defines how many results are listed for the current page. Max Value: 1000, Default: 10

  • order string optional

    Enum [name, ingredientcost_code, category_name, manufacturer, ingredientcost_cost, created], Default: name

  • odirection string optional

    Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc

  • filter string optional

    Filter results by keyword.

  • datefilter date [YYYY-MM-DD] optional

    Filter results by date.

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/ingredients
Using URL Parameters
Using URL Segments
JSON Response
  • section string

    Returns a requested section: ingredients.

  • ingredients array

    Ingredient details are listed here. Each ingredient contains essential ingredient details.

  • ingredients_total integer

    Returns of total number of ingredients based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field.

  • odirection string

    Returns a requested order direction. [asc, desc]

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_ingredient_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Get Ingredient

Retrieves the details of an existing ingredient. Set the unique ingredient ID from either a ingredient creation request or the ingredient list request.

URL Parameters
  • id integer[-]integer required

    Set the ingredient unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/ingredient/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: ingredients.

  • section_uid integer

    Ingredient ID

  • action string

    [get]

  • data array

    Ingredient details are listed here.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_ingredient_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Ingredient

Creates a new ingredient.

Body Parameters
  • ingredient string required

    Ingredient Name.

  • item_code string required

    Cost Code.

  • cost float required

    $ Price.

  • quantity float required

    Cost Quantity.

  • unit string required

    Cost Unit. Enum [kg, g, mg, mcg, oz, lbs, l, ml, tsp, tbsp, fl_oz, cup, pt, qt, gal, each].

  • yield float required

    Yield percentage.

  • fob_terms string required

    FOB terms. Enum ["Customer pickup", "Destination, freight prepaid", "Destination, freight collect", "Destination, freight collect and allowed", "Origin, freight prepaid", "Origin, freight collect", "Origin, freight prepaid and charged back", "Destination, freight prepaid and charged back"].

  • minimum_order_info string required

    Minimum Order Info.

  • category string required

    Ingredient category.

  • supplier string required

    Supplier.

  • ingredient_statement string required

    Ingredient statement.

  • canadian_ingredient_statement string required

    Ingredient statement (french).

  • density_weight float required

    Density weight.

  • density_weight_unit string required

    Density weight unit [g, kg, mg, lbs, oz].

  • density_unit string required

    Density volume unit [ml, l, tsp, tbsp, fl_oz, cup, pt, qt, gal].

  • processing_aid integer required

    Processing Aid [0,1]

  • protein_digestibility integer required

    Protein Digestibility [0 - 1].

  • notes string required

    Notes.

  • weight_g float required

    Weight (g). Default: 100.

  • calories_kcal float required

    Calories (kcal).

  • total_fat_g float required

    Total fat (g).

  • saturated_fat_g float required

    Saturated fat (g).

  • trans_fatty_acid_g float required

    Trans fatty acid (g).

  • cholesterol_mg float required

    Cholesterol (mg).

  • sodium_mg float required

    Sodium (mg).

  • total_carbohydrate_g float required

    Total Carbohydrate (g).

  • dietary_fiber_g float required

    Dietary Fiber (g).

  • total_sugars_g float required

    Total sugars (g).

  • added_sugars_g float required

    Added sugars (g).

  • protein_g float required

    Protein (g).

  • water_g float required

    Water (g).

  • ash_g float required

    Ash (g).

  • vitamin_a_iu float required

    Vitamin A (IU).

  • vitamin_a_rae_mcg float required

    Vitamin A (RAE) (mcg).

  • thiamin_mg float required

    Thiamin/B1 (mg).

  • riboflavin_mg float required

    Riboflavin/B2 (mg).

  • niacin_mg float required

    Niacin/B3 (mg).

  • vitamin_b6_mg float required

    Vitamin B6 (mg).

  • vitamin_b12_mcg float required

    Vitamin B12 (mcg).

  • vitamin_c_mg float required

    Vitamin C (mg).

  • vitamin_d_iu float required

    Vitamin D (IU).

  • vitamin_d_mcg float required

    Vitamin D (mcg).

  • vitamin_e_mg float required

    Vitamin E (mg).

  • vitamin_k_mcg float required

    Vitamin K (mcg).

  • beta_carotene_mcg float required

    Beta-carotene (mcg).

  • biotin_mcg float required

    Biotin/B7 (mcg).

  • food_folate_mcg float required

    Food folate (mcg).

  • folate_mcg float required

    Folate/B9 (mcg).

  • folate_dfe_mcg float required

    Folate/B9 (DFE) (mcg).

  • pantothenic_acid_mg float required

    Pantothenic acid (mg).

  • retinol_mcg float required

    Retinol (mcg).

  • calcium_mg float required

    Calcium (mg).

  • chloride_mg float required

    Chloride (mg).

  • chromium_mcg float required

    Chromium (mcg).

  • copper_mg float required

    Copper (mg).

  • iron_mg float required

    Iron (mg).

  • magnesium_mg float required

    Magnesium (mg).

  • manganese_mg float required

    Manganese (mg).

  • molybdenum_mcg float required

    Molybdenum (mcg).

  • phosphorus_mg float required

    Phosphorus (mg).

  • potassium_mg float required

    Potassium (mg).

  • selenium_mcg float required

    Selenium (mcg).

  • zinc_mg float required

    Zinc (mg).

  • monounsaturated_g float required

    Monounsaturated (g).

  • polyunsaturated_g float required

    Polyunsaturated (g).

  • omega_3_g float required

    Omega-3 (g).

  • omega_6_g float required

    Omega-6 (g).

  • alcohol_ethyl_g float required

    Alcohol, ethyl (g).

  • alpha_carotene_mcg float required

    Alpha-carotene (mcg).

  • beta_cryptoxanthin_mcg float required

    Beta-cryptoxanthin (mcg).

  • caffeine_mg float required

    Caffeine (mg).

  • choline_mg float required

    Choline (mg).

  • fluoride_mg float required

    Fluoride (mg).

  • folic_acid_mcg float required

    Folic acid (mcg).

  • lutein_zeazanthin_mcg float required

    Lutein+zeazanthin (mcg).

  • lycopene_mcg float required

    Lycopene (mcg).

  • iodine_mcg float required

    Iodine (mcg).

  • sugar_alcohol_g float required

    Sugar Alcohol (g).

  • allergen_egg string required

    Enum [Yes, No].

  • allergen_peanuts string required

    Enum [Yes, No].

  • allergen_milk string required

    Enum [Yes, No].

  • allergen_wheat string required

    Enum [Yes, No].

  • allergen_soy string required

    Enum [Yes, No].

  • allergen_tree_nuts string required

    Enum [Yes, No, custom value].

  • allergen_fish string required

    Enum [Yes, No, custom value].

  • allergen_shellfish string required

    Enum [Yes, No, custom value].

  • allergen_mustard string required

    Enum [Yes, No].

  • allergen_sesame_seeds string required

    Enum [Yes, No].

  • allergen_sulfites string required

    Enum [Yes, No].

  • allergen_gluten string required

    Enum [Yes, No].

  • maycontain_egg string required

    Enum [Yes, No].

  • maycontain_peanuts string required

    Enum [Yes, No].

  • maycontain_milk string required

    Enum [Yes, No].

  • maycontain_wheat string required

    Enum [Yes, No].

  • maycontain_soy string required

    Enum [Yes, No].

  • maycontain_tree_nuts string required

    Enum [Yes, No, custom value].

  • maycontain_fish string required

    Enum [Yes, No, custom value].

  • maycontain_shellfish string required

    Enum [Yes, No, custom value].

  • maycontain_mustard string required

    Enum [Yes, No].

  • maycontain_sesame_seeds string required

    Enum [Yes, No].

  • maycontain_sulfites string required

    Enum [Yes, No].

  • maycontain_gluten string required

    Enum [Yes, No].

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/ingredient/
cURL Request
JSON Response
  • section string

    Returns a requested section: ingredients.

  • section_uid integer[-]integer

    Newly created ingredient ID.

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created ingredient data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_ingredient_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Update Ingredient

Updates an existing ingredient.

URL Parameters
  • id integer[-]integer required

    Set the ingredient unique id

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/ingredient/{id}
cURL Request
Body Parameters
  • ingredient string required

    Ingredient Name.

  • item_code string required

    Cost Code.

  • cost float required

    $ Price.

  • quantity float required

    Cost Quantity.

  • unit string required

    Cost Unit. Enum [kg, g, mg, mcg, oz, lbs, l, ml, tsp, tbsp, fl_oz, cup, pt, qt, gal, each].

  • yield float required

    Yield percentage.

  • fob_terms string required

    FOB terms. Enum ["Customer pickup", "Destination, freight prepaid", "Destination, freight collect", "Destination, freight collect and allowed", "Origin, freight prepaid", "Origin, freight collect", "Origin, freight prepaid and charged back", "Destination, freight prepaid and charged back"].

  • minimum_order_info string required

    Minimum Order Info.

  • category string required

    Ingredient category.

  • supplier string required

    Supplier.

  • ingredient_statement string required

    Ingredient statement.

  • canadian_ingredient_statement string required

    Ingredient statement (french).

  • density_weight float required

    Density weight.

  • density_weight_unit string required

    Density weight unit [g, kg, mg, lbs, oz].

  • density_unit string required

    Density volume unit [ml, l, tsp, tbsp, fl_oz, cup, pt, qt, gal].

  • processing_aid integer required

    Processing Aid [0,1]

  • protein_digestibility integer required

    Protein Digestibility [0 - 1].

  • notes string required

    Notes.

  • weight_g float required

    Weight (g). Default: 100.

  • calories_kcal float required

    Calories (kcal).

  • total_fat_g float required

    Total fat (g).

  • saturated_fat_g float required

    Saturated fat (g).

  • trans_fatty_acid_g float required

    Trans fatty acid (g).

  • cholesterol_mg float required

    Cholesterol (mg).

  • sodium_mg float required

    Sodium (mg).

  • total_carbohydrate_g float required

    Total Carbohydrate (g).

  • dietary_fiber_g float required

    Dietary Fiber (g).

  • total_sugars_g float required

    Total sugars (g).

  • added_sugars_g float required

    Added sugars (g).

  • protein_g float required

    Protein (g).

  • water_g float required

    Water (g).

  • ash_g float required

    Ash (g).

  • vitamin_a_iu float required

    Vitamin A (IU).

  • vitamin_a_rae_mcg float required

    Vitamin A (RAE) (mcg).

  • thiamin_mg float required

    Thiamin/B1 (mg).

  • riboflavin_mg float required

    Riboflavin/B2 (mg).

  • niacin_mg float required

    Niacin/B3 (mg).

  • vitamin_b6_mg float required

    Vitamin B6 (mg).

  • vitamin_b12_mcg float required

    Vitamin B12 (mcg).

  • vitamin_c_mg float required

    Vitamin C (mg).

  • vitamin_d_iu float required

    Vitamin D (IU).

  • vitamin_d_mcg float required

    Vitamin D (mcg).

  • vitamin_e_mg float required

    Vitamin E (mg).

  • vitamin_k_mcg float required

    Vitamin K (mcg).

  • beta_carotene_mcg float required

    Beta-carotene (mcg).

  • biotin_mcg float required

    Biotin/B7 (mcg).

  • food_folate_mcg float required

    Food folate (mcg).

  • folate_mcg float required

    Folate/B9 (mcg).

  • folate_dfe_mcg float required

    Folate/B9 (DFE) (mcg).

  • pantothenic_acid_mg float required

    Pantothenic acid (mg).

  • retinol_mcg float required

    Retinol (mcg).

  • calcium_mg float required

    Calcium (mg).

  • chloride_mg float required

    Chloride (mg).

  • chromium_mcg float required

    Chromium (mcg).

  • copper_mg float required

    Copper (mg).

  • iron_mg float required

    Iron (mg).

  • magnesium_mg float required

    Magnesium (mg).

  • manganese_mg float required

    Manganese (mg).

  • molybdenum_mcg float required

    Molybdenum (mcg).

  • phosphorus_mg float required

    Phosphorus (mg).

  • potassium_mg float required

    Potassium (mg).

  • selenium_mcg float required

    Selenium (mcg).

  • zinc_mg float required

    Zinc (mg).

  • monounsaturated_g float required

    Monounsaturated (g).

  • polyunsaturated_g float required

    Polyunsaturated (g).

  • omega_3_g float required

    Omega-3 (g).

  • omega_6_g float required

    Omega-6 (g).

  • alcohol_ethyl_g float required

    Alcohol, ethyl (g).

  • alpha_carotene_mcg float required

    Alpha-carotene (mcg).

  • beta_cryptoxanthin_mcg float required

    Beta-cryptoxanthin (mcg).

  • caffeine_mg float required

    Caffeine (mg).

  • choline_mg float required

    Choline (mg).

  • fluoride_mg float required

    Fluoride (mg).

  • folic_acid_mcg float required

    Folic acid (mcg).

  • lutein_zeazanthin_mcg float required

    Lutein+zeazanthin (mcg).

  • lycopene_mcg float required

    Lycopene (mcg).

  • iodine_mcg float required

    Iodine (mcg).

  • sugar_alcohol_g float required

    Sugar Alcohol (g).

  • allergen_egg string required

    Enum [Yes, No].

  • allergen_peanuts string required

    Enum [Yes, No].

  • allergen_milk string required

    Enum [Yes, No].

  • allergen_wheat string required

    Enum [Yes, No].

  • allergen_soy string required

    Enum [Yes, No].

  • allergen_tree_nuts string required

    Enum [Yes, No, custom value].

  • allergen_fish string required

    Enum [Yes, No, custom value].

  • allergen_shellfish string required

    Enum [Yes, No, custom value].

  • allergen_mustard string required

    Enum [Yes, No].

  • allergen_sesame_seeds string required

    Enum [Yes, No].

  • allergen_sulfites string required

    Enum [Yes, No].

  • allergen_gluten string required

    Enum [Yes, No].

  • maycontain_egg string required

    Enum [Yes, No].

  • maycontain_peanuts string required

    Enum [Yes, No].

  • maycontain_milk string required

    Enum [Yes, No].

  • maycontain_wheat string required

    Enum [Yes, No].

  • maycontain_soy string required

    Enum [Yes, No].

  • maycontain_tree_nuts string required

    Enum [Yes, No, custom value].

  • maycontain_fish string required

    Enum [Yes, No, custom value].

  • maycontain_shellfish string required

    Enum [Yes, No, custom value].

  • maycontain_mustard string required

    Enum [Yes, No].

  • maycontain_sesame_seeds string required

    Enum [Yes, No].

  • maycontain_sulfites string required

    Enum [Yes, No].

  • maycontain_gluten string required

    Enum [Yes, No].

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/ingredient/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: ingredients.

  • section_uid integer[-]integer

    Updated ingredient ID.

  • action string

    [update]

  • success boolean

    [true, false]

  • data array

    Updated ingredient data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_ingredient_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Taste Tests

The Taste Tests API offers endpoints to retrieve comprehensive information about taste tests managed within the system.

Each taste test contains essential information such as its name, responses, owner, date and status.

Users can interact with taste tests by adding products, tasters, and essential test data.

Each taste test has it's questionnaire data and questionnaire results.

Endpoints

List all Taste Tests

Returns a list of taste tests. The taste tests are returned sorted by taste test unique id, with the most recently created tastetests appearing first.

URL Parameters
  • user string optional

    Defines the user's email address, for example john.doe@example.com.

  • page integer optional

    Sets the page. Default: 1

  • step integer optional

    Defines how many results are listed for the current page. Max Value: 1000, Default: 10

  • order string optional

    Enum [tastetest_uid, tastetest_status, tastetest_name, tastetest_date, tastetest_start_time, tastetest_end_time, tastetest_description, tastetest_location, created], Default: tastetest_uid

  • odirection string optional

    Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc

  • filter string optional

    Filter results by keyword.

  • datefilter date [YYYY-MM-DD] optional

    Filter results by date.

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/tastetests
Using URL Parameters
Using URL Segments
JSON Response
  • section string

    Returns a requested section: tastetests.

  • tastetests array

    Taste test details are listed here. Each taste test contains the essential data, questions, products, and results.

  • tastetests_total integer

    Returns of total number of taste tests based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field.

  • odirection string

    Returns a requested order direction. [asc, desc]

  • user_name string

    Returns a requested user's name.

  • user_email string

    Returns a requested user's email address.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Get Taste Test

Retrieves the details of an existing taste test. Set the unique taste test ID from either a taste test creation request or the taste test list request.

URL Parameters
  • id integer required

    Set the taste test unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/tastetest/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: tastetests.

  • section_uid integer

    Taste test ID

  • action string

    [get]

  • data array

    Taste test details are listed here.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

CRM Customers

The Customers API provides a comprehensive set of endpoints for managing and retrieving detailed information about customers within the system.

Users can access and manipulate customers, which include essential details such as the Name, Customer Type, Address, Business type, Fiscal Year and Date.

Each Customer data has it's Sales data, Corporate/Billing/Shipping Addresses.

Each Customer has connections to Opportunities, Contacts, Contracts and Activities

Endpoints

List all Customers

Returns a list of customers. The customers are returned sorted by customer unique id, with the most recently created customer appearing first.

URL Parameters
  • page integer optional

    Sets the page. Default: 1

  • step integer optional

    Defines how many results are listed for the current page. Max Value: 1000, Default: 10

  • order string optional

    Enum [id, account_name, customer_name, business_type, business_market_segment, contract_start_date, contract_end_date, created, modified], Default: name

  • odirection string optional

    Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc

  • filter string optional

    Filter results by keyword.

  • datefilter date [YYYY-MM-DD] optional

    Filter results by date.

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/customers
Using URL Parameters
Using URL Segments
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: customers.

  • customers array

    CRM customer details are listed here. Each customer contains essential customer details.

  • customers_total integer

    Returns of total number of customers based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field.

  • odirection string

    Returns a requested order direction. [asc, desc]

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Get Customer

Retrieves the details of an existing customer. Set the unique customer ID from either a customer creation request or the customer list request.

URL Parameters
  • id integer required

    Set the customer unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/customer/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: customers.

  • section_uid integer

    Customer ID

  • action string

    [get]

  • data array

    Customer details are listed here.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Customer

Creates a new customer.

Body Parameters
  • account_name string required

    Customer Name.

  • business_type string required

    Business Type (See CRM Settings)

  • business_market_segment string required

    Business Market Segment (See CRM Settings)

  • customer_tier string optional

    Customer Tier [Tier 1, Tier 2, Tier 3].

  • fiscal_year string optional

    Fiscal Year.

  • crm_type integer required

    Customer Type [1 = Regular, 2 = Prospect].

  • address string optional

    Street.

  • address_2 string optional

    Address Line 2.

  • address_city string optional

    City.

  • address_state string optional

    State.

  • address_zip_code string optional

    Zip Code.

  • address_country string optional

    Country.

  • billing_address string optional

    Billing Street.

  • billing_address_2 string optional

    Billing Address Line 2.

  • billing_city string optional

    Billing City.

  • billing_state string optional

    Billing State

  • billing_zip_code string optional

    Billing Zip Code.

  • billing_country string optional

    Billing Country.

  • shipping_address string optional

    Shipping Street.

  • shipping_address_2 string optional

    Shipping Address Line 2.

  • shipping_city string optional

    Shipping City.

  • shipping_state string optional

    Shipping State.

  • shipping_zip_code string optional

    Shipping Zip Code.

  • shipping_country string optional

    Shipping Country.

  • account_owner integer required

    Customer Owner (See Organizations).

  • annual_sales integer optional

    Annual sales (LFY).

  • current_budget integer optional

    Budget Current FY.

  • year_to_date_sales integer optional

    Year to date sales.

  • year_to_date_volume integer optional

    Year to date volume.

  • contract_start_date date [m-d-Y] required

    Contract Start Date.

  • contract_end_date date [m-d-Y] required

    Contract End Date.

  • notes string optional

    Notes.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/customer/
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: customers.

  • section_uid integer

    Newly created customer ID.

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created customer data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Update Customers

Updates an existing customer.

URL Parameters
  • id integer required

    Set the customer unique id

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/crm/customer/{id}
cURL Request
Body Parameters
  • account_name string required

    Customer Name.

  • business_type string required

    Business Type (See CRM Settings)

  • business_market_segment string required

    Business Market Segment (See CRM Settings)

  • customer_tier string optional

    Customer Tier [Tier 1, Tier 2, Tier 3].

  • fiscal_year string optional

    Fiscal Year.

  • crm_type integer required

    Customer Type [1 = Regular, 2 = Prospect].

  • address string optional

    Street.

  • address_2 string optional

    Address Line 2.

  • address_city string optional

    City.

  • address_state string optional

    State.

  • address_zip_code string optional

    Zip Code.

  • address_country string optional

    Country.

  • billing_address string optional

    Billing Street.

  • billing_address_2 string optional

    Billing Address Line 2.

  • billing_city string optional

    Billing City.

  • billing_state string optional

    Billing State

  • billing_zip_code string optional

    Billing Zip Code.

  • billing_country string optional

    Billing Country.

  • shipping_address string optional

    Shipping Street.

  • shipping_address_2 string optional

    Shipping Address Line 2.

  • shipping_city string optional

    Shipping City.

  • shipping_state string optional

    Shipping State.

  • shipping_zip_code string optional

    Shipping Zip Code.

  • shipping_country string optional

    Shipping Country.

  • account_owner integer required

    Customer Owner (See Organizations).

  • annual_sales integer optional

    Annual sales (LFY).

  • current_budget integer optional

    Budget Current FY.

  • year_to_date_sales integer optional

    Year to date sales.

  • year_to_date_volume integer optional

    Year to date volume.

  • contract_start_date date [m-d-Y] required

    Contract Start Date.

  • contract_end_date date [m-d-Y] required

    Contract End Date.

  • notes string optional

    Notes.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/crm/customer/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: customers.

  • section_uid integer

    Updated customer ID.

  • action string

    [update]

  • success boolean

    [true, false]

  • data array

    Updated customer data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

CRM Settings

The Settings API provides a comprehensive set of endpoints for managing and retrieving parts of CRM Settings.

Endpoints

List all Business Types

Returns a list of Business Types with it's Business Market Segments.

URL Parameters
  • There aren't any URL Parameters for this endpoint

HTTP Request

GEThttps://app.flavorstudio.com/api/v2/get/crm/business-types/
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: business_types.

  • crm_business_types array

    CRM Settings Business Types listed here. Each Business Types contains it's Business Market Segments.

  • crm_business_types_total integer

    Returns of total number of Business Types.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field.

  • odirection string

    Returns a requested order direction. [asc, desc]

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Business Type

Creates a new Business Type.

Body Parameters
  • name string required

    Business Type Name.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/business-type/
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: settings.

  • business_type_id integer

    Newly created business type ID.

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created business type data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Update Business Type

Updates an existing Business Type.

URL Parameters
  • id integer required

    Set the bussines type id. Supported values are integers and a special case when id is -1

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/crm/business-type/{id}
cURL Request
Body Parameters
  • original_name string required

    Business type original name before the updated new name.

  • name string required

    Business type new name

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/crm/business-type/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: settings.

  • business_type_id integer

    Updated business type ID.

  • action string

    [update]

  • success boolean

    [true, false]

  • data array

    Updated business type data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Delete Business Type

Deletes an existing Business Type.

URL Parameters
  • id integer required

    Set the bussines type id. Supported values are integers and a special case when id is -1

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/delete/crm/business-type/{id}
cURL Request
Body Parameters
  • name string required

    Business type name that's being deleted.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/delete/crm/business-type/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: settings.

  • business_type_id integer

    Deleted business type ID.

  • action string

    [delete]

  • success boolean

    [true, false]

  • data array

    Empty array.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Business Market Segment

Creates a new Business Market Segment.

Body Parameters
  • name string required

    Business market segment name.

  • parent_category string required

    Business type name.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/business-market-segment/
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: settings.

  • business_market_segment_id integer

    Newly created business market segment ID.

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created business market segment data.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Update Business Market Segment

Updates an existing Business Market Segment.

URL Parameters
  • id integer required

    Set the bussines market segment id. Supported values are integers and a special case when id is -1

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/crm/business-market-segment/{id}
cURL Request
Body Parameters
  • original_name string required

    Business market segment original name before the updated new name.

  • name string required

    Business market segment new name

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/crm/business-market-segment/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: settings.

  • business_market_segment_id integer

    Updated business market-segment ID.

  • action string

    [update]

  • success boolean

    [true, false]

  • data array

    Update business market segment data.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Delete Business Market Segment

Deletes an existing Business Market Segment.

URL Parameters
  • id integer required

    Set the bussines market segment id. Supported values are integers and a special case when id is -1

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/delete/crm/business-market-segment/{id}
cURL Request
Body Parameters
  • name string required

    Business market segment name that's being deleted.

  • parent_category string required

    Business type name.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/delete/crm/business-market-segment/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: settings.

  • business_market_segment_id integer

    Deleted business market segment ID.

  • action string

    [delete]

  • success boolean

    [true, false]

  • data array

    Empty array.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

CRM Opportunities

The Opportunities API provides a comprehensive set of endpoints for managing and retrieving detailed information about opportunities within the system.

Users can access and manipulate opportunities, which include essential details such as the Name, Owner, Customer, Stage, Probability and Date.

Each Opportunity data has it's Sales data, Corporate/Billing/Shipping Addresses.

Each Opportunity has connections to Customer, Product, Projects and Activities

Endpoints

List all Opportunities

Returns a list of Opportunities. The Opportunities are returned sorted by opportunity unique id, with the most recently created opportunity appearing first.

URL Parameters
  • page integer optional

    Sets the page. Default: 1

  • step integer optional

    Defines how many results are listed for the current page. Max Value: 1000, Default: 10

  • order string optional

    Enum [id, opportunity_name, product, annualized_pounds, annualized_rev, stage, probability_of_sale, start_date, close_date, created, modified, crm_customer], Default: id

  • odirection string optional

    Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc

  • filter string optional

    Filter results by keyword.

  • datefilter date [YYYY-MM-DD] optional

    Filter results by date.

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/opportunities
Using URL Parameters
Using URL Segments
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: opportunities.

  • opportunities array

    CRM opportunity details are listed here.

  • opportunities_total integer

    Returns of total number of opportunities based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field.

  • odirection string

    Returns a requested order direction. [asc, desc]

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Get Opportunity

Retrieves the details of an existing Opportunity. Set the unique opportunity ID from either a opportunity creation request or the opportunity list request.

URL Parameters
  • id integer required

    Set the opportunity unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/opportunity/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: opportunities.

  • section_uid integer

    Opportunity ID

  • action string

    [get]

  • data array

    Opportunity details are listed here.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Opportunity

Creates a new customer.

Body Parameters
  • opportunity_name string required

    Opportunity Name.

  • opportunity_owner integer required

    Opportunity Owner (See Organizations->Get Users)

  • customer_id integer required

    Customer (See CRM Customers)

  • start_date date [m-d-Y] optional

    Opportunity Created Date.

  • close_date date [m-d-Y] optional

    Opportunity Closed Date.

  • expected_launch_date date [m-d-Y] optional

    Expected Launch Date.

  • stage string optional

    Stage ['Initial Contact', 'R&D in Progress', 'Samples Sent', 'Culinary Presentation', 'In-Test with Customer', 'Approved', 'Pending PO', 'Closed-Win', 'On Hold', 'Lost', 'Canceled'].

  • probability_of_sale string optional

    Probability of Sale ['5%', '25%', '50%', '75%', '90%', '100%'].

  • ytg_pounds integer optional

    YTG Pounds.

  • product_type string optional

    Product Type ['custom', 'stock'].

  • product_uid integer optional

    Product (See CRM Products).

  • rd_required integer optional

    R&D Required [0=>'No', 1=>'Yes', 2=>'None'].

  • annualized_pounds integer/float required

    Annual Pounds.

  • price_per_pound integer/float required

    Estimated Price Per Pound.

  • contract_price_per_pound integer/float optional

    Contract Price Per Pound.

  • annualized_rev integer/float optional

    Annual Revenue (this is automatically calculated, but you can also enter your own number).

  • project_uid integer optional

    Connect a Project (See Projects).

  • description string optional

    Description.

  • notes string optional

    Notes.

  • lost_canceled_reason string optional

    Reason Lost/Canceled - Only fillable if "Stage" is ['Lost' or 'Canceled].

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: opportunities.

  • section_uid integer

    Newly created opportunity ID.

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created opportunity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Update Opportunity

Updates an existing opportunity.

URL Parameters
  • id integer required

    Set the opportunity unique id

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/crm/opportunity/{id}
Using URL Parameters
Body Parameters
  • opportunity_name string required

    Opportunity Name.

  • opportunity_owner integer required

    Opportunity Owner (See Organizations->Get Users)

  • customer_id integer required

    Customer (See CRM Customers)

  • start_date date [m-d-Y] optional

    Opportunity Created Date.

  • close_date date [m-d-Y] optional

    Opportunity Closed Date.

  • expected_launch_date date [m-d-Y] optional

    Expected Launch Date.

  • stage string optional

    Stage ['Initial Contact', 'R&D in Progress', 'Samples Sent', 'Culinary Presentation', 'In-Test with Customer', 'Approved', 'Pending PO', 'Closed-Win', 'On Hold', 'Lost', 'Canceled'].

  • probability_of_sale string optional

    Probability of Sale ['5%', '25%', '50%', '75%', '90%', '100%'].

  • ytg_pounds integer optional

    YTG Pounds.

  • product_type string optional

    Product Type ['custom', 'stock'].

  • product_uid integer optional

    Product (See CRM Products).

  • rd_required integer optional

    R&D Required [0=>'No', 1=>'Yes', 2=>'None'].

  • annualized_pounds integer/float required

    Annual Pounds.

  • price_per_pound integer/float required

    Estimated Price Per Pound.

  • contract_price_per_pound integer/float optional

    Contract Price Per Pound.

  • annualized_rev integer/float optional

    Annual Revenue (this is automatically calculated, but you can also enter your own number).

  • project_uid integer optional

    Connect a Project (See Projects).

  • description string optional

    Description.

  • lost_canceled_reason string optional

    Reason Lost/Canceled - Only fillable if "Stage" is ['Lost' or 'Canceled].

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/crm/opportunity/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: opportunities.

  • section_uid integer

    Updated opportunity ID.

  • action string

    [update]

  • success boolean

    [true, false]

  • data array

    Updated opportunity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

CRM Contracts

The Contracts API provides a comprehensive set of endpoints for managing and retrieving detailed information about contracts within the system.

Users can access and manipulate contracts, which include essential details such as the Name, Owner, Customer, Annual Volume, Annual Revenue and Date.

Each Contrat has connections to Customer, Opportunity and Activities

Endpoints

List all Contracts

Returns a list of Contracts. The Contracts are returned sorted by contract unique id, with the most recently created contract appearing first.

URL Parameters
  • page integer optional

    Sets the page. Default: 1

  • step integer optional

    Defines how many results are listed for the current page. Max Value: 1000, Default: 10

  • order string optional

    Enum [id, contract_name, account_type, product_type, product, annualized_pounds, annualized_rev, contract_start_date, contract_end_date, created, modified, crm_customer]

  • odirection string optional

    Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc

  • filter string optional

    Filter results by keyword.

  • datefilter date [YYYY-MM-DD] optional

    Filter results by date.

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/contracts
Using URL Parameters
Using URL Segments
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contracts.

  • contracts array

    CRM contracts details are listed here.

  • contracts_total integer

    Returns of total number of CRM contracts based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field.

  • odirection string

    Returns a requested order direction. [asc, desc]

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Get Contract

Retrieves the details of an existing Contract. Set the unique contract ID from either a contract creation request or the contract list request.

URL Parameters
  • id integer required

    Set the contract unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/contract/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contracts.

  • section_uid integer

    Contract ID

  • action string

    [get]

  • data array

    Opportunity details are listed here.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Contract

Creates a new contract.

Body Parameters
  • contract_name string required

    Contract Name.

  • opportunity_id integer required

    Opportunity (See CRM Opportunities)

  • contract_owner integer required

    Contract Owner (See Organizations->Get Users)

  • customer_id integer required

    Customer (See CRM Customers)

  • customer_tier string optional

    Customer Tier [Tier 1, Tier 2, Tier 3].

  • contract_start_date date [m-d-Y] optional

    Contract Start Date.

  • contract_end_date date [m-d-Y] optional

    Contract End Date.

  • expected_launch_date date [m-d-Y] optional

    Expected contract launch date.

  • product_type string optional

    Product Type ['custom', 'stock'].

  • product_uid integer optional

    Product (See CRM Products).

  • rd_required integer optional

    R&D Required [0=>'No', 1=>'Yes', 2=>'None'].

  • annualized_pounds integer/float required

    Annual Pounds.

  • price_per_pound integer/float required

    Price Per Pound.

  • annualized_rev integer/float optional

    Annual Revenue (this is automatically calculated, but you can also enter your own number).

  • description string optional

    Description.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contract/
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contracts.

  • section_uid integer

    Newly created contract ID.

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created contract data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Update Contract

Updates an existing opportunity.

URL Parameters
  • id integer required

    Set the contract unique id

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/crm/contract/{id}
Using URL Parameters
Body Parameters
  • contract_name string required

    Contract Name.

  • opportunity_id integer required

    Opportunity (See CRM Opportunities)

  • contract_owner integer required

    Contract Owner (See Organizations->Get Users)

  • customer_id integer required

    Customer (See CRM Customers)

  • customer_tier string optional

    Customer Tier [Tier 1, Tier 2, Tier 3].

  • contract_start_date date [m-d-Y] optional

    Contract Start Date.

  • contract_end_date date [m-d-Y] optional

    Contract End Date.

  • expected_launch_date date [m-d-Y] optional

    Expected contract launch date.

  • product_type string optional

    Product Type ['custom', 'stock'].

  • product_uid integer optional

    Product (See CRM Products).

  • rd_required integer optional

    R&D Required [0=>'No', 1=>'Yes', 2=>'None'].

  • annualized_pounds integer/float required

    Annual Pounds.

  • price_per_pound integer/float required

    Price Per Pound.

  • annualized_rev integer/float optional

    Annual Revenue (this is automatically calculated, but you can also enter your own number).

  • description string optional

    Description.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/crm/contract/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contracts.

  • section_uid integer

    Updated contract ID.

  • action string

    [update]

  • success boolean

    [true, false]

  • data array

    Updated contract data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

CRM Activities

The Activities API provides a comprehensive set of endpoints for creating and retrieving detailed information about all activities within the system.

Users can access and create activities for all CRM categories.

Endpoints

List all Activities

Returns a list of activities. The activities are returned sorted by activity unique id, with the most recently created activities appearing first.

URL Parameters
  • page integer optional

    Sets the page. Default: 1

  • step integer optional

    Defines how many results are listed for the current page. Max Value: 1000, Default: 10

  • order string optional

    Enum [id, activity_type, activity_date, created, modified]

  • odirection string optional

    Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc

  • filter string optional

    Filter results by keyword.

  • datefilter date [YYYY-MM-DD] optional

    Filter results by date.

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/activities/
Using URL Parameters
Using URL Segments
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: activities.

  • activities array

    CRM activity details are listed here.

  • activities_total integer

    Returns of total number of activities based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field.

  • odirection string

    Returns a requested order direction. [asc, desc]

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Get Activity

Retrieves the details of an existing activity. Set the unique activity ID from either a activity creation request or the activity list request.

URL Parameters
  • id integer required

    Set the activity unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/activity/{id}
Using URL Parameters
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: activities.

  • section_uid integer

    Activity ID

  • action string

    [get]

  • data array

    Recipe details are listed here.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Customer Email

Creates a new customer activity - Email.

URL Parameters
  • id integer required

    Set the customer account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/customer/{id}/activity/email
cURL Request
Body Parameters
  • message string required

    Email message.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/customer/{id}/activity/email
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: customer.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: email

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Customer Phone Call

Creates a new customer activity - Phone Call.

URL Parameters
  • id integer required

    Set the customer account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/customer/{id}/activity/phone-call
cURL Request
Body Parameters
  • message string required

    Phone call message.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/customer/{id}/activity/phone-call
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: customer.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: phone-call

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Customer Meeting

Creates a new customer activity - Meeting.

URL Parameters
  • id integer required

    Set the customer account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/customer/{id}/activity/meeting
cURL Request
Body Parameters
  • message string required

    Meeting purpose.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/customer/{id}/activity/meeting
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: customer.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: meeting

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Customer Task

Creates a new customer activity - Task.

URL Parameters
  • id integer required

    Set the customer account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/customer/{id}/activity/task
cURL Request
Body Parameters
  • message string required

    Task purpose.

  • task_user_id integer optional

    Task Assigned to user (See Organizations->Get Users)

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

  • completed boolean optional

    Task completed [true, false].

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/customer/{id}/activity/task
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: customer.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: task

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Customer Misc

Creates a new customer activity - Misc.

URL Parameters
  • id integer required

    Set the customer account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/customer/{id}/activity/misc
cURL Request
Body Parameters
  • message string required

    Misc purpose.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/customer/{id}/activity/misc
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: customer.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: misc

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Customer Sample Request

Creates a new customer activity - Sample Request.

URL Parameters
  • id integer required

    Set the customer account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/customer/{id}/activity/sample-request
cURL Request
Body Parameters
  • requested_by_id integer required

    Requested by user (See Organizations->Get Users)

  • opportunity_id integer required

    Opportunity (See CRM Opportunities)

  • delivery_date date [m-d-Y] required

    Sample Request Delivery Date.

  • recipient string required

    Recipient type [contact, salesperson, pickup].

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).
    Allowed when recipient [contact, pickup]

  • contact_user_id integer optional

    User id (See Organizations->Get Users).Allowed when recipient [salesperson, pickup].

  • contact_email string optional

    Contact Email (Specify email other than the contacts email).

  • contact_street string optional

    Contact Street (Enter value if contact doesnt have a Contact Street) Allowed when recipient [contact, salesperson].

  • contact_address2 string optional

    Contact Address Line 2 (Enter value if contact doesnt have a Address Line 2)
    Allowed when recipient [contact, salesperson].

  • contact_city string optional

    Contact City (Enter value if contact doesnt have a Contact City)
    Allowed when recipient [contact, salesperson].

  • contact_state string optional

    Contact State/Province (Enter value if contact doesnt have a Contact State/Province) Allowed when recipient [contact, salesperson].

  • contact_zip_code string optional

    Contact Zip Code (Enter value if contact doesnt have a Contact Zip Code)
    Allowed when recipient [contact, salesperson].

  • contact_country string optional

    Contact Country (Enter value if contact doesnt have a Contact Country)
    Allowed when recipient [contact, salesperson]
    (See Countries).

  • notes string optional

    Notes.

  • product_samples object optional

    List of product samples.

    • product_id string required

      Product id.

    • name string optional

      Products new name in sample.

    • unit string required

      Product units in sample(Your organizations active units).

    • qty string required

      Product quantity in sample.

    • size string required

      Product size (Number of units).

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/customer/{id}/activity/sample-request
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: customer.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: sample-request

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Customer Price Request

Creates a new customer activity - Price Request.

URL Parameters
  • id integer required

    Set the customer account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/customer/{id}/activity/price-request
cURL Request
Body Parameters
  • requested_by_id integer required

    Requested by user (See Organizations->Get Users)

  • opportunity_id integer required

    Opportunity (See CRM Opportunities)

  • needed_date date [m-d-Y] required

    Price Request Date Needed.

  • annualized_pounds integer/float required

    Annual Pounds.

  • price_per_pound integer/float required

    Estimated Price Per Pound.

  • freight string required

    Freight [FOB, Delivered].

  • notes string optional

    Notes.

  • product_samples object optional

    List of product samples.

    • product_id string required

      Product id.

    • name string optional

      Products new name in sample.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/customer/{id}/activity/price-request
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: customer.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: price-request

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Opportunity Email

Creates a new opportunity activity - Email.

URL Parameters
  • id integer required

    Set the opportunity account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/{id}/activity/email
cURL Request
Body Parameters
  • message string required

    Email message.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/{id}/activity/email
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: opportunity.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: email

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Opportunity Phone Call

Creates a new opportunity activity - Phone Call.

URL Parameters
  • id integer required

    Set the opportunity account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/{id}/activity/phone-call
cURL Request
Body Parameters
  • message string required

    Phone call message.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/{id}/activity/phone-call
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: opportunity.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: phone-call

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Opportunity Meeting

Creates a new opportunity activity - Meeting.

URL Parameters
  • id integer required

    Set the opportunity account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/{id}/activity/meeting
cURL Request
Body Parameters
  • message string required

    Meeting purpose.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/{id}/activity/meeting
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: opportunity.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: meeting

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Opportunity Task

Creates a new opportunity activity - Task.

URL Parameters
  • id integer required

    Set the opportunity account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/{id}/activity/task
cURL Request
Body Parameters
  • message string required

    Task purpose.

  • task_user_id integer optional

    Task Assigned to user (See Organizations->Get Users)

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

  • completed boolean optional

    Task completed [true, false].

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/{id}/activity/task
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: opportunity.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: task

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Opportunity Misc

Creates a new opportunity activity - Misc.

URL Parameters
  • id integer required

    Set the opportunity account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/{id}/activity/misc
cURL Request
Body Parameters
  • message string required

    Misc purpose.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/{id}/activity/misc
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: opportunity.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: misc

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Opportunity Sample Request

Creates a new opportunity activity - Sample Request.

URL Parameters
  • id integer required

    Set the opportunity account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/{id}/activity/sample-request
cURL Request
Body Parameters
  • requested_by_id integer required

    Requested by user (See Organizations->Get Users)

  • delivery_date date [m-d-Y] required

    Sample Request Delivery Date.

  • recipient string required

    Recipient type [contact, salesperson, pickup].

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).
    Allowed when recipient [contact, pickup]

  • contact_user_id integer optional

    User id (See Organizations->Get Users).Allowed when recipient [salesperson, pickup].

  • contact_email string optional

    Contact Email (Specify email other than the contacts email).

  • contact_street string optional

    Contact Street (Enter value if contact doesnt have a Contact Street) Allowed when recipient [contact, salesperson].

  • contact_address2 string optional

    Contact Address Line 2 (Enter value if contact doesnt have a Address Line 2)
    Allowed when recipient [contact, salesperson].

  • contact_city string optional

    Contact City (Enter value if contact doesnt have a Contact City)
    Allowed when recipient [contact, salesperson].

  • contact_state string optional

    Contact State/Province (Enter value if contact doesnt have a Contact State/Province) Allowed when recipient [contact, salesperson].

  • contact_zip_code string optional

    Contact Zip Code (Enter value if contact doesnt have a Contact Zip Code)
    Allowed when recipient [contact, salesperson].

  • contact_country string optional

    Contact Country (Enter value if contact doesnt have a Contact Country)
    Allowed when recipient [contact, salesperson]
    (See Countries).

  • notes string optional

    Notes.

  • product_samples object optional

    List of product samples.

    • product_id string required

      Product id.

    • name string optional

      Products new name in sample.

    • unit string required

      Product units in sample(Your organizations active units).

    • qty string required

      Product quantity in sample.

    • size string required

      Product size (Number of units).

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/{id}/activity/sample-request
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: opportunity.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: sample-request

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Opportunity Price Request

Creates a new opportunity activity - Price Request.

URL Parameters
  • id integer required

    Set the opportunity account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/{id}/activity/price-request
cURL Request
Body Parameters
  • requested_by_id integer required

    Requested by user (See Organizations->Get Users)

  • needed_date date [m-d-Y] required

    Price Request Date Needed.

  • annualized_pounds integer/float required

    Annual Pounds.

  • price_per_pound integer/float required

    Estimated Price Per Pound.

  • freight string required

    Freight [FOB, Delivered].

  • notes string optional

    Notes.

  • product_samples object optional

    List of product samples.

    • product_id string required

      Product id.

    • name string optional

      Products new name in sample.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/opportunity/{id}/activity/price-request
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: opportunity.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: price-request

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Contract Email

Creates a new contract activity - Email.

URL Parameters
  • id integer required

    Set the contract account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/contract/{id}/activity/email
cURL Request
Body Parameters
  • message string required

    Email message.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contract/{id}/activity/email
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contract.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: email

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Contract Phone Call

Creates a new contract activity - Phone Call.

URL Parameters
  • id integer required

    Set the contract account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/contract/{id}/activity/phone-call
cURL Request
Body Parameters
  • message string required

    Phone call message.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contract/{id}/activity/phone-call
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contract.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: phone-call

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Contract Meeting

Creates a new contract activity - Meeting.

URL Parameters
  • id integer required

    Set the contract account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/contract/{id}/activity/meeting
cURL Request
Body Parameters
  • message string required

    Meeting purpose.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contract/{id}/activity/meeting
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contract.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: meeting

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Contract Task

Creates a new contract activity - Task.

URL Parameters
  • id integer required

    Set the contract account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/contract/{id}/activity/task
cURL Request
Body Parameters
  • message string required

    Task purpose.

  • task_user_id integer optional

    Task Assigned to user (See Organizations->Get Users)

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

  • completed boolean optional

    Task completed [true, false].

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contract/{id}/activity/task
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: customer.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: task

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Contract Misc

Creates a new contract activity - Misc.

URL Parameters
  • id integer required

    Set the contract account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/contract/{id}/activity/misc
cURL Request
Body Parameters
  • message string required

    Misc purpose.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contract/{id}/activity/misc
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contract.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: misc

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Contract Sample Request

Creates a new contract activity - Sample Request.

URL Parameters
  • id integer required

    Set the contract account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/contract/{id}/activity/sample-request
cURL Request
Body Parameters
  • requested_by_id integer required

    Requested by user (See Organizations->Get Users)

  • opportunity_id integer required

    Opportunity (See CRM Opportunities)

  • delivery_date date [m-d-Y] required

    Sample Request Delivery Date.

  • recipient string required

    Recipient type [contact, salesperson, pickup].

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).
    Allowed when recipient [contact, pickup]

  • contact_user_id integer optional

    User id (See Organizations->Get Users).Allowed when recipient [salesperson, pickup].

  • contact_email string optional

    Contact Email (Specify email other than the contacts email).

  • contact_street string optional

    Contact Street (Enter value if contact doesnt have a Contact Street) Allowed when recipient [contact, salesperson].

  • contact_address2 string optional

    Contact Address Line 2 (Enter value if contact doesnt have a Address Line 2)
    Allowed when recipient [contact, salesperson].

  • contact_city string optional

    Contact City (Enter value if contact doesnt have a Contact City)
    Allowed when recipient [contact, salesperson].

  • contact_state string optional

    Contact State/Province (Enter value if contact doesnt have a Contact State/Province) Allowed when recipient [contact, salesperson].

  • contact_zip_code string optional

    Contact Zip Code (Enter value if contact doesnt have a Contact Zip Code)
    Allowed when recipient [contact, salesperson].

  • contact_country string optional

    Contact Country (Enter value if contact doesnt have a Contact Country)
    Allowed when recipient [contact, salesperson]
    (See Countries).

  • notes string optional

    Notes.

  • product_samples object optional

    List of product samples.

    • product_id string required

      Product id.

    • name string optional

      Products new name in sample.

    • unit string required

      Product units in sample(Your organizations active units).

    • qty string required

      Product quantity in sample.

    • size string required

      Product size (Number of units).

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contract/{id}/activity/sample-request
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contract.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: sample-request

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Contract Price Request

Creates a new contract activity - Price Request.

URL Parameters
  • id integer required

    Set the contract account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/contract/{id}/activity/price-request
cURL Request
Body Parameters
  • requested_by_id integer required

    Requested by user (See Organizations->Get Users)

  • opportunity_id integer required

    Opportunity (See CRM Opportunities)

  • needed_date date [m-d-Y] required

    Price Request Date Needed.

  • annualized_pounds integer/float required

    Annual Pounds.

  • price_per_pound integer/float required

    Estimated Price Per Pound.

  • freight string required

    Freight [FOB, Delivered].

  • notes string optional

    Notes.

  • product_samples object optional

    List of product samples.

    • product_id string required

      Product id.

    • name string optional

      Products new name in sample.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contract/{id}/activity/price-request
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contract.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: price-request

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Product Email

Creates a new product activity - Email.

URL Parameters
  • id integer required

    Set the product account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/product/{id}/activity/email
cURL Request
Body Parameters
  • message string required

    Email message.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/product/{id}/activity/email
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: product.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: email

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Product Phone Call

Creates a new product activity - Phone Call.

URL Parameters
  • id integer required

    Set the product account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/product/{id}/activity/phone-call
cURL Request
Body Parameters
  • message string required

    Phone call message.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/product/{id}/activity/phone-call
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: product.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: phone-call

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Product Meeting

Creates a new product activity - Meeting.

URL Parameters
  • id integer required

    Set the product account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/product/{id}/activity/meeting
cURL Request
Body Parameters
  • message string required

    Meeting purpose.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/product/{id}/activity/meeting
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: product.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: meeting

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Product Task

Creates a new product activity - Task.

URL Parameters
  • id integer required

    Set the product account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/product/{id}/activity/task
cURL Request
Body Parameters
  • message string required

    Task purpose.

  • task_user_id integer optional

    Task Assigned to user (See Organizations->Get Users)

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

  • completed boolean optional

    Task completed [true, false].

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/product/{id}/activity/task
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: product.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: task

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Product Misc

Creates a new product activity - Misc.

URL Parameters
  • id integer required

    Set the product account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/product/{id}/activity/misc
cURL Request
Body Parameters
  • message string required

    Misc purpose.

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).

  • contact_name string optional

    Contact Name.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/product/{id}/activity/misc
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: product.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: misc

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Product Sample Request

Creates a new product activity - Sample Request.

URL Parameters
  • id integer required

    Set the product account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/product/{id}/activity/sample-request
cURL Request
Body Parameters
  • requested_by_id integer required

    Requested by user (See Organizations->Get Users)

  • opportunity_id integer required

    Opportunity (See CRM Opportunities)

  • delivery_date date [m-d-Y] required

    Sample Request Delivery Date.

  • recipient string required

    Recipient type [contact, salesperson, pickup].

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).
    Allowed when recipient [contact, pickup]

  • contact_user_id integer optional

    User id (See Organizations->Get Users).Allowed when recipient [salesperson, pickup].

  • contact_email string optional

    Contact Email (Specify email other than the contacts email).

  • contact_street string optional

    Contact Street (Enter value if contact doesnt have a Contact Street) Allowed when recipient [contact, salesperson].

  • contact_address2 string optional

    Contact Address Line 2 (Enter value if contact doesnt have a Address Line 2)
    Allowed when recipient [contact, salesperson].

  • contact_city string optional

    Contact City (Enter value if contact doesnt have a Contact City)
    Allowed when recipient [contact, salesperson].

  • contact_state string optional

    Contact State/Province (Enter value if contact doesnt have a Contact State/Province) Allowed when recipient [contact, salesperson].

  • contact_zip_code string optional

    Contact Zip Code (Enter value if contact doesnt have a Contact Zip Code)
    Allowed when recipient [contact, salesperson].

  • contact_country string optional

    Contact Country (Enter value if contact doesnt have a Contact Country)
    Allowed when recipient [contact, salesperson]
    (See Countries).

  • notes string optional

    Notes.

  • product_samples object optional

    List of product samples.

    • product_id string required

      Product id.

    • name string optional

      Products new name in sample.

    • unit string required

      Product units in sample(Your organizations active units).

    • qty string required

      Product quantity in sample.

    • size string required

      Product size (Number of units).

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/product/{id}/activity/sample-request
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: product.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: sample-request

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Product Price Request

Creates a new product activity - Price Request.

URL Parameters
  • id integer required

    Set the product account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/custproductomer/{id}/activity/price-request
cURL Request
Body Parameters
  • requested_by_id integer required

    Requested by user (See Organizations->Get Users)

  • opportunity_id integer required

    Opportunity (See CRM Opportunities)

  • needed_date date [m-d-Y] required

    Price Request Date Needed.

  • annualized_pounds integer/float required

    Annual Pounds.

  • price_per_pound integer/float required

    Estimated Price Per Pound.

  • freight string required

    Freight [FOB, Delivered].

  • notes string optional

    Notes.

  • product_samples object optional

    List of product samples.

    • product_id string required

      Product id.

    • name string optional

      Products new name in sample.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/product/{id}/activity/price-request
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: product.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: price-request

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Contact Email

Creates a new contact activity - Email.

URL Parameters
  • id integer required

    Set the contact account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/contact/{id}/activity/email
cURL Request
Body Parameters
  • message string required

    Email message.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contact/{id}/activity/email
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contact.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: email

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Contact Phone Call

Creates a new contact activity - Phone Call.

URL Parameters
  • id integer required

    Set the contact account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/contact/{id}/activity/phone-call
cURL Request
Body Parameters
  • message string required

    Phone call message.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contact/{id}/activity/phone-call
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contact.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: phone-call

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Contact Meeting

Creates a new contact activity - Meeting.

URL Parameters
  • id integer required

    Set the contact account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/contact/{id}/activity/meeting
cURL Request
Body Parameters
  • message string required

    Meeting purpose.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contact/{id}/activity/meeting
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contact.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: meeting

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Contact Task

Creates a new contact activity - Task.

URL Parameters
  • id integer required

    Set the contact account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/contact/{id}/activity/task
cURL Request
Body Parameters
  • message string required

    Task purpose.

  • task_user_id integer optional

    Task Assigned to user (See Organizations->Get Users)

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

  • completed boolean optional

    Task completed [true, false].

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contact/{id}/activity/task
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contact.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: task

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Contact Misc

Creates a new contact activity - Misc.

URL Parameters
  • id integer required

    Set the contact account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/contact/{id}/activity/misc
cURL Request
Body Parameters
  • message string required

    Misc purpose.

  • activity_date date [m-d-Y] required

    Activity Created Date.

  • activity_owner_id integer required

    Activity Owner (See Organizations->Get Users)

  • opportunity_id integer optional

    Opportunity (See CRM Opportunities)

  • reminder_date date [m-d-Y] optional

    Activity Reminder Date.

  • notes string optional

    Notes.

  • next_steps string optional

    Next Steps.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contact/{id}/activity/misc
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contact.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: misc

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Contact Sample Request

Creates a new contact activity - Sample Request.

URL Parameters
  • id integer required

    Set the contact account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/contact/{id}/activity/sample-request
cURL Request
Body Parameters
  • requested_by_id integer required

    Requested by user (See Organizations->Get Users)

  • opportunity_id integer required

    Opportunity (See CRM Opportunities)

  • delivery_date date [m-d-Y] required

    Sample Request Delivery Date.

  • recipient string required

    Recipient type [contact, salesperson, pickup].

  • contact_id integer optional

    Contact belonging to Customer (See CRM Contacts).
    Allowed when recipient [contact, pickup]

  • contact_user_id integer optional

    User id (See Organizations->Get Users).Allowed when recipient [salesperson, pickup].

  • contact_email string optional

    Contact Email (Specify email other than the contacts email).

  • contact_street string optional

    Contact Street (Enter value if contact doesnt have a Contact Street) Allowed when recipient [contact, salesperson].

  • contact_address2 string optional

    Contact Address Line 2 (Enter value if contact doesnt have a Address Line 2)
    Allowed when recipient [contact, salesperson].

  • contact_city string optional

    Contact City (Enter value if contact doesnt have a Contact City)
    Allowed when recipient [contact, salesperson].

  • contact_state string optional

    Contact State/Province (Enter value if contact doesnt have a Contact State/Province) Allowed when recipient [contact, salesperson].

  • contact_zip_code string optional

    Contact Zip Code (Enter value if contact doesnt have a Contact Zip Code)
    Allowed when recipient [contact, salesperson].

  • contact_country string optional

    Contact Country (Enter value if contact doesnt have a Contact Country)
    Allowed when recipient [contact, salesperson]
    (See Countries).

  • notes string optional

    Notes.

  • product_samples object optional

    List of product samples.

    • product_id string required

      Product id.

    • name string optional

      Products new name in sample.

    • unit string required

      Product units in sample(Your organizations active units).

    • qty string required

      Product quantity in sample.

    • size string required

      Product size (Number of units).

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contact/{id}/activity/sample-request
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contact.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: sample-request

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Activity - Contact Price Request

Creates a new contact activity - Price Request.

URL Parameters
  • id integer required

    Set the contact account unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/create/crm/contact/{id}/activity/price-request
cURL Request
Body Parameters
  • requested_by_id integer required

    Requested by user (See Organizations->Get Users)

  • opportunity_id integer required

    Opportunity (See CRM Opportunities)

  • needed_date date [m-d-Y] required

    Price Request Date Needed.

  • annualized_pounds integer/float required

    Annual Pounds.

  • price_per_pound integer/float required

    Estimated Price Per Pound.

  • freight string required

    Freight [FOB, Delivered].

  • notes string optional

    Notes.

  • product_samples object optional

    List of product samples.

    • product_id string required

      Product id.

    • name string optional

      Products new name in sample.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contact/{id}/activity/price-request
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contact.

  • section_name string

    Returns a requested section name: activities.

  • section_uid integer

    Newly created activity ID.

  • type string

    Returns a requested activity type: price-request

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created activity data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

CRM Contacts

The Contacts API provides a comprehensive set of endpoints for managing and retrieving detailed information about contacts within the system.

Users can access and manipulate contacts, which include essential details such as the Name, Email, Customer, Phone, Mobile and Date.

Each Contact has connections to Custtomers and Activities

Endpoints

List all Contacts

Returns a list of contacts. The contacts are returned sorted by contact unique id, with the most recently created contact appearing first.

URL Parameters
  • page integer optional

    Sets the page. Default: 1

  • step integer optional

    Defines how many results are listed for the current page. Max Value: 1000, Default: 10

  • order string optional

    Enum [id, contact_name, created, modified, crm_customer, crm_contract].

  • odirection string optional

    Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc

  • filter string optional

    Filter results by keyword.

  • datefilter date [YYYY-MM-DD] optional

    Filter results by date.

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/contacts
Using URL Parameters
Using URL Segments
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contacts.

  • contacts array

    CRM contact details are listed here. Each contact contains essential contact details.

  • contacts_total integer

    Returns of total number of contacts based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field.

  • odirection string

    Returns a requested order direction. [asc, desc]

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Get Contact

Retrieves the details of an existing contact. Set the unique contact ID from either a contact creation request or the contact list request.

URL Parameters
  • id integer required

    Set the contact unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/contact/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contacts.

  • section_uid integer

    Contact ID

  • action string

    [get]

  • data array

    Contact details are listed here.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Contact

Creates a new contact.

Body Parameters
  • account_uid integer required

    Customer (See CRM Customers).

  • contact_first_name string optional

    First Name.

  • contact_middle_name string optional

    Middle Name.

  • contact_last_name string optional

    Last Name.

  • contact_phone string optional

    Phone (Starts with calling number folowed by a space "+1 123456").

  • contact_phone_ext string optional

    Phone Ext.

  • contact_mobile string optional

    Mobile (Starts with calling number folowed by a space "+1 123456").

  • contact_fax string optional

    Fax (Starts with calling number folowed by a space "+1 123456").

  • contact_email string optional

    Email.

  • contact_title string optional

    Title.

  • contact_address string optional

    Street (Empty when "Address Source is one of ['billing','corporate','shipping']").

  • contact_address2 string optional

    Address Line 2 (Empty when "Address Source is one of ['billing','corporate','shipping']").

  • contact_city string optional

    City (Empty when "Address Source is one of ['billing','corporate','shipping']").

  • contact_state string optional

    State/Province (Empty when "Address Source is one of ['billing','corporate','shipping']").

  • contact_zip_code string optional

    Zip Code (Empty when "Address Source is one of ['billing','corporate','shipping']").

  • contact_country string optional

    Country (See Countries) (Empty when "Address Source is one of ['billing','corporate','shipping']").

  • contact_secondary_address_title string optional

    Secondary address title.

  • contact_secondary_address string optional

    Street (secondary).

  • contact_secondary_address2 string optional

    Address Line 2 (secondary).

  • contact_secondary_city string optional

    City (secondary).

  • contact_secondary_state string optional

    State/Province (secondary).

  • contact_secondary_zip_code string optional

    Zip Code(secondary).

  • contact_secondary_country string optional

    Country (secondary) (See Countries).

  • contact_reports_to string optional

    Reports To.

  • contact_bday_month integer required

    Birthday Month Enum [January, February, March, April, May, June, July, August, September, October, November, December].

  • contact_bday_day integer optional

    Birthday Day.

  • address_source string optional

    Address Source Enum [new, billing, corporate, shipping].

  • contact_type string optional

    Contact Type.

  • contact_end_user string optional

    End User.

  • other_vendors string optional

    Other Vendors / Competitors.

  • notes string optional

    Notes.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/contact/
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contacts.

  • section_uid integer

    Newly created contact ID.

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created contact data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Update Contact

Updates an existing contact.

URL Parameters
  • id integer required

    Set the contact unique id

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/crm/contact/{id}
Using URL Parameters
Body Parameters
  • account_uid integer required

    Customer (See CRM Customers).

  • contact_first_name string optional

    First Name.

  • contact_middle_name string optional

    Middle Name.

  • contact_last_name string optional

    Last Name.

  • contact_phone string optional

    Phone (Starts with calling number folowed by a space "+1 123456").

  • contact_phone_ext string optional

    Phone Ext.

  • contact_mobile string optional

    Mobile (Starts with calling number folowed by a space "+1 123456").

  • contact_fax string optional

    Fax (Starts with calling number folowed by a space "+1 123456").

  • contact_email string optional

    Email.

  • contact_title string optional

    Title.

  • contact_address string optional

    Street (Empty when "Address Source is one of ['billing','corporate','shipping']").

  • contact_address2 string optional

    Address Line 2 (Empty when "Address Source is one of ['billing','corporate','shipping']").

  • contact_city string optional

    City (Empty when "Address Source is one of ['billing','corporate','shipping']").

  • contact_state string optional

    State/Province (Empty when "Address Source is one of ['billing','corporate','shipping']").

  • contact_zip_code string optional

    Zip Code (Empty when "Address Source is one of ['billing','corporate','shipping']").

  • contact_country string optional

    Country (See Countries) (Empty when "Address Source is one of ['billing','corporate','shipping']").

  • contact_secondary_address_title string optional

    Secondary address title.

  • contact_secondary_address string optional

    Street (secondary).

  • contact_secondary_address2 string optional

    Address Line 2 (secondary).

  • contact_secondary_city string optional

    City (secondary).

  • contact_secondary_state string optional

    State/Province (secondary).

  • contact_secondary_zip_code string optional

    Zip Code(secondary).

  • contact_secondary_country string optional

    Country (secondary) (See Countries).

  • contact_reports_to string optional

    Reports To.

  • contact_bday_month integer required

    Birthday Month Enum [January, February, March, April, May, June, July, August, September, October, November, December].

  • contact_bday_day integer optional

    Birthday Day.

  • address_source string optional

    Address Source Enum [new, billing, corporate, shipping].

  • contact_type string optional

    Contact Type.

  • contact_end_user string optional

    End User.

  • other_vendors string optional

    Other Vendors / Competitors.

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/crm/contact/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: contacts.

  • section_uid integer

    Updated contact ID.

  • action string

    [update]

  • success boolean

    [true, false]

  • data array

    Updated contact data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

CRM Products

The Products API provides a comprehensive set of endpoints for managing and retrieving detailed information about products within the system.

Users can access and manipulate products, which include essential details such as the Name, Item Code, Brand, Size, Count and Date.

Each Product has connections to Opportunities and Activities

Endpoints

List all Products

Returns a list of products. The products are returned sorted by product unique id, with the most recently created product appearing first.

URL Parameters
  • page integer optional

    Sets the page. Default: 1

  • step integer optional

    Defines how many results are listed for the current page. Max Value: 1000, Default: 10

  • order string optional

    Enum [id, item_code, product_name, product_type, discontinued, created, modified]. Default: id

  • odirection string optional

    Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc

  • filter string optional

    Filter results by keyword.

  • datefilter date [YYYY-MM-DD] optional

    Filter results by date.

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/products
Using URL Parameters
Using URL Segments
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: products.

  • products array

    CRM product details are listed here. Each product contains essential product details.

  • products_total integer

    Returns of total number of products based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field.

  • odirection string

    Returns a requested order direction. [asc, desc]

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Get Product

Retrieves the details of an existing product. Set the unique product ID from either a product creation request or the product list request.

URL Parameters
  • id integer required

    Set the product unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/crm/product/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: products.

  • section_uid integer

    Product ID

  • action string

    [get]

  • data array

    Product details are listed here.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Create Product

Creates a new product.

Body Parameters
  • product_name string required

    Product Name

  • item_code string required

    First Name.

  • product_type string required

    Product Type Enum [Made to Order, Made to Stock].

  • product_brand string optional

    Brand.

  • size string optional

    Size.

  • unit string optional

    Unit Enum [lb, oz, fl oz].

  • count integer optional

    Pack Count.

  • description string optional

    Description.

  • certifications string optional

    Certifications array of multiple values ['Organic', 'Non GMO', 'Vegan', 'Kosher', 'Kosher for Passover', 'Gluten Free', 'Halal', 'Bioengineered', 'FID Sheet'].

  • discontinued integer optional

    Discontinued [0, 1].

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/create/crm/product/
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: products.

  • section_uid integer

    Newly created product ID.

  • action string

    [create]

  • success boolean

    [true, false]

  • data array

    Newly created product data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Update Product

Updates an existing product.

URL Parameters
  • id integer required

    Set the product unique id

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/crm/product/{id}
Using URL Parameters
Body Parameters
  • product_name string required

    Product Name

  • item_code string required

    First Name.

  • product_type string required

    Product Type Enum [Made to Order, Made to Stock].

  • product_brand string optional

    Brand.

  • size string optional

    Size.

  • unit string optional

    Unit Enum [lb, oz, fl oz].

  • count integer optional

    Pack Count.

  • description string optional

    Description.

  • certifications string optional

    Certifications array of multiple values ['Organic', 'Non GMO', 'Vegan', 'Kosher', 'Kosher for Passover', 'Gluten Free', 'Halal', 'Bioengineered', 'FID Sheet'].

  • discontinued integer optional

    Discontinued [0, 1].

HTTP Request

POSThttps://app.flavorstudio.com/api/v2/update/crm/product/{id}
cURL Request
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: products.

  • section_uid integer

    Updated product ID.

  • action string

    [update]

  • success boolean

    [true, false]

  • data array

    Updated product data is listed here.

  • errors array

    Contains list of error messages.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

CRM Purchase Orders

The Purchase Orders API offers endpoints to retrieve comprehensive information about purchase orders managed within the system.

Each purchase order contains essential information such as its Customer, Activities, Order Date, Delivery Date and Status.

Users can interact with purchase orders by adding customers, contracts, and products.

Each purchase order is linked to a customer and contract.

Endpoints

List all Purchase Orders

Returns a list of purchase orders. The purchase orders are returned sorted by purchase order id, with the most recently created purchase orders appearing first.

URL Parameters
  • page integer optional

    Sets the page. Default: 1

  • step integer optional

    Defines how many results are listed for the current page. Max Value: 1000, Default: 10

  • order string optional

    Enum [id, purchase_order_number, created, modified, crm_customer_uid, crm_customer], Default: id

  • odirection string optional

    Sets the order direction, it can be ascending (asc) or descending (desc). Default: desc

  • filter string optional

    Filter results by keyword.

  • datefilter date [YYYY-MM-DD] optional

    Filter results by date.

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/purchase-orders
Using URL Parameters
Using URL Segments
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: purchase-orders.

  • purchase-orders array

    Project purchase orders are listed here.

  • purchase-orders_total integer

    Returns of total number of purchase orders based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field.

  • odirection string

    Returns a requested order direction. [asc, desc]

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Get Purchase Order

Retrieves the details of an existing purchase order. Set the unique purchase order ID from either a purchase order creation request or the purchase order list request.

URL Parameters
  • id integer required

    Set the purchase order unique id

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/purchase-order/{id}
JSON Response
  • section string

    Returns a requested section: crm.

  • sub_section string

    Returns a requested CRM sub-section: purchase-orders.

  • section_uid integer

    Purchase Order ID

  • action string

    [get]

  • data array

    Purchase order details are listed here.

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Organizations

The Organizations API offers endpoints to retrieve comprehensive organization information.

Endpoints

Get Users

Retrieves the users details belonging to your organization.

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/admin/organization/users/
JSON Response
  • section string

    Returns a requested section: organization.

  • sub_section string

    Returns a requested organization sub-section: users.

  • organization_users array

    Organization users are listed here.

  • organization_users_total integer

    Returns of total number of users based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field.

  • odirection string

    Returns a requested order direction. [asc, desc]

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Get Groups

Retrieves the user groups details belonging to your organization.

HTTP Request

GETPOSThttps://app.flavorstudio.com/api/v2/get/admin/organization/groups/
JSON Response
  • section string

    Returns a requested section: organization.

  • sub_section string

    Returns a requested organization sub-section: groups.

  • organization_groups array

    Organization groups are listed here.

  • organization_groups_total integer

    Returns of total number of groups based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field.

  • odirection string

    Returns a requested order direction. [asc, desc]

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Countries

The Countries API offers one endpoint to retrieve a list of Countries that is used accross the API.

Endpoints

Get Countries

Retrieves the countries used accross the API.

HTTP Request

GEThttps://app.flavorstudio.com/api/v2/get/admin/countries/
JSON Response
  • section string

    Returns a requested section: countries.

  • countries array

    Available countries are listed here.

  • countries_total integer

    Returns of total number of countries based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field. Default: id

  • odirection string

    Returns a requested order direction. [asc, desc]

  • api_version integer

    Returns a requested api version. [1, 2]

  • remaining_daily_api_requests integer

    Returns the remaining number of api requests.

JSON Response Object

Webhooks

Webhooks allow your application to receive real-time updates about certain events in our system. Once a webhook is registered, we’ll send a POST request to the provided URL whenever the specified events occur. The Webhooks API offers one endpoint to retrieve a list of Webhooks with it's events.
In case you use 1 webhook url for all events then only one webhook will be listed.

Endpoints

Webhook Events

All webhook events will be listed in this section. A common feature across all events is the data parameter within the response object. This parameter returns data in the same format as the corresponding API endpoint. For instance, when a recipe is updated, the data parameter will contain the same structure as the response from calling /api/v2/get/recipe/{id}.

recipe.add

Triggered when a new recipe is created.

JSON Response
  • event_type string

    Returns the event type: recipe.add.

  • unique_id integer

    Returns the recipe unique ID.

  • data array

    Recipe details are listed here.
    This parameter is exactly same as the data parameter returned by /api/v2/get/recipe/{id}.

  • timestamp string

    Returns the current timestamp in YYYY-MM-DD HH:MM format.

JSON Response Object

recipe.change

Triggered when a recipe is updated.

JSON Response
  • event_type string

    Returns the event type: recipe.change.

  • recipe_uid integer

    Returns the recipe ID typicaly found in your recipes URL.

  • unique_id integer

    Returns the recipe unique ID.

  • changed_data array

    All Recipe changes will be listed here.

  • data array

    Recipe details are listed here.
    This parameter is exactly same as the data parameter returned by /api/v2/get/recipe/{id}.

  • timestamp string

    Returns the current timestamp in YYYY-MM-DD HH:MM format.

JSON Response Object

recipe.convert_to_production

Triggered when a recipe is converted to production.

JSON Response
  • event_type string

    Returns the event type: recipe.convert_to_production.

  • recipe_uid integer

    Returns the recipe ID typicaly found in your recipes URL.

  • unique_id integer

    Returns the recipe unique ID.

  • recipe_production_unique_id integer

    Returns the recipe production ID.

  • recipe_name string

    Returns the recipe name.

  • recipe_version string

    Returns the recipe version number.

  • recipe_version_uid string

    Returns the recipe version unique ID.

  • recipe_version_name string

    Returns the recipe version name only if the default name was changed.

    • data array

    Recipe details are listed here.
    This parameter is exactly same as the data parameter returned by /api/v2/get/recipe/{id}.

  • timestamp string

    Returns the current timestamp in YYYY-MM-DD HH:MM format.

JSON Response Object

recipe.revert_to_rnd

Triggered when a recipe is reverted back to R&D status from production status.

JSON Response
  • event_type string

    Returns the event type: recipe.revert_to_rnd.

  • recipe_uid integer

    Returns the recipe ID typicaly found in your recipes URL.

  • unique_id integer

    Returns the recipe unique ID.

  • recipe_name string required

    Recipe Name.

  • data array

    Recipe details are listed here.
    This parameter is exactly same as the data parameter returned by /api/v2/get/recipe/{id}.

  • timestamp string

    Returns the current timestamp in YYYY-MM-DD HH:MM format.

JSON Response Object

recipe.archive

Triggered when a recipe is archived.

JSON Response
  • event_type string

    Returns the event type: recipe.archive.

  • recipe_uid integer

    Returns the recipe ID typicaly found in your recipes URL.

  • unique_id integer

    Returns the recipe unique ID.

  • recipe_name string required

    Recipe Name.

  • timestamp string

    Returns the current timestamp in YYYY-MM-DD HH:MM format.

JSON Response Object

recipe.unarchive

Triggered when a recipe is restored from an archived state.

JSON Response
  • event_type string

    Returns the event type: recipe.unarchive.

  • recipe_uid integer

    Returns the recipe ID typicaly found in your recipes URL.

  • unique_id integer

    Returns the recipe unique ID.

  • recipe_name string required

    Recipe Name.

  • data array

    Recipe details are listed here.
    This parameter is exactly same as the data parameter returned by /api/v2/get/recipe/{id}.

  • timestamp string

    Returns the current timestamp in YYYY-MM-DD HH:MM format.

JSON Response Object

recipe.delete

Triggered when a recipe is permanently deleted.

JSON Response
  • event_type string

    Returns the event type: recipe.delete.

  • recipe_uid integer

    Returns the recipe ID typicaly found in your recipes URL.

  • unique_id integer

    Returns the recipe unique ID.

  • recipe_name string required

    Recipe Name.

  • timestamp string

    Returns the current timestamp in YYYY-MM-DD HH:MM format.

JSON Response Object

ingredient.add

Triggered when a new ingredient is created.

JSON Response
  • event_type string

    Returns the event type: ingredient.add.

  • data array

    Ingredient details are listed here.
    This parameter is exactly same as the data parameter returned by /api/v2/get/ingredient/{id}.

  • timestamp string

    Returns the current timestamp in YYYY-MM-DD HH:MM format.

JSON Response Object

ingredient.change

Triggered when a ingredient is updated.

JSON Response
  • event_type string

    Returns the event type: ingredient.change.

  • data array

    Ingredient details are listed here.
    This parameter is exactly same as the data parameter returned by /api/v2/get/ingredient/{id}.

  • timestamp string

    Returns the current timestamp in YYYY-MM-DD HH:MM format.

JSON Response Object

ingredient.delete

Triggered when a ingredient is permanently deleted.

JSON Response
  • event_type string

    Returns the event type: ingredient.delete.

  • ingredient_id string

    Returns the deleted ingredient_id.

  • timestamp string

    Returns the current timestamp in YYYY-MM-DD HH:MM format.

JSON Response Object

List all Webhooks

Retrieves the webhook urls used in your organization.

HTTP Request

GEThttps://app.flavorstudio.com/api/v2/get/admin/webhooks
JSON Response
  • section string

    Returns a requested section: webhooks.

  • webhooks array

    Available webhooks are listed here.

  • webhooks_total integer

    Returns of total number of webhooks based on filters.

  • page integer

    Returns a requested page.

  • step integer

    Returns a requested step.

  • filter string

    Returns a requested filter keyword.

  • datefilter string

    Returns a requested date. Returns empty value or date in YYYY-MM-DD format.

  • order string

    Returns a requested order field. Default: webhook_url

  • odirection string

    Returns a requested order direction. [asc, desc]

  • api_version integer

    Returns a requested api version. [1, 2]

JSON Response Object

Errors

If an error exists, Flavor Studio’s API returns JSON with error codes and a message. If there is no Basic Auth username or password it will redirect the request to the Flavor Studio login page. In any other error cases it will return JSON data with the following details.

JSON Response
Status Code Error Code Error Message Description
400 Bad Request invalid_type
invalid_file_download_request
invalid_email

invalid_section
invalid_crm_section
invalid_organization_section
empty_data 		Invalid type.
Invalid file download request.
Invalid email address.
Email address required.
Invalid section.
Invalid or empty CRM section.
Invalid or empty ORGANIZATION section.
Ingredient data not found! 		Type is not defined in the url or invalid type defined.
File download request url is invalid.
This error code represents invalid or empty email address.

Section is not defined in the url or invalid section name is defined.
This error code represents invalid or missing CRM section.
This error code represents invalid or missing ORGANIZATION section.
This error occurs when the data can't be found.
401 Unauthorized unauthorized
invalid_api_key 		Authentication required.
Invalid API key. 		The API requires authentication. Authenticate yourself with HTTP Basic Auth.
This code represents invalid API keys or that the API is disabled.
404 Not Found invalid_file

invalid_user
invalid_id



 Invalid file.
We couldn't locate the requested file.
Invalid user.
Project not found!
Recipe not found!
Ingredient not found!
Taste Test not found!
CRM "section name" not found! 		Invalid file or file does not exist.
We couldn't locate the requested file. Ensure the file name and path are correct.
This error occurs when the user can't be found in the organization.
This error occurs when the data can't be found within the organization based on the ID and section.
426 Upgrade Required https_required HTTPS is required. Please use HTTPS to access this API. Request is made over plain HTTP. Secure connections are mandatory for accessing the API.
429 Too Many Requests daily_request_limit_exceeded Daily API request limit exceeded. Please try again tomorrow. Number of API requests exceeds the daily limit set for your account.

Have you encountered any issues or errors?

Error