Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Create a client share link

Creates a share link for a Client with an optional label and expiry.

POST https://app.upfour.io/v1/clients/{clientID}/share-links
POST https://app.upfour.io/v1/clients/{clientID}/share-links

A real request. Sending it changes data in your up4 account.

Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs client.write.
Path
Body
More fields2
Headers

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope client.write stable Idempotency-Key supported returns 201

Parameters

FieldTypeDescription
clientID required uuid path parameter

Body

application/json required 2 fields

All other fields2 fields
expires_atstring (date-time) · nullable

Defaults to 90 days from now.

labelstring

A name for the link, e.g. who it went to.

Returns

A successful request returns 201 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data CreateShareLinkResult
CreateShareLinkResult · 9 fields
FieldTypeDescription
client_id uuid
created_at string (date-time)
id uuid
label string
token string The link token. Only this answer carries it; copy it now.
created_by uuid
expires_at string (date-time)
last_used_at string (date-time) When someone last opened the link.
revoked_at string (date-time) Set once the link is revoked.

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
400 bad_request The request is malformed or fails validation.
404 not_found The requested resource does not exist or is outside the caller's scope.
403 permission_denied The credentials do not permit this action.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.