Bundles

Withdraw a bundle

Takes an OPEN bundle back to DRAFT so you can change it and send it again. Every document returns to DRAFT and stays in the bundle, and every signature is cleared, so everyone signs again after the next send. Each document fires document.withdrawn.

A bundle with a document that is already completed returns 409 INVALID_STATE. To stop a bundle for good, cancel it with POST /api/v1/bundles/{id}/cancel.

Permission required: WITHDRAW_DOCUMENT on the workspace, and access to every document in the bundle.

POST

api

bundles

{id}

withdraw

Withdraw a bundle

curl --request POST \
  --url https://app.sajn.se/api/v1/bundles/{id}/withdraw \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Fel startdatum i avtalet."
}
'

import requests

url = "https://app.sajn.se/api/v1/bundles/{id}/withdraw"

payload = { "reason": "Fel startdatum i avtalet." }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'Fel startdatum i avtalet.'})
};

fetch('https://app.sajn.se/api/v1/bundles/{id}/withdraw', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sajn.se/api/v1/bundles/{id}/withdraw",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => 'Fel startdatum i avtalet.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sajn.se/api/v1/bundles/{id}/withdraw"

	payload := strings.NewReader("{\n  \"reason\": \"Fel startdatum i avtalet.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.sajn.se/api/v1/bundles/{id}/withdraw")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Fel startdatum i avtalet.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sajn.se/api/v1/bundles/{id}/withdraw")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"Fel startdatum i avtalet.\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "cm4k2x9p10044abcd1234efgh",
  "name": "Anställningspaket – 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": [
    "[email protected]"
  ],
  "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": "DRAFT",
      "parties": [
        {
          "id": "cm4k2x9p10004abcd1234efgh",
          "bundlePartyId": "cm4k2x9p10004abcd1234efgh",
          "name": "Kai Lindqvist",
          "email": "[email protected]",
          "role": "SIGNER",
          "signingStatus": "NOT_SIGNED",
          "signedAt": null
        }
      ]
    }
  ],
  "parties": [
    {
      "id": "cm4k2x9p10004abcd1234efgh",
      "name": "Kai Lindqvist",
      "email": "[email protected]",
      "phone": "+46701740605",
      "role": "SIGNER",
      "signingOrder": 1,
      "delivery": [
        "EMAIL"
      ],
      "signatureMethod": "SE_BANKID",
      "signVerification": "PIN",
      "openVerification": "PIN",
      "status": "PENDING",
      "documentIds": [
        "cm4k2x9p10003abcd1234efgh"
      ]
    }
  ]
}

{
  "code": "VALIDATION_FAILED",
  "message": "Invalid input: expected string, received number",
  "userMessage": "Förfrågan innehåller ogiltiga värden.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2",
  "issues": [
    {
      "path": "reason",
      "code": "INVALID_TYPE",
      "message": "Invalid input: expected string, received number"
    }
  ]
}

{
  "code": "UNAUTHORIZED",
  "message": "Invalid API token",
  "userMessage": "Ogiltig API-nyckel",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "Insufficient OAuth scope: requires documents:write",
  "userMessage": "Applikationen saknar behörighet (scope) för denna åtgärd.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2",
  "requiredScopes": [
    "documents:write"
  ],
  "grantedScopes": [
    "profile:read"
  ]
}

{
  "code": "NOT_FOUND",
  "message": "Bundle not found",
  "userMessage": "Resursen hittades inte.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2",
  "resource": "bundle"
}

{
  "code": "INVALID_STATE",
  "message": "The resource's current state doesn't allow the operation, such as editing a document that was already sent or downloading a file that isn't produced yet.",
  "userMessage": "Åtgärden är inte möjlig i resursens nuvarande status.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "RATE_LIMITED",
  "message": "API rate limit exceeded",
  "userMessage": "För många förfrågningar. Försök igen om en stund.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error",
  "userMessage": "Något gick fel.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "UPSTREAM_UNAVAILABLE",
  "message": "A service the operation depends on, such as an eID provider or a connected integration, failed or is unavailable. Retry with exponential backoff.",
  "userMessage": "En extern tjänst svarar inte just nu. Försök igen om en stund.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

Authorizations

Authorization

string

header

required

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

Headers

Sajn-Version

enum<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.

Available options:

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.

Maximum string length: 255

Path Parameters

string

required

The bundle ID.

Body

application/json

Body

reason

string

Why the bundle is withdrawn, included in the email to the parties.

Maximum string length: 1000

Response

200

string

required

The bundle ID.

name

string | null

required

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

status

enum<string>

required

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.

Available options:

DRAFT,

OPEN,

COMPLETED,

CANCELED

subject

string | null

required

The subject line of the invitation email.

message

string | null

required

A message included in every invitation.

expiresAt

string<date-time> | null

required

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

signingMode

enum<string>

required

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.

Available options:

PARALLEL,

SEQUENTIAL

language

enum<string>

required

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

Available options:

sv,

en,

no,

da,

fi,

de,

is,

es,

fr,

it

reminderIntervalDays

integer | null

required

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

Required range: -9007199254740991 <= x <= 9007199254740991

signableAfterExpired

boolean

required

Whether the documents can still be signed after expiresAt.

internalRecipients

string[]

required

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

nationalIdDisplayMode

enum<string> | null

required

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

Available options:

FULL,

PARTIAL,

NONE,

null

openVerification

enum<string> | null

required

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.

Available options:

PIN,

SMS,

EMAIL,

SE_BANKID,

NO_BANKID_BIOMETRIC,

NO_BANKID_HIGH,

DK_MITID,

DK_MITID_ERHVERV,

FI_FTN,

NL_IDIN,

null

sendPlainTextEmailOnly

boolean | null

required

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

redirectUrl

string | null

required

URL to send a party to once they have signed.

redirectEnabled

boolean

required

Whether redirectUrl is used.

documentCount

integer

required

The number of documents in documents.

Required range: -9007199254740991 <= x <= 9007199254740991

createdAt

string<date-time>

required

When the bundle was created.

updatedAt

string<date-time>

required

When the bundle was last updated.

documents

object[]

required

The documents in the bundle, oldest first.

Show child attributes

parties

object[]

required

The bundle's parties, in signing order.

Show child attributes

Withdraw a bundle

curl --request POST \
  --url https://app.sajn.se/api/v1/bundles/{id}/withdraw \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Fel startdatum i avtalet."
}
'

