Skip to content
Public API reference
/
v4 API
/
/
Retrieve the product shar...

Retrieve the product share invite public data

Request

Retrieves the publicly accessible data relating to a user product share invite. This can be used to inform the invitee of the details of the product that is being shared, and any meta_data added at the point of invite creation, such as the name of the user that sent the invite. This endpoint is not authenticated. The information provided by this endpoint is available to anyone with a valid sharing_id. Invoking this endpoint too rapidly will result in a 429 error response.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Path
sharing_idstringrequired

The ID of the user product sharing invite.

Example:0nasdj-aso25-6454
cURL
curl -i -X GET \
  https://demo-site/zephr/public/products/v1/shares/invitations/0nasdj-aso25-6454 \
  -b blaize_session=YOUR_API_KEY_HERE

Responses

OK

Headers
any
Bodyapplication/json
product_idstring

The ID of the product that is shared.

Example:"product-1"
product_labelstring

The label of the product that is shared.

Example:"Gold Product"
meta_dataobject

Extra information for the user product share, defined at the point of creation.

Response
{
  "product_id": "product-1",
  "product_label": "Gold Product",
  "meta_data": {}
}