Build with the Pactlyra API
Get a test key without an account or card, then make your first request in under five minutes.
The sandbox sends no messages, uses no credits, and marks completed PDFs TEST.
curl --fail-with-body -sS -X POST \
-H "Content-Type: application/json" \
--data '{"label":"quickstart"}' \
https://api.pactlyra.com/v1/sandbox/keys
The response returns key once. Save it in PACTLYRA_API_KEY; Pactlyra stores only its hash.
Authentication
Send Authorization: Bearer $PACTLYRA_API_KEY. Keys beginning pk_test_ are sandbox-only; keep every key server-side and rotate it immediately if exposed.
curl --fail-with-body -sS -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/usage
Errors
Errors are JSON with a stable error, a human-readable message, and a requestId. Branch on the code, show the message, and retain the request ID.
{
"error": "invalid_input",
"message": "request body is not valid JSON",
"requestId": "req_a1b2c3d4e5f6"
}
invalid_input— HTTP 400authentication_required— HTTP 401invalid_session— HTTP 401spend_limit_reached— HTTP 402payment_required— HTTP 402forbidden— HTTP 403insufficient_assurance— HTTP 403not_found— HTTP 404method_not_allowed— HTTP 405payload_too_large— HTTP 413invalid_transition— HTTP 409already_acted— HTTP 409not_your_turn— HTTP 409immutable_version— HTTP 409last_credential— HTTP 409not_sendable— HTTP 422invalid_field_value— HTTP 422required_fields_incomplete— HTTP 422too_many— HTTP 422rate_limited— HTTP 429too_many_resends— HTTP 429trial_expired_read_only— HTTP 403request_refused— HTTP 400internal_error— HTTP 500
Webhooks
Create a receiver with POST /v1/webhooks. Verify the signature against the unmodified request bytes before parsing JSON, answer with a 2xx status, and make processing idempotent because delivery is retried.
Rate limits
A limited request returns HTTP 429, error: rate_limited, and a Retry-After header in seconds. Wait that long; repeated immediate retries extend recovery time.
Every shipped endpoint
This list, openapi.json, and the Postman collection are generated from the route declarations and checked against the runtime router.
POST /v1/ai/assist
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/ai/assist
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/ai/assist', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/ai/assist',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/ai/providers
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/ai/providers
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/ai/providers', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/ai/providers',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/billing
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/billing
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/billing', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/billing',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
PUT /v1/billing
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X PUT -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/billing
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/billing', {
method: 'PUT',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.put(
'https://api.pactlyra.com/v1/billing',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/billing/addons/ai
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/billing/addons/ai
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/billing/addons/ai', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/billing/addons/ai',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/billing/catalogue
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/billing/catalogue
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/billing/catalogue', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/billing/catalogue',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/billing/credits
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/billing/credits
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/billing/credits', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/billing/credits',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/billing/portal
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/billing/portal
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/billing/portal', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/billing/portal',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/billing/subscribe
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/billing/subscribe
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/billing/subscribe', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/billing/subscribe',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/documents
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/documents
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/documents', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/documents',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/documents
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{"name":"agreement.pdf"}' https://api.pactlyra.com/v1/documents
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/documents', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"name": "agreement.pdf"
})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/documents',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={"name":"agreement.pdf"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/documents/:id/versions
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{"content":"JVBERi0xLjcK"}' https://api.pactlyra.com/v1/documents/env_123/versions
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/documents/env_123/versions', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"content": "JVBERi0xLjcK"
})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/documents/env_123/versions',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={"content":"JVBERi0xLjcK"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/embed/receipts/:code
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/embed/receipts/receipt_code
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/embed/receipts/receipt_code', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/embed/receipts/receipt_code',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/envelopes
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/envelopes
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/envelopes',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/envelopes
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{"routing":"sequential"}' https://api.pactlyra.com/v1/envelopes
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"routing": "sequential"
})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/envelopes',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={"routing":"sequential"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/envelopes/:id
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/envelopes/env_123
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/envelopes/env_123',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/envelopes/:id/cost
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/envelopes/env_123/cost
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/cost', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/envelopes/env_123/cost',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/envelopes/:id/document
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/envelopes/env_123/document
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/document', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/envelopes/env_123/document',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/envelopes/:id/documents
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{"documentId":"doc_123","versionId":"ver_123"}' https://api.pactlyra.com/v1/envelopes/env_123/documents
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/documents', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"documentId": "doc_123",
"versionId": "ver_123"
})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/envelopes/env_123/documents',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={"documentId":"doc_123","versionId":"ver_123"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/envelopes/:id/events
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/envelopes/env_123/events
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/events', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/envelopes/env_123/events',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/envelopes/:id/evidence
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/envelopes/env_123/evidence
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/evidence', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/envelopes/env_123/evidence',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/envelopes/:id/fields
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{"type":"signature","recipientId":"rec_123","documentVersionId":"ver_123","page":1,"rect":{"x":72,"y":480,"width":200,"height":28}}' https://api.pactlyra.com/v1/envelopes/env_123/fields
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/fields', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"type": "signature",
"recipientId": "rec_123",
"documentVersionId": "ver_123",
"page": 1,
"rect": {
"x": 72,
"y": 480,
"width": 200,
"height": 28
}
})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/envelopes/env_123/fields',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={"type":"signature","recipientId":"rec_123","documentVersionId":"ver_123","page":1,"rect":{"x":72,"y":480,"width":200,"height":28}},
timeout=30,
)
response.raise_for_status()
print(response.json())
DELETE /v1/envelopes/:id/fields/:fieldId
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X DELETE -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/envelopes/env_123/fields/fld_123
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/fields/fld_123', {
method: 'DELETE',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.delete(
'https://api.pactlyra.com/v1/envelopes/env_123/fields/fld_123',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
DELETE /v1/envelopes/:id/payment
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X DELETE -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/envelopes/env_123/payment
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/payment', {
method: 'DELETE',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.delete(
'https://api.pactlyra.com/v1/envelopes/env_123/payment',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
PUT /v1/envelopes/:id/payment
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X PUT -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/payment
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/payment', {
method: 'PUT',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.put(
'https://api.pactlyra.com/v1/envelopes/env_123/payment',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/envelopes/:id/prepare
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/prepare
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/prepare', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/envelopes/env_123/prepare',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/envelopes/:id/recipients
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{"email":"[email protected]","role":"signer","authLevel":"basic"}' https://api.pactlyra.com/v1/envelopes/env_123/recipients
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/recipients', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"email": "[email protected]",
"role": "signer",
"authLevel": "basic"
})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/envelopes/env_123/recipients',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={"email":"[email protected]","role":"signer","authLevel":"basic"},
timeout=30,
)
response.raise_for_status()
print(response.json())
DELETE /v1/envelopes/:id/recipients/:recipientId/condition
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X DELETE -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/condition
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/condition', {
method: 'DELETE',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.delete(
'https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/condition',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
PUT /v1/envelopes/:id/recipients/:recipientId/condition
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X PUT -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/condition
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/condition', {
method: 'PUT',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.put(
'https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/condition',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/envelopes/:id/recipients/:recipientId/copy
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/copy
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/copy', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/copy',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/envelopes/:id/recipients/:recipientId/embed
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/embed
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/embed', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/embed',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/envelopes/:id/recipients/:recipientId/resend
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/resend
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/resend', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/resend',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
PUT /v1/envelopes/:id/reminders
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X PUT -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/reminders
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/reminders', {
method: 'PUT',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.put(
'https://api.pactlyra.com/v1/envelopes/env_123/reminders',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/envelopes/:id/send
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/send
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/send', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/envelopes/env_123/send',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/envelopes/:id/void
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/void
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/void', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/envelopes/env_123/void',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/forms
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/forms
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/forms', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/forms',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/forms
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/forms
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/forms', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/forms',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
DELETE /v1/forms/:id
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X DELETE -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/forms/env_123
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/forms/env_123', {
method: 'DELETE',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.delete(
'https://api.pactlyra.com/v1/forms/env_123',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/forms/:id
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/forms/env_123
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/forms/env_123', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/forms/env_123',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
PUT /v1/forms/:id
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X PUT -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/forms/env_123
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/forms/env_123', {
method: 'PUT',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.put(
'https://api.pactlyra.com/v1/forms/env_123',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/health
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/health
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/health', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/health',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/keys
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/keys
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/keys', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/keys',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/keys
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/keys
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/keys', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/keys',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
DELETE /v1/keys/:id
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X DELETE -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/keys/env_123
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/keys/env_123', {
method: 'DELETE',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.delete(
'https://api.pactlyra.com/v1/keys/env_123',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/pay/:token
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET https://api.pactlyra.com/v1/pay/link_token
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/pay/link_token', {
method: 'GET',
headers: {}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/pay/link_token',
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/pay/:token/checkout
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/pay/link_token/checkout
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/pay/link_token/checkout', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/pay/link_token/checkout',
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
DELETE /v1/payment-account
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X DELETE -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/payment-account
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/payment-account', {
method: 'DELETE',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.delete(
'https://api.pactlyra.com/v1/payment-account',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/payment-account
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/payment-account
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/payment-account', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/payment-account',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
PUT /v1/payment-account
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X PUT -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/payment-account
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/payment-account', {
method: 'PUT',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.put(
'https://api.pactlyra.com/v1/payment-account',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/sandbox
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/sandbox
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/sandbox', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/sandbox',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/sandbox
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{"name":"Test workspace"}' https://api.pactlyra.com/v1/sandbox
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/sandbox', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"name": "Test workspace"
})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/sandbox',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={"name":"Test workspace"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/sandbox/keys
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Content-Type: application/json" --data '{"label":"quickstart"}' https://api.pactlyra.com/v1/sandbox/keys
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/sandbox/keys', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({
"label": "quickstart"
})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/sandbox/keys',
json={"label":"quickstart"},
timeout=30,
)
response.raise_for_status()
print(response.json())
DELETE /v1/sandbox/messages
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X DELETE -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/sandbox/messages
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/sandbox/messages', {
method: 'DELETE',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.delete(
'https://api.pactlyra.com/v1/sandbox/messages',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/sandbox/messages
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/sandbox/messages
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/sandbox/messages', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/sandbox/messages',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/sign/:token
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET https://api.pactlyra.com/v1/sign/link_token
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/sign/link_token', {
method: 'GET',
headers: {}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/sign/link_token',
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/sign/:token/challenge
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/sign/link_token/challenge
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/sign/link_token/challenge', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/sign/link_token/challenge',
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/sign/:token/complete
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/sign/link_token/complete
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/sign/link_token/complete', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/sign/link_token/complete',
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/sign/:token/consent
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/sign/link_token/consent
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/sign/link_token/consent', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/sign/link_token/consent',
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/sign/:token/decline
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/sign/link_token/decline
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/sign/link_token/decline', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/sign/link_token/decline',
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/sign/:token/fields/:fieldId
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/sign/link_token/fields/fld_123
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/sign/link_token/fields/fld_123', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/sign/link_token/fields/fld_123',
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/sign/:token/verify
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/sign/link_token/verify
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/sign/link_token/verify', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/sign/link_token/verify',
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/sign/:token/view
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/sign/link_token/view
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/sign/link_token/view', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/sign/link_token/view',
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
DELETE /v1/storage
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X DELETE -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/storage
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/storage', {
method: 'DELETE',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.delete(
'https://api.pactlyra.com/v1/storage',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/storage
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/storage
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/storage', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/storage',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
PUT /v1/storage
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X PUT -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/storage
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/storage', {
method: 'PUT',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.put(
'https://api.pactlyra.com/v1/storage',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/suppressions
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/suppressions
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/suppressions', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/suppressions',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
DELETE /v1/suppressions/:email
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X DELETE -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/suppressions/[email protected]
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/suppressions/[email protected]', {
method: 'DELETE',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.delete(
'https://api.pactlyra.com/v1/suppressions/[email protected]',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/templates
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/templates
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/templates', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/templates',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/templates
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/templates
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/templates', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/templates',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
DELETE /v1/templates/:id
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X DELETE -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/templates/env_123
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/templates/env_123', {
method: 'DELETE',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.delete(
'https://api.pactlyra.com/v1/templates/env_123',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/templates/:id
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/templates/env_123
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/templates/env_123', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/templates/env_123',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
PUT /v1/templates/:id
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X PUT -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/templates/env_123
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/templates/env_123', {
method: 'PUT',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.put(
'https://api.pactlyra.com/v1/templates/env_123',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/templates/:id/envelopes
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/templates/env_123/envelopes
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/templates/env_123/envelopes', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/templates/env_123/envelopes',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
PUT /v1/templates/:id/roles/:key
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X PUT -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/templates/env_123/roles/key_value
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/templates/env_123/roles/key_value', {
method: 'PUT',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.put(
'https://api.pactlyra.com/v1/templates/env_123/roles/key_value',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/tickets
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/tickets
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/tickets', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/tickets',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/tickets
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/tickets
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/tickets', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/tickets',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/usage
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/usage
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/usage', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/usage',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
PUT /v1/usage/limit
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X PUT -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/usage/limit
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/usage/limit', {
method: 'PUT',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.put(
'https://api.pactlyra.com/v1/usage/limit',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/webhooks
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/webhooks
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/webhooks', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/webhooks',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/webhooks
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{"url":"https://example.com/pactlyra","events":["envelope.completed"]}' https://api.pactlyra.com/v1/webhooks
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/webhooks', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"url": "https://example.com/pactlyra",
"events": [
"envelope.completed"
]
})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/webhooks',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={"url":"https://example.com/pactlyra","events":["envelope.completed"]},
timeout=30,
)
response.raise_for_status()
print(response.json())
DELETE /v1/webhooks/:id
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X DELETE -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/webhooks/env_123
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/webhooks/env_123', {
method: 'DELETE',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.delete(
'https://api.pactlyra.com/v1/webhooks/env_123',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/webhooks/:id/enable
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/webhooks/env_123/enable
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/webhooks/env_123/enable', {
method: 'POST',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/webhooks/env_123/enable',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/webhooks/mail/:provider
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/webhooks/mail/postmark
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/webhooks/mail/postmark', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/webhooks/mail/postmark',
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/webhooks/payments/:workspaceId
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/webhooks/payments/ws_123
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/webhooks/payments/ws_123', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/webhooks/payments/ws_123',
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
POST /v1/webhooks/stripe
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X POST -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/webhooks/stripe
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/webhooks/stripe', {
method: 'POST',
headers: {
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.post(
'https://api.pactlyra.com/v1/webhooks/stripe',
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
GET /v1/workspace/embedding
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X GET -H "Authorization: Bearer $PACTLYRA_API_KEY" https://api.pactlyra.com/v1/workspace/embedding
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/workspace/embedding', {
method: 'GET',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`
}
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.get(
'https://api.pactlyra.com/v1/workspace/embedding',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
timeout=30,
)
response.raise_for_status()
print(response.json())
PUT /v1/workspace/embedding
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X PUT -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/workspace/embedding
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/workspace/embedding', {
method: 'PUT',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.put(
'https://api.pactlyra.com/v1/workspace/embedding',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())
PUT /v1/workspace/notifications
Call this shipped endpoint with the path values shown below.
curl
curl --fail-with-body -sS -X PUT -H "Authorization: Bearer $PACTLYRA_API_KEY" -H "Content-Type: application/json" --data '{}' https://api.pactlyra.com/v1/workspace/notifications
Node.js 22+
const response = await fetch('https://api.pactlyra.com/v1/workspace/notifications', {
method: 'PUT',
headers: {
"Authorization": `Bearer ${process.env.PACTLYRA_API_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({})
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());
Python 3 + requests
import os, requests
response = requests.put(
'https://api.pactlyra.com/v1/workspace/notifications',
headers={'Authorization': f"Bearer {os.environ['PACTLYRA_API_KEY']}"},
json={},
timeout=30,
)
response.raise_for_status()
print(response.json())