import requests

url = "https://app.sajn.se/api/v1/bundles/{id}/withdraw"

payload = { "reason": "Fel startdatum i avtalet." }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'Fel startdatum i avtalet.'})
};

fetch('https://app.sajn.se/api/v1/bundles/{id}/withdraw', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.sajn.se/api/v1/bundles/{id}/withdraw",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => 'Fel startdatum i avtalet.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.sajn.se/api/v1/bundles/{id}/withdraw"

	payload := strings.NewReader("{\n  \"reason\": \"Fel startdatum i avtalet.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.sajn.se/api/v1/bundles/{id}/withdraw")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Fel startdatum i avtalet.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.sajn.se/api/v1/bundles/{id}/withdraw")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"reason\": \"Fel startdatum i avtalet.\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "cm4k2x9p10044abcd1234efgh",
  "name": "Anställningspaket – 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": [
    "[email protected]"
  ],
  "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": "DRAFT",
      "parties": [
        {
          "id": "cm4k2x9p10004abcd1234efgh",
          "bundlePartyId": "cm4k2x9p10004abcd1234efgh",
          "name": "Kai Lindqvist",
          "email": "[email protected]",
          "role": "SIGNER",
          "signingStatus": "NOT_SIGNED",
          "signedAt": null
        }
      ]
    }
  ],
  "parties": [
    {
      "id": "cm4k2x9p10004abcd1234efgh",
      "name": "Kai Lindqvist",
      "email": "[email protected]",
      "phone": "+46701740605",
      "role": "SIGNER",
      "signingOrder": 1,
      "delivery": [
        "EMAIL"
      ],
      "signatureMethod": "SE_BANKID",
      "signVerification": "PIN",
      "openVerification": "PIN",
      "status": "PENDING",
      "documentIds": [
        "cm4k2x9p10003abcd1234efgh"
      ]
    }
  ]
}

{
  "code": "VALIDATION_FAILED",
  "message": "Invalid input: expected string, received number",
  "userMessage": "Förfrågan innehåller ogiltiga värden.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2",
  "issues": [
    {
      "path": "reason",
      "code": "INVALID_TYPE",
      "message": "Invalid input: expected string, received number"
    }
  ]
}

{
  "code": "UNAUTHORIZED",
  "message": "Invalid API token",
  "userMessage": "Ogiltig API-nyckel",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "Insufficient OAuth scope: requires documents:write",
  "userMessage": "Applikationen saknar behörighet (scope) för denna åtgärd.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2",
  "requiredScopes": [
    "documents:write"
  ],
  "grantedScopes": [
    "profile:read"
  ]
}

{
  "code": "NOT_FOUND",
  "message": "Bundle not found",
  "userMessage": "Resursen hittades inte.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2",
  "resource": "bundle"
}

{
  "code": "INVALID_STATE",
  "message": "The resource's current state doesn't allow the operation, such as editing a document that was already sent or downloading a file that isn't produced yet.",
  "userMessage": "Åtgärden är inte möjlig i resursens nuvarande status.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "RATE_LIMITED",
  "message": "API rate limit exceeded",
  "userMessage": "För många förfrågningar. Försök igen om en stund.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error",
  "userMessage": "Något gick fel.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

{
  "code": "UPSTREAM_UNAVAILABLE",
  "message": "A service the operation depends on, such as an eID provider or a connected integration, failed or is unavailable. Retry with exponential backoff.",
  "userMessage": "En extern tjänst svarar inte just nu. Försök igen om en stund.",
  "requestId": "req_V1StGXR8Z5jdHi6BmyT2"
}

Get started

Core concepts

Guides

Webhooks

API fundamentals

Upgrading

sajn Login

API reference

Withdraw a bundle

Authorizations

Headers

Path Parameters

Body

Response