Share links
A read-only page that shows your client how their launch is going, in your agency's name and colors. It lists live directories with links, the ones still in progress and the latest reports, and shows no prices.
Each project has at most one active link. Creating a new link turns the old URL off.
Returns the project's active link with its view count. A project without an active link returns 404.
project_id*stringThe project's id.
^prj_[0-9A-Za-z]{22}$The active link.
application/json- response
A read-only progress page for your client.
object*stringAlways share_link.
livemode*booleanAlways true: a share link exists for live projects only.
project*stringThe project's id.
^prj_[0-9A-Za-z]{22}$url*stringThe page to send to your client. It works without a login until it expires or you turn it off.
uricreated_at*stringWhen the link was created.
date-timeexpires_at*|When the link stops working. null when it does not expire.
date-timerevoked_at*|When you turned the link off. null while it works.
date-timelast_viewed_at*|When someone last opened the page, to within a minute. null before the first view.
date-timeview_count*integerHow many times the page was opened. Opens less than a minute apart count once.
0 <= valueTypical errors
curl "https://api.submitator.com/v1/projects/prj_4QzX1m9Lr2Vb7Nc8Tk3HwP/share_link" \ -H "Authorization: Bearer $SUBMITATOR_API_KEY"{ "object": "share_link", "livemode": true, "project": "prj_4QzX1m9Lr2Vb7Nc8Tk3HwP", "url": "https://example.net/r/6Tq2Wm9Kx4Lr8Vb3Nz7HcP", "created_at": "2026-10-08T15:20:00Z", "expires_at": null, "revoked_at": null, "last_viewed_at": "2026-10-08T18:42:10Z", "view_count": 3}Creates a read-only progress page for the project that you can send to your client. It shows your agency's name and colors. A project has 1 active link: creating a new one turns the previous URL off.
project_id*stringThe project's id.
^prj_[0-9A-Za-z]{22}$application/json- body
The link to create. An empty body creates a link that does not expire.
expires_at?|When the link should stop working. Leave it out or send null for a link that works until you turn it off.
date-timeThe new link.
application/json- response
A read-only progress page for your client.
object*stringAlways share_link.
livemode*booleanAlways true: a share link exists for live projects only.
project*stringThe project's id.
^prj_[0-9A-Za-z]{22}$url*stringThe page to send to your client. It works without a login until it expires or you turn it off.
uricreated_at*stringWhen the link was created.
date-timeexpires_at*|When the link stops working. null when it does not expire.
date-timerevoked_at*|When you turned the link off. null while it works.
date-timelast_viewed_at*|When someone last opened the page, to within a minute. null before the first view.
date-timeview_count*integerHow many times the page was opened. Opens less than a minute apart count once.
0 <= valueTypical errors
curl -X POST "https://api.submitator.com/v1/projects/prj_4QzX1m9Lr2Vb7Nc8Tk3HwP/share_link" \ -H "Authorization: Bearer $SUBMITATOR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"expires_at":null}'{ "object": "share_link", "livemode": true, "project": "prj_4QzX1m9Lr2Vb7Nc8Tk3HwP", "url": "https://example.net/r/6Tq2Wm9Kx4Lr8Vb3Nz7HcP", "created_at": "2026-10-08T15:20:00Z", "expires_at": null, "revoked_at": null, "last_viewed_at": null, "view_count": 0}Turns the active link off at once; its URL then returns 404 to anyone who opens it. Create a new link to share the page again.
project_id*stringThe project's id.
^prj_[0-9A-Za-z]{22}$The link, now turned off.
application/json- response
A read-only progress page for your client.
object*stringAlways share_link.
livemode*booleanAlways true: a share link exists for live projects only.
project*stringThe project's id.
^prj_[0-9A-Za-z]{22}$url*stringThe page to send to your client. It works without a login until it expires or you turn it off.
uricreated_at*stringWhen the link was created.
date-timeexpires_at*|When the link stops working. null when it does not expire.
date-timerevoked_at*|When you turned the link off. null while it works.
date-timelast_viewed_at*|When someone last opened the page, to within a minute. null before the first view.
date-timeview_count*integerHow many times the page was opened. Opens less than a minute apart count once.
0 <= valueTypical errors
curl -X DELETE "https://api.submitator.com/v1/projects/prj_4QzX1m9Lr2Vb7Nc8Tk3HwP/share_link" \ -H "Authorization: Bearer $SUBMITATOR_API_KEY"{ "object": "share_link", "livemode": true, "project": "prj_4QzX1m9Lr2Vb7Nc8Tk3HwP", "url": "https://example.net/r/6Tq2Wm9Kx4Lr8Vb3Nz7HcP", "created_at": "2026-10-08T15:20:00Z", "expires_at": null, "revoked_at": "2026-10-09T09:00:00Z", "last_viewed_at": "2026-10-08T18:42:10Z", "view_count": 3}