Give a share link a new address
const url = 'https://api.pixonaut.app/v1/share-links/example/regenerate';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.pixonaut.app/v1/share-links/example/regenerate \ --header 'Authorization: Bearer <token>'Operation ID: shareLinks.regenerate
Replaces a working link’s token: the old address opens nothing from then on, and the link keeps its id, kind, subject, settings, expiry, history and design count. Answers with the new token, which is never shown again. For a link whose address was lost: a designer link keeps its address, which the list answers as url, and is refused address_kept, unless it was made before addresses were kept, when it is given one. A withdrawn or expired link, or one the caller could not have handed out (to a connected store’s integration key, one its store did not hand out), is answered as not found.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”The link with its new token
object
The brand the link’s page is drawn in; null for the workspace’s default, whichever that is when it opens.
How many designs a designer link may make; null for none.
object
How many designs the link may make in its period.
total counts every design the link made; hour, day and week the last 60 minutes, 24 hours or 7 days, rolling.
When the link stops working; null for one that never does.
The language the link’s page is shown in, which its url names as ?lang=<locale>; null when it names none, and the page is shown in the workspace’s default language.
The workspace’s name for the link.
Whether a designer link’s page draws the placement frame around the shopper’s picture at rest; false for every other link.
Whether a designer link’s page draws the print area’s frame; false for every other link.
The link’s token. Shown in this response only.
The hosted page the link opens, with ?lang=<locale> when the link names a locale.
Examples
Example
{ "brandId": null, "createdAt": 1760000000000, "designLimit": null, "expiresAt": 1761209600000, "id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d", "kind": "proof-page", "locale": null, "mayDecide": true, "name": "Proof for Anna", "placementFrame": false, "printAreaFrame": false, "returnUrl": null, "subjectId": "c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f", "token": "EXAMPLE_share_link_token_not_a_real_one_001", "url": "https://app.pixonaut.example/h/proof/EXAMPLE_share_link_token_not_a_real_one_001"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: unauthorized
object
Examples
unauthorized
{ "error": "unauthorized"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: origin_forbidden, feature_disabled
object
The feature the tenant does not have. Always sent with feature_disabled.
Examples
feature_disabled
{ "error": "feature_disabled", "feature": "api"}origin_forbidden
{ "error": "origin_forbidden"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: not_found
object
Examples
not_found
{ "error": "not_found"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: address_kept
object
Examples
address_kept
{ "error": "address_kept"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: payload_too_large
object
Always sent with payload_too_large.
Examples
payload_too_large
{ "error": "payload_too_large", "maxBytes": 0}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Refused: db_error. A request that failed unexpectedly answers as text instead.
object
Examples
db_error
{ "error": "db_error"}Headers
Section titled “Headers”Every response names the request it answers in X-Request-Id: the id the request was sent with in that header, when it is well formed, else one the API gave it. Quote it when reporting a refusal or a failure: the API’s log lines for that request carry it.
Questions? Write to [email protected].