Response Data Fields

Field	Description
`person_id` (string)	The unique identifier of the customer.
`code` (string)	The short, alpha-numeric share code assigned to the customer and content being shared. This becomes the slug of the share link.
`label` (string)	The program label for targeting purposes (e.g., refer-a-friend).
`link` (string)	The full share link.
`key` (string)	A shareable key. This is useful when requesting a share link. If the customer makes a request for a key, where they already have a link, the same link is returned.
`content` (object)	The content associated with this share link for content sharing purposes.
`data` (object)	A map of custom data associated with the share link.

Error Responses

Error Code	Message
400 Code Taken By Promotion	The code associated with this shareable is already used by a promotion link.
400 Invalid Program	The program is invalid.
400 Program Domain Not Found	The program domain was not found.
400 Unknown Program	The provided program URL is not associated with an existing program.
403 Access Denied	The access token provided is not permitted to access the specified resource.
403 Code Illegal Character	The code can only contain alphanumeric characters, dashes, and underscores.
403 Code Out Of Range	The code length must be between 4 and 50 characters.
403 Code Taken	The code associated with this shareable has already been specified.
403 Content Description Length Exceeded	The content description exceeded the maximum character length.
403 Content Image Invalid	The image URL provided is invalid.
402 Content URL Blocked	The content URL provided is blocked.
403 Content URL Invalid	The content URL provided is invalid.
403 Data Attribute Name Invalid	A shareable data attribute name is invalid.
403 Data Attribute Name Length Out Of Range	A shareable data attribute name length exceeds 200 characters.
403 Data Attribute Value Invalid	A shareable data value is invalid
403 Data Attribute Value Length Out Of Range	A shareable data attribute value length exceeds 2,000 characters.
403 Key Taken	The key associated with this shareable has already been specified.
403 Label Is Missing	The label is missing from this request.
403 Label Name Contains Illegal Character	The label name can only contain alphanumeric characters, dashes, and underscores.
403 Label Name Length Out Of Range	The label name length must be between 2 and 50 characters.
403 Missing Access Token	No access token was provided with this request.
403 Person Not Found	The person associated with the person ID provided was not found.
403 Person Not Rewardable	The person does not have an email address.
403 Shareable Not Found	The shareable associated with the code provided was not found.

200200

400400