Cosmily logo
API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification

Topics

  • Introduction
  • Authentication

Endpoints

  • Analyze
    • POST /analyze/ingredient_list
    • GET /analyze/ingredient_groups
    • GET /analyze/ingredient_group
    • PATCH /analyze/claim/:token
    • GET /analyze/shared/:token
    • GET /analyze/:token/ingredient_feelings
    • GET /analyze/:token/categorize
    • GET /analyze/:token/missing_ingredients
    • GET /analyze/:token/personalize
    • GET /analyze/:token/skin_calc
    • GET /analyze/:token/rules
    • GET /analyze/:token/similar_products
    • POST /analyze/effects
    • POST /analyze/extract_label
  • Articles
    • GET /articles
    • GET /articles/:id_or_alias
  • Brands
    • GET /brands
    • GET /brands/:id_or_alias
    • PATCH /brands/:id_or_alias
    • GET /brands/:id_or_alias/products
    • PATCH /brands/:id_or_alias/transfer_ownership
  • Breadcrumbs
    • GET /breadcrumbs/product_category/:id_or_alias
    • GET /breadcrumbs/product/:id_or_alias
  • Buy
    • GET /buy/:id_or_alias/amzn
    • GET /buy/:id_or_alias
  • Census
    • GET /census/countries
  • Compare
    • POST /compare/expand
    • POST /compare/share
    • GET /compare/shared/:token
  • Contests
    • GET /contests/most_liked_routine/leaderboard/previous_week
    • GET /contests/most_liked_routine/leaderboard
    • GET /contests/most_liked_routine/leaderboard/:week_number
    • GET /contests/current_week
    • GET /contests/previous_week
    • GET /contests/:week_number
  • Facets
    • GET /facets
    • GET /facets/:id
    • PATCH /facets/update/:id
    • POST /facets/create
  • Featured
    • GET /featured
  • Following
    • GET /following/ingredient_feelings/negative
    • GET /following/ingredient_feelings/positive
  • Ingredient feelings
    • GET /ingredient_feelings/:id
  • Ingredient matchers
    • GET /:token/suggested_category
    • POST /:token
  • Ingredient opinions
    • GET /ingredient_opinions/:opinion_uuid/current
    • GET /ingredient_opinions/:opinion_uuid/history
    • GET /ingredient_opinions/entry/:entry_uuid
    • GET /ingredient_opinions/hashtag/:hashtag
    • POST /ingredient_opinions/create
    • DELETE /ingredient_opinions/:opinion_uuid
    • PATCH /ingredient_opinions/:opinion_uuid
  • Ingredients
    • GET /ingredients
    • GET /ingredients/:id_or_alias
    • GET /ingredients/:id_or_alias/products
    • GET /ingredients/:id_or_alias/endorsed_opinions
    • GET /ingredients/:id_or_alias/featured_opinion
    • PUT /ingredients/:id_or_alias/feeling/positive
    • PUT /ingredients/:id_or_alias/feeling/negative
    • DELETE /ingredients/:id_or_alias/feeling
    • POST /ingredients/:id_or_alias/submit_feedback
    • POST /ingredients/create
  • My
    • GET /my/ingredient_analyses
    • GET /my/user
    • PATCH /my/user/supergroups
    • GET /my/favorite_products
    • GET /my/favorite_routines
    • GET /my/followed_by
    • GET /my/following
    • GET /my/ingredient_feelings
    • GET /my/ingredient_feelings/negative
    • GET /my/ingredient_feelings/positive
    • GET /my/ingredient_feelings/:ingredient_id_or_alias
    • GET /my/ingredient_opinions
    • GET /my/ingredient_opinions/:ingredient_id_or_alias
    • GET /my/ingredient_feedback
    • GET /my/ingredient_feedback/:ingredient_id_or_alias
    • GET /my/product_drafts/authored
    • GET /my/product_drafts/reviewed
    • GET /my/products
    • GET /my/product_pitches
    • GET /my/product_tutorials
    • GET /my/contests/current_week
    • GET /my/contests/previous_week
    • GET /my/routines
    • GET /my/current_routine_ids
    • GET /my/routine_requests
    • GET /my/compatibility/product/:id_or_alias
    • GET /my/intake_decision
    • PATCH /my/survey/active/intake_decision
    • GET /my/survey/answered
    • GET /my/survey/unanswered
    • POST /my/survey_answers
    • POST /my/survey_answers/reset
  • Product categories
    • GET /product_categories
    • GET /product_categories/:id_or_alias
    • GET /product_categories/:id_or_alias/best_in
    • GET /product_categories/:id_or_alias/products
  • Product drafts
    • POST /product_drafts/approve
    • GET /product_drafts
    • GET /product_drafts/:id
    • DELETE /product_drafts/:id
    • PATCH /product_drafts/:id/product_image
    • POST /product_drafts/auto_classify
    • POST /product_drafts/create
    • POST /product_drafts/update
  • Product pitches
    • POST /product_pitches/create
    • PATCH /product_pitches/:id/assign_affiliate
    • PATCH /product_pitches/:id/add_ingredient_opinion
    • PATCH /product_pitches/:id/remove_ingredient_opinion
    • GET /product_pitches/:id/ingredient_opinions
  • Product tutorials
    • GET /product_tutorials
    • POST /product_tutorials/create
    • GET /product_tutorials/:id
    • GET /product_tutorials/:id/product_tutorial_instructions
    • POST /product_tutorials/:id/product_tutorial_instructions/create
    • DELETE /product_tutorials/:id/product_tutorial_instructions/:instruction_id
    • GET /product_tutorials/:id/product_tutorial_warnings
    • POST /product_tutorials/:id/product_tutorial_warnings/create
    • DELETE /product_tutorials/:id/product_tutorial_warnings/:warning_id
    • PATCH /product_tutorials/:id/publish
    • PATCH /product_tutorials/:id/set_general_info
    • PATCH /product_tutorials/:id/set_media_url
    • PATCH /product_tutorials/:id/set_quantity
  • Products
    • GET /products
    • POST /products/create
    • GET /products/favorite_lookup
    • GET /products/recent
    • POST /products/search
    • GET /products/lookup
    • GET /products/:id_or_alias
    • DELETE /products/:id_or_alias/product_image
    • PATCH /products/:id_or_alias/product_image
    • GET /products/:id_or_alias/analysis
    • GET /products/:id_or_alias/effects
    • GET /products/:id_or_alias/similar
    • GET /products/:id_or_alias/top_routines
    • GET /products/:id_or_alias/top_users
    • POST /products/:id_or_alias/favorite
    • DELETE /products/:id_or_alias/favorite
    • GET /routines/:id/favorited_by
    • GET /products/:id_or_alias/routine_candidates
    • GET /products/:id_or_alias/product_tutorials
    • GET /products/:id_or_alias/product_tutorials/featured
    • PATCH /products/:id_or_alias/publish
    • PATCH /products/:id_or_alias/attest_brand
    • DELETE /products/:id
  • Routines
    • GET /routines
    • POST /routines/create
    • POST /routines/request
    • DELETE /routines/request/:id
    • GET /products/favorite_lookup
    • GET /routines/:id
    • DELETE /routines/:id
    • GET /routines/:id/compatibility
    • GET /routines/:id/analyze/:token/compatibility
    • POST /routines/:id/favorite
    • DELETE /routines/:id/favorite
    • GET /routines/:id/favorited_by
    • PATCH /routines/:id/publish
    • PATCH /routines/:id/update
    • PATCH /routines/:id/update_routine_step_order
    • PATCH /routines/:id/add_routine_step
    • GET /routines/:id/product_pitches
    • GET /routines/:id/detailed_summary
    • GET /routines/:id/routine_steps
    • PATCH /routines/:id/routine_steps/:routine_step_id/assign_pitch
    • PATCH /routines/:id/routine_steps/:routine_step_id/assign_product
    • PATCH /routines/:id/routine_steps/:routine_step_id/assign_product_tutorial
  • Rownd
    • POST /rownd
  • Sitemap
    • GET /sitemap/comparisons
    • GET /sitemap/ingredients
    • GET /sitemap/products
  • Stats
    • POST /stats/analyze/created_per_day
    • POST /stats/ingredient_opinions/created_per_day
    • POST /stats/product_buy_clicks/created_per_day
    • POST /stats/product_tutorials/created_per_day
    • POST /stats/products/created_per_day
    • POST /stats/routines/created_per_day
    • POST /stats/users/created_per_day
  • Unit of measurements
    • GET /unit_of_measurements
    • POST /unit_of_measurements/create
    • GET /unit_of_measurements/:id
  • User relationships
    • GET /user_relationships/lookup
  • Users
    • GET /users
    • GET /users/:id_or_username
    • GET /user/:id_or_username/favorite_products
    • GET /user/:id_or_username/favorite_routines
    • GET /users/:id_or_username/ingredient_feelings
    • GET /users/:id_or_username/ingredient_feelings/:ingredient_id_or_alias
    • GET /users/:id_or_username/ingredient_opinions
    • GET /users/:id_or_username/product_tutorials
    • GET /users/:id_or_username/routines
    • PATCH /users/:id/identity/email
    • PATCH /users/:id/identity/confirm_email_change
    • PATCH /users/:id/identity/username
    • GET /users/:id/skin_profile/survey
    • GET /users/:id/skin_profile/unanswered
    • GET /users/experts
    • GET /users/lookup
    • GET /users/:id/brands
    • POST /users/:id/follow
    • GET /users/:id/followed_by
    • GET /users/:id/following
    • DELETE /users/:id/unfollow
    • PATCH /users/:id/profile
    • DELETE /users/:id/profile_picture
    • PATCH /users/:id/profile_picture
    • PATCH /users/:id/skin_profile
    • GET /users/:id/resend_verification_email
    • PATCH /users/:id/user_type
    • POST /users/send_invite_link
