Skip to Content
Bundles

Cancel a bundle

POST
/api/v1/bundles/{id}/cancel

Cancels a sent bundle and withdraws every document in it that isn't signed yet. Withdrawn documents return to DRAFT and leave the bundle, and each fires document.withdrawn. Documents that are already signed stay signed and stay in the bundle.

Returns the bundle. Its status is CANCELED when every unsigned document was withdrawn, and the bundle fires bundle.cancelled. If a document can't be withdrawn, the bundle stays OPEN and that document stays in documents with its current status. A bundle that is a DRAFT or already canceled returns 409 INVALID_STATE.

Permission required: WITHDRAW_DOCUMENT on the workspace.

Authorization

headerAuthorizationBearer <token>

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Path Parameters

id*string

The bundle ID.

Header Parameters

Sajn-Version?string

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Value in"2026-09""2026-10"
Sajn-Workspace?string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Idempotency-Key?string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Lengthlength <= 255

Request Body

Body

application/json
  1. body

Response Body

200

application/json
  1. response
id*string

The bundle ID.

name*|

The bundle name, shown as the heading of the bundle page and in the invitation.

status*string

DRAFT while you build it, and again after a withdraw. OPEN from the send until every document is resolved, then COMPLETED. CANCELED after a cancel.

Value in"DRAFT""OPEN""COMPLETED""CANCELED"
subject*|

The subject line of the invitation email.

message*|

A message included in every invitation.

expiresAt*|

The expiry date of the bundle. Every document in it gets the same one.

Formatdate-time
signingMode*string

How the parties sign: PARALLEL, all at once, or SEQUENTIAL, one at a time in the order of each party's signingOrder. The order runs across every document in the bundle.

Value in"PARALLEL""SEQUENTIAL"
language*string

Language of the bundle page and the emails to the parties, an ISO 639-1 code such as sv.

Value in"sv""en""no""da""fi""de""is""es""fr""it"
reminderIntervalDays*|

Days between automatic reminders. 0 turns them off, and null uses the default of 3.

Range-9007199254740991 <= value <= 9007199254740991
signableAfterExpired*boolean

Whether the documents can still be signed after expiresAt.

internalRecipients*array<string>

Email addresses that receive a copy of each sealed PDF once its document is completed.

nationalIdDisplayMode*|

How national identity numbers are displayed to signers: FULL, PARTIAL, or NONE. null keeps each document's own setting.

Value in"FULL""PARTIAL""NONE"null
openVerification*|

Verification every party passes before the document opens: PIN, SMS, EMAIL, or an eID such as SE_BANKID. null means none. A party's own openVerification overrides it.

Value in"PIN""SMS""EMAIL""SE_BANKID""NO_BANKID_BIOMETRIC""NO_BANKID_HIGH""DK_MITID""DK_MITID_ERHVERV""FI_FTN""NL_IDIN"null
sendPlainTextEmailOnly*|

Send plain text invitations only, without HTML. null inherits the workspace default.

redirectUrl*|

URL to send a party to once they have signed.

redirectEnabled*boolean

Whether redirectUrl is used.

documentCount*integer

The number of documents in documents.

Range-9007199254740991 <= value <= 9007199254740991
createdAt*string

When the bundle was created.

Formatdate-time
updatedAt*string

When the bundle was last updated.

Formatdate-time
documents*array<>

The documents in the bundle, oldest first.

parties*array<>

The bundle's parties, in signing order.

Example Request
curl -X POST 'https://app.sajn.se/api/v1/bundles/cm4k2x9p10044abcd1234efgh/cancel' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "cm4k2x9p10044abcd1234efgh",  "name": "Kai Lindqvist",  "status": "DRAFT",  "subject": "Ditt anställningsavtal från Exempelbolaget AB",  "message": "Hej Kai! Här är ditt anställningsavtal. Signera det med BankID senast den 28 oktober.",  "expiresAt": "2026-10-28T22:00:00.000Z",  "signingMode": "PARALLEL",  "language": "sv",  "reminderIntervalDays": 3,  "signableAfterExpired": false,  "internalRecipients": [    "hr@example.com"  ],  "nationalIdDisplayMode": "FULL",  "openVerification": "PIN",  "sendPlainTextEmailOnly": false,  "redirectUrl": null,  "redirectEnabled": true,  "documentCount": 1,  "createdAt": "2026-09-28T09:12:00.000Z",  "updatedAt": "2026-09-28T09:15:00.000Z",  "documents": [    {      "id": "cm4k2x9p10003abcd1234efgh",      "name": "Anställningsavtal – Kai Lindqvist",      "status": "COMPLETED",      "parties": [        {          "id": "cm4k2x9p10004abcd1234efgh",          "bundlePartyId": "cm4k2x9p10004abcd1234efgh",          "name": "Kai Lindqvist",          "email": "kai@example.com",          "role": "SIGNER",          "signingStatus": "SIGNED",          "signedAt": "2026-09-29T07:41:00.000Z"        }      ]    }  ],  "parties": [    {      "id": "cm4k2x9p10004abcd1234efgh",      "name": "Kai Lindqvist",      "email": "kai@example.com",      "phone": "+46701740605",      "role": "SIGNER",      "signingOrder": 1,      "delivery": [        "EMAIL"      ],      "signatureMethod": "SE_BANKID",      "signVerification": "PIN",      "openVerification": "PIN",      "status": "PENDING",      "documentIds": [        "cm4k2x9p10003abcd1234efgh"      ]    }  ]}

Was this page helpful?