Rotate a Signing Room Link

POST 
/agreements/:agreement_id/signing_room_links/:signing_room_link_id/rotate

Replaces a Signing Room Link with a new one. The old link stops working and every session opened with it ends. No email is sent; deliver the returned URL to the participant yourself. Rotating a link issued to an API client older than 3.7.0 upgrades it to a link with normal expiry.

Request

Path Parameters

agreement_id cuidrequired

POST /agreements/:agreement_id/signing_room_links/:signing_room_link_id/rotate parameter

signing_room_link_id cuidrequired

POST /agreements/:agreement_id/signing_room_links/:signing_room_link_id/rotate parameter

application/json

Body

POST /agreements/:agreement_id/signing_room_links/:signing_room_link_id/rotate request body

any

Responses

200

POST /agreements/:agreement_id/signing_room_links/:signing_room_link_id/rotate Successful response

application/json

Schema

Schema

version stringrequired

Possible values: [1.0]

The version of the response schema

result_type stringrequired

Possible values: [single]

A single object of the signing_room_link resource.

resource_type stringrequired

Possible values: [signing_room_link]

Data contains the signing_room_link resource.

data objectrequired

The resource data.

id cuidrequired

The unique identifier of the Signing Room Link

resource_type stringrequired

Possible values: [signing_room_link]

agreement_id cuidrequired

The unique identifier of the agreement the link opens

url urlrequired

The full signing room URL. It is a bearer credential: anyone with it can open the signing room for this participant.

status stringrequired

Possible values: [active, expired, revoked]

Whether the link still grants access to the signing room. An expired link can be rotated; a revoked link cannot.

expires_at stringrequired

When the link stops granting access to the signing room

created_at stringrequired

UTC datetime ISO string

updated_at stringrequired

UTC datetime ISO string

Example (from schema)

{
  "version": "1.0",
  "result_type": "single",
  "resource_type": "signing_room_link",
  "data": {
    "id": "cfbsvexzrxdiutehsi7example",
    "resource_type": "signing_room_link",
    "agreement_id": "cgqyyxtdopufdtcsdxpexample",
    "url": "https://www.zigned.se/sign/ckvxkvifauwbv5d8pzbexample/cctxaqdk9q6b3m3knnpexample",
    "status": "active",
    "expires_at": "2024-01-01T00:00:00.000Z",
    "created_at": "2024-01-01T00:00:00.000Z",
    "updated_at": "2024-01-01T00:00:00.000Z"
  }
}

400

POST /agreements/:agreement_id/signing_room_links/:signing_room_link_id/rotate Error response

application/json

Schema

Schema

status stringrequired

Possible values: [error]

error objectrequired
type stringrequired
Possible values: [input_validation_error, bad_request, authorization_error, forbidden_error, not_found_error, conflict_error, internal_server_error]
input_validation_error (400): the request input is invalid. bad_request (400): the request cannot be processed. authorization_error (401): the access token is missing or invalid. forbidden_error (403): the client is not allowed to perform the request. not_found_error (404): the resource does not exist. conflict_error (409): a concurrent change made the request invalid, e.g. the agreement stopped being editable while the request was processed. Re-fetch the resource before retrying. internal_server_error (500): an unexpected error occurred.
code int64required
Possible values: >= 400 and <= 599
message stringrequired
request_id uuidrequired

Example (from schema)

{
  "status": "error",
  "error": {
    "type": "input_validation_error",
    "code": 0,
    "message": "string",
    "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Loading...