Powered by Bump.sh

POST /users/send_invite_link

POST /users/send_invite_link

Creates a user and sends account information to email

Body Required

  • email string Required

Responses

  • 200

    successful operation

    Hide response attribute Show response attribute object
    • data object
      Hide data attributes Show data attributes object
      • id integer
      • auth0_id string
      • username string
      • email string
      • user_type string
      • followed_by_count integer
      • following_count integer
      • supergroups array[string]
      • last_active string
      • followed_by_me boolean
  • 400

    Bad Request

  • 401

    Authorization information is missing or invalid.

  • 422

    Unprocessable Entity

  • 500

    Server Error

POST /users/send_invite_link
curl \
 -X POST https://api.cosmily.com/api/v1/users/send_invite_link \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"email":"joe@cosmily.com"}'
Request example
{
  "email": "joe@cosmily.com"
}
Request examples
{
  "email": "joe@cosmily.com"
}
Response examples (200)
{
  "data": {
    "id": 42,
    "auth0_id": "string",
    "username": "string",
    "email": "string",
    "user_type": "string",
    "followed_by_count": 42,
    "following_count": 42,
    "supergroups": [
      "string"
    ],
    "last_active": "string",
    "followed_by_me": true
  }
}
Response examples (200)
{
  "data": {
    "id": 42,
    "auth0_id": "string",
    "username": "string",
    "email": "string",
    "user_type": "string",
    "followed_by_count": 42,
    "following_count": 42,
    "supergroups": [
      "string"
    ],
    "last_active": "string",
    "followed_by_me": true
  }
}