Skip to content

Create a product share invite token

Request

Creates a new user product share. Invoking this method will reduce the number of shares that the user has available for the given product. The returned token sharing ID can later be passed to the accept invite method. Custom metadata can also be passed to this method, which will be made available in later calls to access the publicly available share data. This metadata can be used, for example, to include the product owner's first name and a personalised message that is shown to the recipient in a screen that allows the recipient to accept the invite. Invoking this method will reduce the number of shares that the user has available for the given product. The specified product must be shareable, the current user must have active grants for the product and must not have already exceeded the configured maximum number of shares for the product.

Security
CookieBlaizeSession or JwtQuery or JwtHeaderXBlaizeJwt or JwtHeaderXZephrJwt or JwtBearer or JwtCookie
Bodyapplication/json
product_idstringrequired

The ID of the product that is being shared.

Example:"product-1"
meta_dataobject

Extra information for the user product share.

{ "product_id": "product-1" }

Responses

OK

Headers
any
Bodyapplication/json
sharing_idstringrequired

The ID of the created product share.

Example:"0nasdj-aso25-6454"
Response
{ "sharing_id": "0nasdj-aso25-6454" }