{ "item": [ { "name": "v1", "description": "", "item": [ { "name": "templates", "description": "", "item": [ { "id": "2d04ced1-26e2-495d-95d7-caa68df49435", "name": "List templates (partner)", "request": { "name": "List templates (partner)", "description": { "content": "Returns all templates for the authenticated tenant ordered by last\nupdate descending. Requires the `templates:read` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by template status. Valid values: `draft`, `published`, `archived`.\n (This can only be one of draft,published,archived)", "type": "text/plain" }, "key": "status", "value": "published" }, { "disabled": false, "description": { "content": "Return only templates whose `created_at` is at or after this ISO 8601\ntimestamp.\n", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Return only templates whose `created_at` is strictly before this ISO 8601\ntimestamp.\n", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of results to return (1–100). Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2b8b85c0-6e6f-49bb-a452-2b537349afe7", "name": "Template list", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by template status. Valid values: `draft`, `published`, `archived`.\n (This can only be one of draft,published,archived)", "type": "text/plain" }, "key": "status", "value": "published" }, { "disabled": false, "description": { "content": "Return only templates whose `created_at` is at or after this ISO 8601\ntimestamp.\n", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Return only templates whose `created_at` is strictly before this ISO 8601\ntimestamp.\n", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of results to return (1–100). Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"published\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"category\": \"\",\n \"current_version\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"archived\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"description\": \"\",\n \"category\": \"\",\n \"current_version\": \"\"\n }\n ],\n \"total\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f62e513-c380-4d78-aaab-c33042a643de", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by template status. Valid values: `draft`, `published`, `archived`.\n (This can only be one of draft,published,archived)", "type": "text/plain" }, "key": "status", "value": "published" }, { "disabled": false, "description": { "content": "Return only templates whose `created_at` is at or after this ISO 8601\ntimestamp.\n", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Return only templates whose `created_at` is strictly before this ISO 8601\ntimestamp.\n", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of results to return (1–100). Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f103485a-2747-497c-ae68-08ddde549b27", "name": "Forbidden (missing scope or IP not allowed)", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by template status. Valid values: `draft`, `published`, `archived`.\n (This can only be one of draft,published,archived)", "type": "text/plain" }, "key": "status", "value": "published" }, { "disabled": false, "description": { "content": "Return only templates whose `created_at` is at or after this ISO 8601\ntimestamp.\n", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Return only templates whose `created_at` is strictly before this ISO 8601\ntimestamp.\n", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of results to return (1–100). Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66154a68-ad73-405d-8247-ebe6ddf822fc", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by template status. Valid values: `draft`, `published`, `archived`.\n (This can only be one of draft,published,archived)", "type": "text/plain" }, "key": "status", "value": "published" }, { "disabled": false, "description": { "content": "Return only templates whose `created_at` is at or after this ISO 8601\ntimestamp.\n", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Return only templates whose `created_at` is strictly before this ISO 8601\ntimestamp.\n", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of results to return (1–100). Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0aa79540-9245-407b-8b38-f8512cc15032", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by template status. Valid values: `draft`, `published`, `archived`.\n (This can only be one of draft,published,archived)", "type": "text/plain" }, "key": "status", "value": "published" }, { "disabled": false, "description": { "content": "Return only templates whose `created_at` is at or after this ISO 8601\ntimestamp.\n", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Return only templates whose `created_at` is strictly before this ISO 8601\ntimestamp.\n", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of results to return (1–100). Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3cebc74b-c463-4188-9079-067b175a88fc", "name": "Create template (partner)", "request": { "name": "Create template (partner)", "description": { "content": "Create a new template with optional inline variable and signer-role\ndefinitions. Use `POST /v1/templates/upload-url` first to get a\npresigned PUT URL for the PDF; supply the returned `object_path` as\n`document_url` here.\n\nRequires the `templates:write` scope and an `Idempotency-Key` header.\n", "type": "text/plain" }, "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"document_url\": \"\",\n \"description\": \"\",\n \"category\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n },\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n }\n ],\n \"recipients\": [\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n },\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "af13d10c-7e3e-4c9f-840d-7ca9de382b6f", "name": "Template created", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"document_url\": \"\",\n \"description\": \"\",\n \"category\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n },\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n }\n ],\n \"recipients\": [\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n },\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"created_at\": \"\",\n \"fields\": [\n {\n \"id\": \"\",\n \"kind\": \"date\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"variable_name\": \"\"\n },\n {\n \"id\": \"\",\n \"kind\": \"date\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"variable_name\": \"\"\n }\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"signer_role_manifest\": [\n {\n \"id\": \"\",\n \"role_name\": \"\",\n \"role_type\": \"cc\",\n \"signing_order\": \"\",\n \"required\": \"\"\n },\n {\n \"id\": \"\",\n \"role_name\": \"\",\n \"role_type\": \"signer\",\n \"signing_order\": \"\",\n \"required\": \"\"\n }\n ],\n \"status\": \"archived\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\",\n \"variable_manifest\": [\n {\n \"name\": \"\",\n \"type\": \"currency\",\n \"required\": \"\",\n \"overflow_behavior\": \"reject\",\n \"render_hint\": \"inline\",\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"number\",\n \"required\": \"\",\n \"overflow_behavior\": \"truncate\",\n \"render_hint\": \"inline\",\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\"\n }\n ],\n \"description\": \"\",\n \"category\": \"\",\n \"current_version\": \"\",\n \"document_url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "627ce277-4626-4e72-baf8-0a4baba9f759", "name": "Missing Idempotency-Key", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"document_url\": \"\",\n \"description\": \"\",\n \"category\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n },\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n }\n ],\n \"recipients\": [\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n },\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f290a726-d566-4635-b999-9313054b5ef8", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"document_url\": \"\",\n \"description\": \"\",\n \"category\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n },\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n }\n ],\n \"recipients\": [\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n },\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa7ae5cb-8529-4892-9849-e1745a3a2f07", "name": "Forbidden (missing scope or IP not allowed)", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"document_url\": \"\",\n \"description\": \"\",\n \"category\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n },\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n }\n ],\n \"recipients\": [\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n },\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "020cb30a-7c58-4bd5-a0b0-e899128eef82", "name": "Idempotency conflict (same key, different body)", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"document_url\": \"\",\n \"description\": \"\",\n \"category\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n },\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n }\n ],\n \"recipients\": [\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n },\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "41f315ef-2dda-4398-9a20-4ea8c406c19d", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"document_url\": \"\",\n \"description\": \"\",\n \"category\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n },\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n }\n ],\n \"recipients\": [\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n },\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "336bb843-22cb-4544-9ddd-a4e814d1ecf4", "name": "A previous request carrying the **same** `Idempotency-Key` is still\nbeing processed. This is a transient condition — the first request has\nnot yet produced a stored response to replay. Wait briefly and retry\nwith the same key; you will then receive the original request's result\n(never a duplicate side effect). Applies only to write operations that\naccept an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"document_url\": \"\",\n \"description\": \"\",\n \"category\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n },\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n }\n ],\n \"recipients\": [\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n },\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unordered Collection (RFC 3648)", "code": 425, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5d8576b-efe6-4a64-9015-5b662b89e890", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"document_url\": \"\",\n \"description\": \"\",\n \"category\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n },\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n }\n ],\n \"recipients\": [\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n },\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4f7def3b-28b1-4e85-beb3-79aeee4708cf", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "templates" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"document_url\": \"\",\n \"description\": \"\",\n \"category\": \"\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"variables\": [\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n },\n {\n \"name\": \"\",\n \"type\": \"string\",\n \"required\": false,\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\",\n \"overflow_behavior\": \"shrink\",\n \"render_hint\": \"inline\"\n }\n ],\n \"recipients\": [\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n },\n {\n \"role_name\": \"\",\n \"signing_order\": \"\",\n \"role_type\": \"signer\",\n \"required\": true\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "upload-url", "description": "", "item": [ { "id": "76f88979-e44d-4319-9a8d-37100ae009ff", "name": "Get presigned PDF upload URL (partner)", "request": { "name": "Get presigned PDF upload URL (partner)", "description": { "content": "Returns a short-lived (15-minute) presigned PUT URL for uploading a\ntemplate PDF directly to object storage. After the upload succeeds,\npass the returned `object_path` as `document_url` in\n`POST /v1/templates`.\n\nThis endpoint is stateless — no `Idempotency-Key` is needed.\nRequires the `templates:write` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "templates", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "791bbccc-4910-4721-a470-25bb2e3b8094", "name": "Presigned upload URL", "originalRequest": { "url": { "path": [ "v1", "templates", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"upload_url\": \"\",\n \"object_path\": \"\",\n \"expires_in_seconds\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "093d5ba9-3c85-4dd0-9dbe-77f788b6c9cf", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "templates", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2c15ba9e-47cf-4902-8e4c-1429d01cb159", "name": "Forbidden (missing scope or IP not allowed)", "originalRequest": { "url": { "path": [ "v1", "templates", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1371e51d-0298-46f8-af4b-37c2a2af12a4", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "templates", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1416c56e-76ee-4ff0-acd5-b4fe7050dda0", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "templates", "upload-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "{id}", "description": "", "item": [ { "id": "6326038d-7dc0-4168-b9bb-b12a379f3d47", "name": "Get template (partner)", "request": { "name": "Get template (partner)", "description": { "content": "Retrieve a single template with its full variable manifest and\nsigner-role manifest so partners know exactly what to supply when\ncreating envelopes from it. Requires the `templates:read` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a564b812-e00c-4ff2-8d11-b7aae4b820f1", "name": "Template detail", "originalRequest": { "url": { "path": [ "v1", "templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"created_at\": \"\",\n \"fields\": [\n {\n \"id\": \"\",\n \"kind\": \"date\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"variable_name\": \"\"\n },\n {\n \"id\": \"\",\n \"kind\": \"date\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"variable_name\": \"\"\n }\n ],\n \"id\": \"\",\n \"name\": \"\",\n \"signer_role_manifest\": [\n {\n \"id\": \"\",\n \"role_name\": \"\",\n \"role_type\": \"cc\",\n \"signing_order\": \"\",\n \"required\": \"\"\n },\n {\n \"id\": \"\",\n \"role_name\": \"\",\n \"role_type\": \"signer\",\n \"signing_order\": \"\",\n \"required\": \"\"\n }\n ],\n \"status\": \"archived\",\n \"tags\": [\n \"\",\n \"\"\n ],\n \"updated_at\": \"\",\n \"variable_manifest\": [\n {\n \"name\": \"\",\n \"type\": \"currency\",\n \"required\": \"\",\n \"overflow_behavior\": \"reject\",\n \"render_hint\": \"inline\",\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\"\n },\n {\n \"name\": \"\",\n \"type\": \"number\",\n \"required\": \"\",\n \"overflow_behavior\": \"truncate\",\n \"render_hint\": \"inline\",\n \"description\": \"\",\n \"default_value\": \"\",\n \"max_length\": \"\"\n }\n ],\n \"description\": \"\",\n \"category\": \"\",\n \"current_version\": \"\",\n \"document_url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "603d3958-7003-4d9d-b6ca-13f14df9ad3c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8ca8bae5-3d4a-4be0-b2e8-251358047ca7", "name": "Forbidden (missing scope or IP not allowed)", "originalRequest": { "url": { "path": [ "v1", "templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "23a8f3f1-f921-4222-bc36-f45cc917cca6", "name": "Template not found", "originalRequest": { "url": { "path": [ "v1", "templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5907482d-05ed-4f1b-a0b6-00e1dc64cb3f", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "84e80e38-7b8c-4736-835b-0aad46944fae", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "templates", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "fields", "description": "", "item": [ { "id": "a4cbe50d-d2b6-47de-9df5-5a832e7793a8", "name": "List template fields (partner)", "request": { "name": "List template fields (partner)", "description": { "content": "Return all signing fields placed on this template, across all pages\nand recipient roles. Requires the `templates:read` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c1fcaee5-63b5-4eda-b2fc-37f024285964", "name": "Field list", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"kind\": \"date\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"variable_name\": \"\"\n },\n {\n \"id\": \"\",\n \"kind\": \"text\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"variable_name\": \"\"\n }\n ],\n \"total\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5ddf75c9-b35a-4463-a545-95e261147717", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "538f50b2-53b8-414d-8072-a0af0cfa43a8", "name": "Authenticated but not allowed (not a platform admin / wrong service token).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f8f850c6-ae29-4475-a9b1-10b0d9077e58", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa1e27cb-553f-4791-b844-166688ef2bfc", "name": "Rate limit exceeded. The caller has sent too many requests in the\ncurrent window. Slow down and retry after the duration indicated by\nthe `Retry-After` response header (value in seconds).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ecddb4a5-2458-4fe2-8525-2b25503c4f5a", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2695e6fd-df13-4a8f-a680-7587cb63dd85", "name": "Replace all template fields (partner)", "request": { "name": "Replace all template fields (partner)", "description": { "content": "Atomically replace the **entire** field layout for a template. The\nexisting field set is deleted and the supplied array is inserted in a\nsingle transaction. Pass an empty `fields` array to clear all fields.\n\nUse this endpoint to programmatically place a fully-resolved field\nlayout after running `detect-placeholders` and `auto-place`, or to\nspecify fields by hand for a structured document.\n\nRequires the `templates:write` scope and an `Idempotency-Key` header.\nDraft-only: published templates must be re-drafted before fields can\nbe modified.\n", "type": "text/plain" }, "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n },\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "acfd6edd-68f2-4d48-89e9-d0d12fe48707", "name": "Fields saved — returns the complete current field set", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n },\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"kind\": \"date\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"variable_name\": \"\"\n },\n {\n \"id\": \"\",\n \"kind\": \"text\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"variable_name\": \"\"\n }\n ],\n \"total\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7993df6a-97d1-46a5-9130-b51921350de4", "name": "Missing Idempotency-Key", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n },\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a44a8c3-ea3c-4525-b277-dcf151c14f33", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n },\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61d05c4e-5d05-40c0-8a32-21d14a7e42c7", "name": "Authenticated but not allowed (not a platform admin / wrong service token).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n },\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bcb660d5-288b-441d-959a-d60fc8a720ad", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n },\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "754324fa-0388-4748-8ab1-2ea6858e9c3f", "name": "Conflict — either an idempotency key collision (same key, different\nbody) or the template is not in `draft` status (field mutations are\nonly allowed on draft templates).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n },\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eefbe765-c70e-4a08-9751-5c07d410db3e", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n },\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de18b951-bd1c-473d-a23e-e9e709fa80ed", "name": "A previous request carrying the **same** `Idempotency-Key` is still\nbeing processed. This is a transient condition — the first request has\nnot yet produced a stored response to replay. Wait briefly and retry\nwith the same key; you will then receive the original request's result\n(never a duplicate side effect). Applies only to write operations that\naccept an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n },\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unordered Collection (RFC 3648)", "code": 425, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cb48207-4983-435f-9387-924dadd73171", "name": "Rate limit exceeded. The caller has sent too many requests in the\ncurrent window. Slow down and retry after the duration indicated by\nthe `Retry-After` response header (value in seconds).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n },\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80e1bd77-29f4-41b9-855b-4a3925e54d05", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"fields\": [\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n },\n {\n \"kind\": \"date\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "24146709-094f-49ee-ac34-ba4783fc1d1f", "name": "Add a single template field (partner)", "request": { "name": "Add a single template field (partner)", "description": { "content": "Append a single signing field to a template without touching the\nexisting field set. Useful for incremental field placement.\n\nRequires the `templates:write` scope and an `Idempotency-Key` header.\n", "type": "text/plain" }, "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"initials\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "df82ed9f-cf2e-4664-b026-de1440d36f53", "name": "Field created", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"initials\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"kind\": \"checkbox\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"variable_name\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eb7ba4a5-2727-4090-8551-58a4b79f6dfa", "name": "Missing Idempotency-Key", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"initials\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cd18694a-65e7-42f6-9b6d-28170c4ec8dd", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"initials\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "953efc28-b32c-4870-a556-bce87b851ccb", "name": "Authenticated but not allowed (not a platform admin / wrong service token).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"initials\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b11c1b71-458d-4c6e-bbbc-36b641f4654a", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"initials\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ffd7358-78ba-4503-8714-5a1c5fefec5a", "name": "Conflict — either an idempotency key collision (same key, different\nbody) or the template is not in `draft` status (field mutations are\nonly allowed on draft templates).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"initials\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "99bdeebd-836a-4610-b623-9777d4af3a0d", "name": "Validation error (kind is required)", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"initials\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "599105a8-7576-47bb-a6f5-b0f415863f81", "name": "A previous request carrying the **same** `Idempotency-Key` is still\nbeing processed. This is a transient condition — the first request has\nnot yet produced a stored response to replay. Wait briefly and retry\nwith the same key; you will then receive the original request's result\n(never a duplicate side effect). Applies only to write operations that\naccept an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"initials\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unordered Collection (RFC 3648)", "code": 425, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3085eb8b-2855-402b-9e33-11387bcb9bd8", "name": "Rate limit exceeded. The caller has sent too many requests in the\ncurrent window. Slow down and retry after the duration indicated by\nthe `Retry-After` response header (value in seconds).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"initials\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a5ea455-b4be-4df9-b3f4-87bca974ed8b", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"kind\": \"initials\",\n \"id\": \"\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": true,\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{fieldId}", "description": "", "item": [ { "id": "8affc238-664b-45e8-95e9-33258aaa1a8c", "name": "Partially update a template field (partner)", "request": { "name": "Partially update a template field (partner)", "description": { "content": "Update individual properties of an existing field. Only the keys\npresent in the request body are changed; omitted keys are preserved.\n\nRequires the `templates:write` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "fieldId", "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"kind\": \"signature\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "a5fe9064-8137-4a0a-8667-04611729e7a3", "name": "Updated field", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"kind\": \"signature\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"kind\": \"checkbox\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"variable_name\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6d486e7-9291-4b72-b33e-913adf66c964", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"kind\": \"signature\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb67d32d-b0d2-480c-9a38-8c1edb47fa4a", "name": "Authenticated but not allowed (not a platform admin / wrong service token).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"kind\": \"signature\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e61d627-3d3e-4d67-b46c-0c11ded08e3b", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"kind\": \"signature\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "492941e4-de6b-4c1e-aaf6-0d7ad7a3e510", "name": "Template is not in `draft` status. Field mutations are only allowed\non draft templates.", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"kind\": \"signature\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "808fd7c1-955f-4683-b780-7756e5c0cfe0", "name": "No updatable fields supplied", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"kind\": \"signature\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9979299f-f4ee-4c1c-b701-1d553d3ec8d1", "name": "Rate limit exceeded. The caller has sent too many requests in the\ncurrent window. Slow down and retry after the duration indicated by\nthe `Retry-After` response header (value in seconds).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"kind\": \"signature\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f22c546-1c69-4e25-ac16-78714e4c7a3b", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"kind\": \"signature\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"validation\": \"\",\n \"variable_name\": \"\",\n \"whiteout_behind\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7f964445-59f6-4ebc-a3f5-f0197d63d045", "name": "Delete a single template field (partner)", "request": { "name": "Delete a single template field (partner)", "description": { "content": "Remove a single field from a template. The remaining fields are\nunaffected. Requires the `templates:write` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "fieldId", "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "70795469-402b-45c1-ac98-73eaf614359e", "name": "Field deleted", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f62c9e38-b41e-4cd6-8c07-eeb2f60d8d0c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e5c3d8ad-41bc-49e2-945a-6c45246ba0f6", "name": "Authenticated but not allowed (not a platform admin / wrong service token).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56ccff6e-6616-435e-a23c-3a14ed8df588", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "adbd3024-5cf8-4b69-befa-35a9e16ee50b", "name": "Template is not in `draft` status. Fields can only be removed from\ndraft templates.", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cb2fa8b-e8f6-43bb-9747-058c91dc3c38", "name": "Rate limit exceeded. The caller has sent too many requests in the\ncurrent window. Slow down and retry after the duration indicated by\nthe `Retry-After` response header (value in seconds).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1106607-9839-4dfd-b2c3-37d6e6915b36", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "fields", ":fieldId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Field ID (e.g. `fld_…`).", "type": "text/plain" }, "type": "any", "value": "", "key": "fieldId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "detect-placeholders", "description": "", "item": [ { "id": "d2efa235-b5a6-41ca-aa49-125e504eff3d", "name": "Detect placeholders in template PDF (partner)", "request": { "name": "Detect placeholders in template PDF (partner)", "description": { "content": "Scan the template's uploaded PDF for `{{variable_name}}` and\n`[FieldType]` placeholder tokens and cache the result server-side.\n\n**Must be called before `auto-place`** — `auto-place` reads from\nthe cached detection result rather than re-parsing the PDF.\n\nThis operation parses the PDF server-side and is rate-limited to\n**5 calls per API key per template per minute** to prevent abuse.\n\nRequires the `templates:write` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "templates", ":id", "detect-placeholders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "751452b5-c257-4fbd-aaa2-fc45e25dd379", "name": "Detection result", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "detect-placeholders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"placeholders\": [\n {\n \"name\": \"\",\n \"occurrences\": [\n {\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"raw\": \"\"\n },\n {\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"raw\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"occurrences\": [\n {\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"raw\": \"\"\n },\n {\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"raw\": \"\"\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1877def4-6eb9-49b0-8eed-3f9c2041e7a1", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "detect-placeholders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ca2c3d61-099d-4ab5-a6b4-dc89f2146c59", "name": "Authenticated but not allowed (not a platform admin / wrong service token).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "detect-placeholders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "31f92f13-ec67-4d5f-8e5d-e0ad51791f98", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "detect-placeholders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9d217a8-b9b3-469d-b68e-562089876228", "name": "Rate limit exceeded. The caller has sent too many requests in the\ncurrent window. Slow down and retry after the duration indicated by\nthe `Retry-After` response header (value in seconds).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "detect-placeholders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7758c5f4-a5e6-4be5-b99d-af347296721e", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "detect-placeholders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "auto-place", "description": "", "item": [ { "id": "e6f8ac9b-1aaa-449e-9968-1236908cbb0e", "name": "Auto-place fields from detected placeholders (partner)", "request": { "name": "Auto-place fields from detected placeholders (partner)", "description": { "content": "For each detected placeholder (or a named subset), create a `text`\nsigning field at the exact position of each occurrence. New\n`template_variables` rows are also created for any placeholder name\nnot yet in the variable manifest.\n\n**Idempotent** — occurrences that would collide with an existing\nfield are skipped (`occurrences_skipped`). Re-running the endpoint\nafter all placeholders are placed returns all-zero counts.\n\nCall `detect-placeholders` first; this endpoint reads from the cached\nresult rather than re-parsing the PDF.\n\nAt least one signer recipient must exist on the template before\ncalling this endpoint (the first signer by `signing_order` receives\nall auto-placed fields).\n\nRequires the `templates:write` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "templates", ":id", "auto-place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"names\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "0f919d88-ae19-48b3-b255-b9fcb9f36b77", "name": "Auto-placement result", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "auto-place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"names\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"variables_created\": \"\",\n \"fields_created\": \"\",\n \"occurrences_skipped\": \"\",\n \"new_field_ids\": [\n \"\",\n \"\"\n ],\n \"fields\": [\n {\n \"id\": \"\",\n \"kind\": \"initials\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"variable_name\": \"\"\n },\n {\n \"id\": \"\",\n \"kind\": \"initials\",\n \"page\": \"\",\n \"x\": \"\",\n \"y\": \"\",\n \"w\": \"\",\n \"h\": \"\",\n \"recipient_role\": \"\",\n \"required\": \"\",\n \"label\": \"\",\n \"placeholder\": \"\",\n \"variable_name\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e6eaa7b-59c3-4df7-8bbc-577957bb311a", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "auto-place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"names\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f3e70ec-bc0e-4ef9-a666-af5ce4da256f", "name": "Authenticated but not allowed (not a platform admin / wrong service token).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "auto-place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"names\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "402985dd-3bef-41c0-afcb-47e32fc5fb62", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "auto-place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"names\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69600a16-2441-4981-8608-406de23d39cf", "name": "Template is not in `draft` status. auto-place can only run on\ndraft templates.", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "auto-place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"names\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fb19acb-24b8-4e74-828d-c9b2f11aa2a1", "name": "No recipient rows found. Add at least one signer recipient before\nauto-placing fields.", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "auto-place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"names\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6787c89b-8778-4a00-a5f0-4841093c883f", "name": "Rate limit exceeded. The caller has sent too many requests in the\ncurrent window. Slow down and retry after the duration indicated by\nthe `Retry-After` response header (value in seconds).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "auto-place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"names\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3a25eb29-48a4-4196-bbe1-1a86783a81a3", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "auto-place" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"names\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "publish", "description": "", "item": [ { "id": "1a148dbf-96fd-404c-9573-a7dd4bc71ad2", "name": "Publish a template (partner)", "request": { "name": "Publish a template (partner)", "description": { "content": "Snapshot the current field layout and variable manifest into an\nimmutable version record and promote the template to `published`\nstatus. Re-publishing increments the major version (e.g.\n`v1.0.0` → `v2.0.0`).\n\nPartners must publish a template before it can be used to create\nenvelopes. After publishing, pin `templateVersionId` in envelope\ncreate requests to lock the field layout used at signing time.\n\nEmits a `template.published` webhook event.\n\nRequires the `templates:write` scope and an `Idempotency-Key` header.\n", "type": "text/plain" }, "url": { "path": [ "v1", "templates", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3993d17f-145a-4722-86bb-810214779dc9", "name": "Template published", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"status\": \"published\",\n \"current_version\": \"\",\n \"version_id\": \"\",\n \"field_count\": \"\",\n \"variable_count\": \"\",\n \"published_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f569b066-8ba3-4e26-9dcb-4e09883b648c", "name": "Missing Idempotency-Key", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef2f7f77-3edf-41c9-99b9-dcc4bc4fce44", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34c25570-93c6-47a9-a3e5-c23dab6b6d9f", "name": "Authenticated but not allowed (not a platform admin / wrong service token).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66829965-83e2-44c9-9867-b983bd713014", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15e8b9b9-636f-4f53-93b8-56fab3574d66", "name": "Idempotency conflict (same key, different body)", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "443829b9-191f-4485-96b0-56d937697241", "name": "A previous request carrying the **same** `Idempotency-Key` is still\nbeing processed. This is a transient condition — the first request has\nnot yet produced a stored response to replay. Wait briefly and retry\nwith the same key; you will then receive the original request's result\n(never a duplicate side effect). Applies only to write operations that\naccept an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unordered Collection (RFC 3648)", "code": 425, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c271c0c4-40ed-4db5-9d23-5f6b2d88682f", "name": "Rate limit exceeded. The caller has sent too many requests in the\ncurrent window. Slow down and retry after the duration indicated by\nthe `Retry-After` response header (value in seconds).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9f0a188-6f1d-40a6-bb04-c016804398e7", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "publish" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "versions", "description": "", "item": [ { "id": "4ee46220-2544-42f0-9a6b-b3d3003dc66f", "name": "List template versions (partner)", "request": { "name": "List template versions (partner)", "description": { "content": "List all published versions of a template in reverse chronological\norder. Each version includes an immutable snapshot of the fields and\nvariable schema at the time of publication. Use this to inspect\nhistorical layouts or to resolve which `template_version_id` to pin\nwhen creating an envelope.\n\nRequires the `templates:read` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "templates", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "11e36d94-c29c-4333-b4ea-4d82a65d1171", "name": "Version list", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"version_number\": \"\",\n \"fields_snapshot\": [\n \"\",\n \"\"\n ],\n \"variable_schema_snapshot\": [\n \"\",\n \"\"\n ],\n \"published_by\": \"\",\n \"published_at\": \"\"\n },\n {\n \"id\": \"\",\n \"version_number\": \"\",\n \"fields_snapshot\": [\n \"\",\n \"\"\n ],\n \"variable_schema_snapshot\": [\n \"\",\n \"\"\n ],\n \"published_by\": \"\",\n \"published_at\": \"\"\n }\n ],\n \"total\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7dea8e69-a75c-4c0d-879a-9b585d9b43c0", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b65c49b6-74e6-49f2-b043-5733be6022c8", "name": "Authenticated but not allowed (not a platform admin / wrong service token).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed6c50aa-3b59-4c2b-a7f3-bb1c363cc8ac", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cf0f044-4fc2-4463-9b97-0e8b17d3f059", "name": "Rate limit exceeded. The caller has sent too many requests in the\ncurrent window. Slow down and retry after the duration indicated by\nthe `Retry-After` response header (value in seconds).", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds to wait before retrying.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"issues\": [\n {\n \"key_0\": 3282,\n \"key_1\": 2003.0996556348025,\n \"key_2\": 1422,\n \"key_3\": \"string\"\n },\n {\n \"key_0\": false,\n \"key_1\": 6534.528503692359,\n \"key_2\": \"string\",\n \"key_3\": true\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b8fd6fa-4016-483a-b6e1-f27b5d1ec578", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "templates", ":id", "versions" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "envelopes", "description": "", "item": [ { "id": "c93e2070-da3c-4162-9a64-d673704a0814", "name": "List envelopes (partner)", "request": { "name": "List envelopes (partner)", "description": { "content": "Returns the 100 most recent envelopes for the authenticated tenant,\nordered by creation date descending. Requires the `envelopes:read`\nscope on the API key.\n\nOptionally filter by metadata key-value pairs using\n`?metadata[key]=value` query parameters. Multiple filters are ANDed\ntogether. Example: `?metadata[grant_id]=GRT-001&metadata[fund]=Alpha`\n\n**Reconciliation filters** — use `updated_since` and/or `status` for\nperiodic reconciliation sweeps to heal missed webhooks:\n- `?updated_since=2026-05-01T00:00:00Z` — envelopes updated at or after this timestamp\n- `?status=completed` — single status filter\n- `?status=completed,declined` — comma-separated list (OR semantics)\n- Combined: `?status=completed&updated_since=2026-05-01T00:00:00Z`\n\n**Stale draft listing** — use `created_before` combined with `status=draft`\nto find drafts older than a given timestamp for audit or cleanup:\n- `?status=draft&created_before=2026-04-07T00:00:00Z` — drafts created before April 7\n\nDraft envelopes are automatically voided after **30 days** by the nightly\nexpiry sweep (04:33 UTC). Use `created_before` to identify candidates\nbefore the sweep runs, then call `DELETE /v1/envelopes/{id}` to purge them\nproactively.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by a metadata key-value pair. Use bracket notation to\nsupply multiple filters:\n`?metadata[grant_id]=GRT-001&metadata[fund]=Alpha`.\nMultiple filters are ANDed. Key is the metadata field name.\n", "type": "text/plain" }, "key": "metadata[key]", "value": "" }, { "disabled": false, "description": { "content": "Return only envelopes whose `updated_at` is at or after this\nISO 8601 timestamp. Useful for periodic reconciliation sweeps\nthat need to pick up changes since the last poll.\n", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "Return only envelopes whose `created_at` is strictly before this\nISO 8601 timestamp. Combine with `status=draft` to list stale\ndraft envelopes eligible for cleanup.\n", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "Filter by envelope status. Accepts a single value or a\ncomma-separated list for OR semantics.\nValid values: `draft`, `sent`, `in_progress`, `completed`,\n`declined`, `voided`, `expired`.\n\n**Draft auto-expiry**: draft envelopes are automatically voided\nafter 30 days by the nightly expiry sweep (04:33 UTC).\n", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by envelope environment. `live` returns real envelopes;\n`sandbox` returns test envelopes created with a sandbox API key.\n (This can only be one of live,sandbox)", "type": "text/plain" }, "key": "env", "value": "sandbox" }, { "disabled": false, "description": { "content": "Return only envelopes whose `created_at` is at or after this\nISO 8601 timestamp.\n", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of results to return (1–100). Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "63548eb6-b317-4525-945e-9aa179d16748", "name": "Envelope list", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by a metadata key-value pair. Use bracket notation to\nsupply multiple filters:\n`?metadata[grant_id]=GRT-001&metadata[fund]=Alpha`.\nMultiple filters are ANDed. Key is the metadata field name.\n", "type": "text/plain" }, "key": "metadata[key]", "value": "" }, { "disabled": false, "description": { "content": "Return only envelopes whose `updated_at` is at or after this\nISO 8601 timestamp. Useful for periodic reconciliation sweeps\nthat need to pick up changes since the last poll.\n", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "Return only envelopes whose `created_at` is strictly before this\nISO 8601 timestamp. Combine with `status=draft` to list stale\ndraft envelopes eligible for cleanup.\n", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "Filter by envelope status. Accepts a single value or a\ncomma-separated list for OR semantics.\nValid values: `draft`, `sent`, `in_progress`, `completed`,\n`declined`, `voided`, `expired`.\n\n**Draft auto-expiry**: draft envelopes are automatically voided\nafter 30 days by the nightly expiry sweep (04:33 UTC).\n", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by envelope environment. `live` returns real envelopes;\n`sandbox` returns test envelopes created with a sandbox API key.\n (This can only be one of live,sandbox)", "type": "text/plain" }, "key": "env", "value": "sandbox" }, { "disabled": false, "description": { "content": "Return only envelopes whose `created_at` is at or after this\nISO 8601 timestamp.\n", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of results to return (1–100). Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"title\": \"\",\n \"status\": \"voided\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"metadata\": {\n \"key_0\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"title\": \"\",\n \"status\": \"draft\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\"\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b0188d60-83ea-4bdb-97bf-b9a9cb3a0047", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by a metadata key-value pair. Use bracket notation to\nsupply multiple filters:\n`?metadata[grant_id]=GRT-001&metadata[fund]=Alpha`.\nMultiple filters are ANDed. Key is the metadata field name.\n", "type": "text/plain" }, "key": "metadata[key]", "value": "" }, { "disabled": false, "description": { "content": "Return only envelopes whose `updated_at` is at or after this\nISO 8601 timestamp. Useful for periodic reconciliation sweeps\nthat need to pick up changes since the last poll.\n", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "Return only envelopes whose `created_at` is strictly before this\nISO 8601 timestamp. Combine with `status=draft` to list stale\ndraft envelopes eligible for cleanup.\n", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "Filter by envelope status. Accepts a single value or a\ncomma-separated list for OR semantics.\nValid values: `draft`, `sent`, `in_progress`, `completed`,\n`declined`, `voided`, `expired`.\n\n**Draft auto-expiry**: draft envelopes are automatically voided\nafter 30 days by the nightly expiry sweep (04:33 UTC).\n", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by envelope environment. `live` returns real envelopes;\n`sandbox` returns test envelopes created with a sandbox API key.\n (This can only be one of live,sandbox)", "type": "text/plain" }, "key": "env", "value": "sandbox" }, { "disabled": false, "description": { "content": "Return only envelopes whose `created_at` is at or after this\nISO 8601 timestamp.\n", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of results to return (1–100). Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f04e433-ed73-449a-8e9e-15cc2d36774a", "name": "Forbidden (missing scope or IP not allowed)", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by a metadata key-value pair. Use bracket notation to\nsupply multiple filters:\n`?metadata[grant_id]=GRT-001&metadata[fund]=Alpha`.\nMultiple filters are ANDed. Key is the metadata field name.\n", "type": "text/plain" }, "key": "metadata[key]", "value": "" }, { "disabled": false, "description": { "content": "Return only envelopes whose `updated_at` is at or after this\nISO 8601 timestamp. Useful for periodic reconciliation sweeps\nthat need to pick up changes since the last poll.\n", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "Return only envelopes whose `created_at` is strictly before this\nISO 8601 timestamp. Combine with `status=draft` to list stale\ndraft envelopes eligible for cleanup.\n", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "Filter by envelope status. Accepts a single value or a\ncomma-separated list for OR semantics.\nValid values: `draft`, `sent`, `in_progress`, `completed`,\n`declined`, `voided`, `expired`.\n\n**Draft auto-expiry**: draft envelopes are automatically voided\nafter 30 days by the nightly expiry sweep (04:33 UTC).\n", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by envelope environment. `live` returns real envelopes;\n`sandbox` returns test envelopes created with a sandbox API key.\n (This can only be one of live,sandbox)", "type": "text/plain" }, "key": "env", "value": "sandbox" }, { "disabled": false, "description": { "content": "Return only envelopes whose `created_at` is at or after this\nISO 8601 timestamp.\n", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of results to return (1–100). Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "732e1ab1-1bc9-4236-82de-8d3c5a361a7b", "name": "A previous request carrying the **same** `Idempotency-Key` is still\nbeing processed. This is a transient condition — the first request has\nnot yet produced a stored response to replay. Wait briefly and retry\nwith the same key; you will then receive the original request's result\n(never a duplicate side effect). Applies only to write operations that\naccept an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by a metadata key-value pair. Use bracket notation to\nsupply multiple filters:\n`?metadata[grant_id]=GRT-001&metadata[fund]=Alpha`.\nMultiple filters are ANDed. Key is the metadata field name.\n", "type": "text/plain" }, "key": "metadata[key]", "value": "" }, { "disabled": false, "description": { "content": "Return only envelopes whose `updated_at` is at or after this\nISO 8601 timestamp. Useful for periodic reconciliation sweeps\nthat need to pick up changes since the last poll.\n", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "Return only envelopes whose `created_at` is strictly before this\nISO 8601 timestamp. Combine with `status=draft` to list stale\ndraft envelopes eligible for cleanup.\n", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "Filter by envelope status. Accepts a single value or a\ncomma-separated list for OR semantics.\nValid values: `draft`, `sent`, `in_progress`, `completed`,\n`declined`, `voided`, `expired`.\n\n**Draft auto-expiry**: draft envelopes are automatically voided\nafter 30 days by the nightly expiry sweep (04:33 UTC).\n", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by envelope environment. `live` returns real envelopes;\n`sandbox` returns test envelopes created with a sandbox API key.\n (This can only be one of live,sandbox)", "type": "text/plain" }, "key": "env", "value": "sandbox" }, { "disabled": false, "description": { "content": "Return only envelopes whose `created_at` is at or after this\nISO 8601 timestamp.\n", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of results to return (1–100). Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unordered Collection (RFC 3648)", "code": 425, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "444fc13a-1fb3-46ed-ba5a-c164a46d01f3", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by a metadata key-value pair. Use bracket notation to\nsupply multiple filters:\n`?metadata[grant_id]=GRT-001&metadata[fund]=Alpha`.\nMultiple filters are ANDed. Key is the metadata field name.\n", "type": "text/plain" }, "key": "metadata[key]", "value": "" }, { "disabled": false, "description": { "content": "Return only envelopes whose `updated_at` is at or after this\nISO 8601 timestamp. Useful for periodic reconciliation sweeps\nthat need to pick up changes since the last poll.\n", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "Return only envelopes whose `created_at` is strictly before this\nISO 8601 timestamp. Combine with `status=draft` to list stale\ndraft envelopes eligible for cleanup.\n", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "Filter by envelope status. Accepts a single value or a\ncomma-separated list for OR semantics.\nValid values: `draft`, `sent`, `in_progress`, `completed`,\n`declined`, `voided`, `expired`.\n\n**Draft auto-expiry**: draft envelopes are automatically voided\nafter 30 days by the nightly expiry sweep (04:33 UTC).\n", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by envelope environment. `live` returns real envelopes;\n`sandbox` returns test envelopes created with a sandbox API key.\n (This can only be one of live,sandbox)", "type": "text/plain" }, "key": "env", "value": "sandbox" }, { "disabled": false, "description": { "content": "Return only envelopes whose `created_at` is at or after this\nISO 8601 timestamp.\n", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of results to return (1–100). Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0be8a685-36e9-4de7-ac1a-1bf8abaaa005", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter by a metadata key-value pair. Use bracket notation to\nsupply multiple filters:\n`?metadata[grant_id]=GRT-001&metadata[fund]=Alpha`.\nMultiple filters are ANDed. Key is the metadata field name.\n", "type": "text/plain" }, "key": "metadata[key]", "value": "" }, { "disabled": false, "description": { "content": "Return only envelopes whose `updated_at` is at or after this\nISO 8601 timestamp. Useful for periodic reconciliation sweeps\nthat need to pick up changes since the last poll.\n", "type": "text/plain" }, "key": "updated_since", "value": "" }, { "disabled": false, "description": { "content": "Return only envelopes whose `created_at` is strictly before this\nISO 8601 timestamp. Combine with `status=draft` to list stale\ndraft envelopes eligible for cleanup.\n", "type": "text/plain" }, "key": "created_before", "value": "" }, { "disabled": false, "description": { "content": "Filter by envelope status. Accepts a single value or a\ncomma-separated list for OR semantics.\nValid values: `draft`, `sent`, `in_progress`, `completed`,\n`declined`, `voided`, `expired`.\n\n**Draft auto-expiry**: draft envelopes are automatically voided\nafter 30 days by the nightly expiry sweep (04:33 UTC).\n", "type": "text/plain" }, "key": "status", "value": "" }, { "disabled": false, "description": { "content": "Filter by envelope environment. `live` returns real envelopes;\n`sandbox` returns test envelopes created with a sandbox API key.\n (This can only be one of live,sandbox)", "type": "text/plain" }, "key": "env", "value": "sandbox" }, { "disabled": false, "description": { "content": "Return only envelopes whose `created_at` is at or after this\nISO 8601 timestamp.\n", "type": "text/plain" }, "key": "created_after", "value": "" }, { "disabled": false, "description": { "content": "Maximum number of results to return (1–100). Defaults to 20.", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26287252-b3b3-45e9-842c-05b83314b27c", "name": "Create envelope (partner)", "request": { "name": "Create envelope (partner)", "description": { "content": "Create a new envelope in `draft` status from a template. The envelope\nis **not sent** yet — call `POST /v1/envelopes/{id}/send` to dispatch\nsigner invites and transition to `sent`.\n\n**Atomic send**: Pass `send_immediately: true` in the request body to\ncreate and send the envelope in a single request. All database writes\n(envelope row, recipients, tokens, audit events) are committed in one\nDB transaction, so there is never an orphaned draft in the database.\nAfter the transaction commits, invitation emails are dispatched. If\ndispatch fails, a compensating void is applied and `500` with code\n`atomic_send_failed` is returned. On success the response `status`\nfield is `\"sent\"` and includes a `sent_at` timestamp.\n\nReturns `signing_links` containing per-recipient signing URLs. These\nURLs can be embedded in the partner application or shared directly with\nsigners. URLs expire at `expires_at`.\n\nRequires the `envelopes:write` scope and an `Idempotency-Key` header.\nEmits `envelope.created` webhook event (and `envelope.sent` when\n`send_immediately: true`).\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"\",\n \"signers\": [\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n }\n ],\n \"title\": \"\",\n \"variables\": {\n \"key_0\": 5439.458403261829,\n \"key_1\": 8696.846021929929,\n \"key_2\": 6726.711026853613,\n \"key_3\": \"string\"\n },\n \"metadata\": {\n \"key_0\": 8029,\n \"key_1\": \"string\"\n },\n \"expires_in_days\": \"\",\n \"send_immediately\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b7c0b4fd-7d4a-40c2-a2f3-d700f78162df", "name": "Envelope created (draft)", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"\",\n \"signers\": [\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n }\n ],\n \"title\": \"\",\n \"variables\": {\n \"key_0\": 5439.458403261829,\n \"key_1\": 8696.846021929929,\n \"key_2\": 6726.711026853613,\n \"key_3\": \"string\"\n },\n \"metadata\": {\n \"key_0\": 8029,\n \"key_1\": \"string\"\n },\n \"expires_in_days\": \"\",\n \"send_immediately\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"title\": \"\",\n \"status\": \"sent\",\n \"template_id\": \"\",\n \"created_at\": \"\",\n \"expires_at\": \"\",\n \"signing_links\": [\n {\n \"recipient_id\": \"\",\n \"role_name\": \"\",\n \"role_type\": \"viewer\",\n \"email\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"expires_at\": \"\"\n },\n {\n \"recipient_id\": \"\",\n \"role_name\": \"\",\n \"role_type\": \"signer\",\n \"email\": \"\",\n \"name\": \"\",\n \"url\": \"\",\n \"expires_at\": \"\"\n }\n ],\n \"metadata\": {\n \"key_0\": \"\"\n },\n \"sent_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "11036594-4d65-45ba-ab8f-5a3d428392ba", "name": "Missing Idempotency-Key", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"\",\n \"signers\": [\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n }\n ],\n \"title\": \"\",\n \"variables\": {\n \"key_0\": 5439.458403261829,\n \"key_1\": 8696.846021929929,\n \"key_2\": 6726.711026853613,\n \"key_3\": \"string\"\n },\n \"metadata\": {\n \"key_0\": 8029,\n \"key_1\": \"string\"\n },\n \"expires_in_days\": \"\",\n \"send_immediately\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "644b598e-9abf-40e3-b192-74ac62fc3d4d", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"\",\n \"signers\": [\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n }\n ],\n \"title\": \"\",\n \"variables\": {\n \"key_0\": 5439.458403261829,\n \"key_1\": 8696.846021929929,\n \"key_2\": 6726.711026853613,\n \"key_3\": \"string\"\n },\n \"metadata\": {\n \"key_0\": 8029,\n \"key_1\": \"string\"\n },\n \"expires_in_days\": \"\",\n \"send_immediately\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9a291348-96e0-419e-be47-aba0d0f320b2", "name": "Forbidden (missing scope or IP not allowed)", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"\",\n \"signers\": [\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n }\n ],\n \"title\": \"\",\n \"variables\": {\n \"key_0\": 5439.458403261829,\n \"key_1\": 8696.846021929929,\n \"key_2\": 6726.711026853613,\n \"key_3\": \"string\"\n },\n \"metadata\": {\n \"key_0\": 8029,\n \"key_1\": \"string\"\n },\n \"expires_in_days\": \"\",\n \"send_immediately\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4e9db48b-cfe2-4cc6-a23c-8c44001780fe", "name": "Idempotency conflict (same key, different body)", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"\",\n \"signers\": [\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n }\n ],\n \"title\": \"\",\n \"variables\": {\n \"key_0\": 5439.458403261829,\n \"key_1\": 8696.846021929929,\n \"key_2\": 6726.711026853613,\n \"key_3\": \"string\"\n },\n \"metadata\": {\n \"key_0\": 8029,\n \"key_1\": \"string\"\n },\n \"expires_in_days\": \"\",\n \"send_immediately\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1f041394-4e8f-4e8e-b70d-698ecda00e3c", "name": "Validation error (e.g. unknown template_id, missing signers)", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"\",\n \"signers\": [\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n }\n ],\n \"title\": \"\",\n \"variables\": {\n \"key_0\": 5439.458403261829,\n \"key_1\": 8696.846021929929,\n \"key_2\": 6726.711026853613,\n \"key_3\": \"string\"\n },\n \"metadata\": {\n \"key_0\": 8029,\n \"key_1\": \"string\"\n },\n \"expires_in_days\": \"\",\n \"send_immediately\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ecff2cb-5897-43f1-866e-f001614c51e1", "name": "A previous request carrying the **same** `Idempotency-Key` is still\nbeing processed. This is a transient condition — the first request has\nnot yet produced a stored response to replay. Wait briefly and retry\nwith the same key; you will then receive the original request's result\n(never a duplicate side effect). Applies only to write operations that\naccept an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"\",\n \"signers\": [\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n }\n ],\n \"title\": \"\",\n \"variables\": {\n \"key_0\": 5439.458403261829,\n \"key_1\": 8696.846021929929,\n \"key_2\": 6726.711026853613,\n \"key_3\": \"string\"\n },\n \"metadata\": {\n \"key_0\": 8029,\n \"key_1\": \"string\"\n },\n \"expires_in_days\": \"\",\n \"send_immediately\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unordered Collection (RFC 3648)", "code": 425, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f782c5e8-d2b2-4a9d-8e39-b046d7130045", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"\",\n \"signers\": [\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n }\n ],\n \"title\": \"\",\n \"variables\": {\n \"key_0\": 5439.458403261829,\n \"key_1\": 8696.846021929929,\n \"key_2\": 6726.711026853613,\n \"key_3\": \"string\"\n },\n \"metadata\": {\n \"key_0\": 8029,\n \"key_1\": \"string\"\n },\n \"expires_in_days\": \"\",\n \"send_immediately\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8e330a26-1ee2-43e2-baf8-630f652f44e5", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "envelopes" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"template_id\": \"\",\n \"signers\": [\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n },\n {\n \"email\": \"\",\n \"name\": \"\",\n \"role_name\": \"\",\n \"role\": \"\"\n }\n ],\n \"title\": \"\",\n \"variables\": {\n \"key_0\": 5439.458403261829,\n \"key_1\": 8696.846021929929,\n \"key_2\": 6726.711026853613,\n \"key_3\": \"string\"\n },\n \"metadata\": {\n \"key_0\": 8029,\n \"key_1\": \"string\"\n },\n \"expires_in_days\": \"\",\n \"send_immediately\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "e3c6f426-c98d-4763-8f56-486e22e6b775", "name": "Get envelope (partner)", "request": { "name": "Get envelope (partner)", "description": { "content": "Full envelope state with recipients, statuses, and signed-at\ntimestamps. Requires the `envelopes:read` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "4ea1a41e-b94d-4e25-811f-e050f2a87b67", "name": "Envelope detail", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"title\": \"\",\n \"status\": \"in_progress\",\n \"env\": \"live\",\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"recipients\": [\n {\n \"id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"signing_order\": \"\",\n \"status\": \"sent\",\n \"signed_at\": \"\"\n },\n {\n \"id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"signing_order\": \"\",\n \"status\": \"signed\",\n \"signed_at\": \"\"\n }\n ],\n \"template_id\": \"\",\n \"metadata\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n },\n \"signed_document_sha256\": \"\",\n \"audit_certificate_url\": \"\",\n \"voided_at\": \"\",\n \"expires_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "69fa977b-2298-4a74-aa29-b82edb92c0db", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e1006647-79ea-43c1-a3e9-0aa7e88423c6", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4fb1e5da-9182-4e07-9e9f-6f5982824ccb", "name": "Envelope not found", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f8ae64f-1372-4d2d-aa15-ba495360ff37", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3100c592-f710-4b8a-b5f5-56ba723fcd19", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7d1e46d4-303f-4c82-a4d9-2b8e95ea5e33", "name": "Delete draft envelope (partner)", "request": { "name": "Delete draft envelope (partner)", "description": { "content": "Purge a draft envelope that was never sent. The envelope is\nsoft-deleted by transitioning its status to `voided`. An\n`envelope.voided` webhook is emitted with `reason: \"partner_deleted\"`.\n\nOnly envelopes in `draft` status may be deleted. Calling this on a\nnon-draft envelope returns `409 invalid_state`.\n\nDraft envelopes are automatically voided after **30 days** by the\nnightly expiry sweep (04:33 UTC) with `reason: \"draft_expired\"`.\n\nRequires the `envelopes:write` scope and an `Idempotency-Key` header.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "5509e9f7-f374-4b96-a2a0-50ed5d275e2e", "name": "Draft envelope purged — no content returned.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9d821cc8-41b8-4309-a52d-fbdfee955934", "name": "Missing Idempotency-Key header", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8e9cc2b-f7aa-4644-ae25-4747f8d5f7ce", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ebd7c010-f381-4f33-a86f-5def86050d6a", "name": "Forbidden (missing scope or IP not allowed)", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d05f112-2d56-48a9-8b8f-0075dcf25233", "name": "Envelope not found", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddc5831b-a7b4-47ae-8c85-da10eec5bc71", "name": "Conflict — `invalid_state` (envelope not in draft status) or\n`idempotency_conflict` (same key, different body).", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "520a5e21-978b-493d-85c3-f89e26010410", "name": "A previous request carrying the **same** `Idempotency-Key` is still\nbeing processed. This is a transient condition — the first request has\nnot yet produced a stored response to replay. Wait briefly and retry\nwith the same key; you will then receive the original request's result\n(never a duplicate side effect). Applies only to write operations that\naccept an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unordered Collection (RFC 3648)", "code": 425, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "695b8e4d-5e72-43ef-9bd6-86d0d50d0a7b", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "971194b2-c2e9-44ee-9aa4-ec85b3394f2b", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "metadata", "description": "", "item": [ { "id": "cd519e2a-b575-418a-a7f0-df56d706fe55", "name": "Update envelope metadata (partner)", "request": { "name": "Update envelope metadata (partner)", "description": { "content": "Merge-update partner reference metadata on an existing envelope.\n\nKeys in the request body are merged into the current metadata object —\nexisting keys not present in the patch body are preserved. To clear a\nspecific key, set its value to the empty string `\"\"`.\n\nThe merged result must not exceed 20 keys. All values must be strings\n≤ 500 characters.\n\nWorks on envelopes in any lifecycle state (draft, sent, completed, etc.).\nRequires the `envelopes:write` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":id", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": \"\",\n \"key_1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "35f4dbd4-a93d-43c7-84a2-4ae333adc0e0", "name": "Metadata updated", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": \"\",\n \"key_1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"metadata\": {\n \"key_0\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f5e34862-2cff-44a3-a8e1-07cc0cbedcda", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": \"\",\n \"key_1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5dfced54-a6d9-4539-b34d-f16392eefec8", "name": "Forbidden (missing scope or IP not allowed)", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": \"\",\n \"key_1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a348c80e-1aa2-4584-aff0-b5cde307b215", "name": "Envelope not found", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": \"\",\n \"key_1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6596d860-7fc6-4add-addc-e17f84ee9a1c", "name": "Validation error (too many keys, value too long, etc.)", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": \"\",\n \"key_1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ceeed35e-a2d9-4e23-b081-42f1463a588e", "name": "A previous request carrying the **same** `Idempotency-Key` is still\nbeing processed. This is a transient condition — the first request has\nnot yet produced a stored response to replay. Wait briefly and retry\nwith the same key; you will then receive the original request's result\n(never a duplicate side effect). Applies only to write operations that\naccept an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": \"\",\n \"key_1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unordered Collection (RFC 3648)", "code": 425, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "193cb715-afad-4dd9-9f7c-57501f0bb00e", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "metadata" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"key_0\": \"\",\n \"key_1\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "send", "description": "", "item": [ { "id": "daae1323-69c1-4429-a369-cc90c31e36be", "name": "Send envelope (partner)", "request": { "name": "Send envelope (partner)", "description": { "content": "Transitions a `draft` envelope to `sent` and dispatches signer\ninvitation emails. In sandbox mode (`sk_test_…`) emails are suppressed\nbut outbound message rows are still written so the timeline is complete.\n\nRequires the `envelopes:write` scope and an `Idempotency-Key` header.\nEmits `envelope.sent` webhook event.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":id", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "7d18041e-e564-461a-a6df-8b520b48a19c", "name": "Envelope sent", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"sent\",\n \"sent_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38c59664-eb11-43c2-8a10-6a6364b47aed", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d6840e35-b8a8-45b0-af6c-f65cf9ff866d", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f17a6ef9-42dd-4cb3-a5bc-dab9a05bb62d", "name": "Envelope not found", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8cfd0f16-55f4-444f-9fd4-dbe7752e416d", "name": "Envelope is not in `draft` state (`invalid_state` code).", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "faf7dbd8-44ab-4215-b588-4d2d00245812", "name": "A previous request carrying the **same** `Idempotency-Key` is still\nbeing processed. This is a transient condition — the first request has\nnot yet produced a stored response to replay. Wait briefly and retry\nwith the same key; you will then receive the original request's result\n(never a duplicate side effect). Applies only to write operations that\naccept an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unordered Collection (RFC 3648)", "code": 425, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "387d0a38-bd50-4898-9342-0f498f4e62ac", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f1d738b-aa12-4e86-8a4a-91fc19453189", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "void", "description": "", "item": [ { "id": "3712d239-1f18-49ab-8ac5-6266af11efbe", "name": "Void envelope (partner)", "request": { "name": "Void envelope (partner)", "description": { "content": "Void an in-flight envelope with an optional partner-supplied reason.\nThe envelope must not be in a terminal state (`completed`, `voided`,\nor `expired`).\n\nRequires the `envelopes:write` scope and an `Idempotency-Key` header.\nEmits `envelope.voided` webhook event.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "6877ba71-8a7c-4f57-8fee-e38bb7d7c637", "name": "Envelope voided", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"status\": \"voided\",\n \"voided_at\": \"\",\n \"reason\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01d2d2ab-2dcd-4159-90ab-cebd9717a6f7", "name": "Missing Idempotency-Key", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "db627737-7535-4c32-8478-9a20b40b8621", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "483792db-ffd9-4dda-9483-48f7c88cd1fe", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6bfffb04-cd44-4c2e-a7ce-763aafb5b0fb", "name": "Envelope not found", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2ed8621e-f7a4-4156-91ec-52d658508768", "name": "Envelope is already in a terminal state (`invalid_state` code), or\nidempotency key conflict (same key, different body).", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f07e6a0c-1436-42f2-a838-3f3503d0de65", "name": "A previous request carrying the **same** `Idempotency-Key` is still\nbeing processed. This is a transient condition — the first request has\nnot yet produced a stored response to replay. Wait briefly and retry\nwith the same key; you will then receive the original request's result\n(never a duplicate side effect). Applies only to write operations that\naccept an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unordered Collection (RFC 3648)", "code": 425, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d490e87-668a-409f-b950-9c91da6397c8", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed28b73f-197c-43f7-ac78-02b308778a45", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "void" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"reason\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "documents", "description": "", "item": [ { "name": "signed", "description": "", "item": [ { "id": "fa0476d6-ac28-4570-9a27-922f69adc3ef", "name": "Download signed PDF (partner)", "request": { "name": "Download signed PDF (partner)", "description": { "content": "Streams the executed (signed + stamped) PDF when the envelope status\nis `completed`. Returns `404` with code `not_yet_completed` if the\nenvelope is not yet complete.\n\nRequires the `envelopes:read` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":id", "documents", "signed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "2d3635b5-486a-4b1f-815c-a78f03db7172", "name": "Signed PDF", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "documents", "signed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/pdf" }, { "disabled": false, "description": { "content": "SHA-256 hex digest of the signed PDF bytes. Present on all\ncompleted envelopes that have a stamped document. Partners can\nuse this to verify download integrity without a second request.\n", "type": "text/plain" }, "key": "X-Document-SHA256", "value": "" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7f448804-b5bd-4250-81d9-500505bdc1d5", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "documents", "signed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8983d00c-eaea-4300-92e1-a496ea1ed835", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "documents", "signed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f056714e-e936-47de-b633-017b9ea1eb5f", "name": "Envelope not found, or signed PDF not yet available\n(`not_yet_completed` code when envelope is not `completed`).", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "documents", "signed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5186bc97-d3fc-4711-811f-7067256b3219", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "documents", "signed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4d32633-92a9-4159-93f4-481c33eb0fae", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "documents", "signed" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] }, { "name": "recipients", "description": "", "item": [ { "name": "{recipientId}", "description": "", "item": [ { "name": "resend", "description": "", "item": [ { "id": "fecb5e8e-29de-49b4-8e33-6135379d7629", "name": "Resend invitation to recipient (partner)", "request": { "name": "Resend invitation to recipient (partner)", "description": { "content": "Re-dispatches the signing invitation email to a specific recipient who\nmissed the original. Only valid for envelopes in `sent` or `viewed`\nstate. Recipients who have already signed are excluded.\n\n**Cooldown**: Max 1 resend per recipient per hour. Exceeding this limit\nreturns `429` with a `Retry-After` header (seconds until retry is\nallowed) and code `resend_cooldown`.\n\n**Sandbox mode**: With a `sk_test_…` key, the invitation email is\nsuppressed but the outbound message row and audit trail are still\nwritten — behaviour is identical to the live path minus actual\ndelivery.\n\nRequires the `envelopes:write` scope and an `Idempotency-Key` header.\nEmits `envelope.resent` webhook event.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "recipientId", "disabled": false, "description": { "content": "(Required) ID of the recipient to resend the invitation to.", "type": "text/plain" } } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e2dfd7cb-507a-4257-9c58-2c5efb1bc065", "name": "Invitation resent successfully", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient to resend the invitation to.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"recipient_id\": \"\",\n \"resent_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "04efbab3-e83f-4d44-ac7a-dcc903020145", "name": "Missing Idempotency-Key", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient to resend the invitation to.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a4d1dbbe-2a1b-4115-9ac4-fc13f8ceb5a7", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient to resend the invitation to.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01a58f2e-66d5-450d-b087-56c8299e20b6", "name": "Forbidden (missing scope)", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient to resend the invitation to.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b0f434b-2c8b-4ddc-83ca-043dbec78c22", "name": "Envelope or recipient not found", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient to resend the invitation to.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "71ce3f64-d75e-42f4-81ab-eca37817e9df", "name": "Invalid state — envelope is not in `sent` or `viewed` state, or\nrecipient has already signed (`invalid_state` code).", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient to resend the invitation to.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c4a0654c-9f21-44d8-ba6e-db109ae420d5", "name": "Recipient role is not `signer` or `approver` (`invalid_state` code).", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient to resend the invitation to.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d65a1d83-f828-4253-bbd2-a8511468fb85", "name": "A previous request carrying the **same** `Idempotency-Key` is still\nbeing processed. This is a transient condition — the first request has\nnot yet produced a stored response to replay. Wait briefly and retry\nwith the same key; you will then receive the original request's result\n(never a duplicate side effect). Applies only to write operations that\naccept an `Idempotency-Key` header.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient to resend the invitation to.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unordered Collection (RFC 3648)", "code": 425, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "135e00a2-3bd1-476f-ae17-1ee2c33f3c7b", "name": "Resend cooldown active — max 1 resend per recipient per hour\n(`resend_cooldown` code). Check the `Retry-After` header for\nseconds until retry is allowed.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient to resend the invitation to.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "Seconds until the cooldown expires.", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0106e01-7ab7-4af8-966c-e96512c87a83", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "resend" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient to resend the invitation to.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "disabled": false, "description": { "content": "Client-supplied idempotency key (UUID v4 recommended). When present,\nthe server stores the response of the first execution and returns the\nsame response for any subsequent request with the same key and identical\nrequest body. A different body with the same key returns\n`409 idempotency_conflict`. A concurrent in-flight request with the\nsame key returns `425 idempotency_in_progress`.\n\n**Required** on partner POST/PUT/PATCH endpoints. Optional on reads.\nKeys expire after 24 hours; expired keys trigger a fresh execution.\n", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "signing-url", "description": "", "item": [ { "id": "a315fffe-00a2-4f7a-ad19-c1d02578ed9e", "name": "Get signing URL for a recipient (partner)", "request": { "name": "Get signing URL for a recipient (partner)", "description": { "content": "Returns the current signing URL for a specific recipient without\nsending any email or modifying any state. Intended for partners\nbuilding embedded signing flows.\n\nRequires the `envelopes:read` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "signing-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "recipientId", "disabled": false, "description": { "content": "(Required) ID of the recipient whose signing URL to retrieve.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "492f3273-8f01-4452-b469-906d855a9600", "name": "Signing URL retrieved", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "signing-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient whose signing URL to retrieve.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"signing_url\": \"\",\n \"expires_at\": \"\",\n \"token_status\": \"active\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f0cb9ee6-7269-47ec-904d-cf8fb30b6ee2", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "signing-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient whose signing URL to retrieve.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bea935be-c26f-470f-8087-644250a2c581", "name": "Forbidden (missing scope or IP not allowed)", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "signing-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient whose signing URL to retrieve.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "61853959-35db-4682-b929-7b5e11f7f51d", "name": "Envelope or recipient not found", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "signing-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient whose signing URL to retrieve.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb8181f4-3e2e-4d35-91c5-818d8097ae82", "name": "Conflict — either the envelope is not in a signable state\n(`invalid_state` code) or the recipient has already signed\n(`token_used` code).", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "signing-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient whose signing URL to retrieve.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b8e6c53-4af8-474e-b312-5fe1a638a45e", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "signing-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient whose signing URL to retrieve.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8398f88b-f44b-4cce-91ff-4a791b691e92", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "recipients", ":recipientId", "signing-url" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) ID of the recipient whose signing URL to retrieve.", "type": "text/plain" }, "type": "any", "value": "", "key": "recipientId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "certificate", "description": "", "item": [ { "id": "b7436122-0388-4027-9ec8-c8b619f5ed49", "name": "Download audit certificate (partner)", "request": { "name": "Download audit certificate (partner)", "description": { "content": "Streams the audit certificate PDF. For envelopes completed after this\nfeature was introduced, the stored copy (written at completion time) is\nserved directly from object storage — it carries the same retention\nguarantee as the signed PDF (SEC evidentiary model). For older\nenvelopes the certificate is generated on-demand from the append-only\n`envelope_events` timeline.\n\nThe `X-Document-SHA256` response header contains the SHA-256 hex digest\nof the certificate bytes themselves (not of the signed PDF). Partners\ncan use this to verify the certificate's integrity after download.\n\nAvailable for envelopes in any status — useful for in-progress audit\ntrails as well as post-completion evidence packages.\n\nRequires the `envelopes:read` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":id", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "306f1479-8c7a-4653-884c-264f85c5496b", "name": "Audit certificate PDF", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/pdf" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/pdf" }, { "disabled": false, "description": { "content": "SHA-256 hex digest of the certificate PDF bytes.", "type": "text/plain" }, "key": "X-Document-SHA256", "value": "" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "8b6e0899-9b66-4321-91f3-21a981802f16", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "02180e2c-133d-491a-b187-b7a424245d96", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9d9f7d07-6d81-4f33-bb49-3c331ffb6dc5", "name": "Envelope not found", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac897043-0319-4ccd-a60e-e1de2e27223f", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6c821457-f8f4-4c70-ae97-132e568b6038", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "certificate" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "retry", "description": "", "item": [ { "id": "e012e658-33d1-48a3-995f-c3852e81f2a2", "name": "Retry PDF generation (partner)", "request": { "name": "Retry PDF generation (partner)", "description": { "content": "Re-triggers PDF generation for an envelope stuck in `processing_failed`\nstatus (all pg-boss retry attempts exhausted). Resets the envelope to\n`processing` and re-enqueues the `pdf.stamp` job.\n\nAfter the retry job completes the envelope transitions to `completed` or\nback to `processing_failed` as normal, and the standard `envelope.completed`\nwebhook fires on success.\n\n**Constraints:**\n- Envelope must be in `processing_failed` status. Returns `409 invalid_state`\n for any other status.\n- Returns `409 already_retrying` if a stamp job for this envelope is already\n pending or running — the caller may poll the envelope status and retry later.\n- No `Idempotency-Key` is required. The pg-boss singleton key provides\n natural idempotency: duplicate calls before the job starts are no-ops.\n\nRequires the `envelopes:write` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "cfe65475-a2e8-4d34-9ff0-3c0e4ed11a66", "name": "Retry job enqueued — envelope reset to processing", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"id\": \"\",\n \"status\": \"processing\",\n \"retried_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac8f4887-f4dc-40ec-8acd-1c8478e4085b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18b8bef9-ed47-4a83-b4f4-ceaa2de4174f", "name": "Forbidden (missing scope or IP not allowed)", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "902aaf1d-c6eb-4382-a40c-05a277c22e87", "name": "Envelope not found", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f92f2cad-37a5-4295-9e70-5327c6561b8a", "name": "Conflict. Two possible codes:\n- `invalid_state` — envelope is not in `processing_failed` status.\n- `already_retrying` — a stamp job is already pending or active for this envelope.", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f121c37-0f9b-482d-9e84-e44695b34e1f", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4749273a-b2c7-4bf9-bc11-b8a592c0859e", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "signing-urls", "description": "", "item": [ { "id": "d22339e3-f013-447b-929a-e9f9b1ff93ba", "name": "Get all signing URLs for an envelope (partner)", "request": { "name": "Get all signing URLs for an envelope (partner)", "description": { "content": "Returns signing URLs for **all** recipients of the envelope in a\nsingle request, avoiding N calls to the per-recipient endpoint.\n\nEach entry includes the recipient's role, a `signing_url` (null for\nrole types that do not have a signing token such as `cc` or `viewer`),\nand a `token_status` reflecting the current state of the recipient's\ntoken (`active`, `used`, or `expired`).\n\nOnly available when the envelope is in `sent` or `in_progress` state.\nRequires the `envelopes:read` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "envelopes", ":id", "signing-urls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "b63a7e02-0579-4ff6-8c9c-813622e88a66", "name": "Signing URLs for all recipients", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "signing-urls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"items\": [\n {\n \"recipient_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"signing_url\": \"\",\n \"token_status\": \"used\",\n \"role_type\": \"signer\"\n },\n {\n \"recipient_id\": \"\",\n \"email\": \"\",\n \"name\": \"\",\n \"role\": \"\",\n \"signing_url\": \"\",\n \"token_status\": \"active\",\n \"role_type\": \"approver\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9c076e8-49ab-4048-98d2-e732f9664d90", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "signing-urls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1199db43-f0e4-4e86-9f4d-9e78ab507b9a", "name": "Forbidden (missing `envelopes:read` scope)", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "signing-urls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72dd6f70-ef56-4e23-9eb3-a31e4675b719", "name": "Envelope not found", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "signing-urls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c93e8ec-7856-4ef4-9842-7273abded625", "name": "Envelope is not in `sent` or `in_progress` state", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "signing-urls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "73325de0-7718-4d61-a952-dbcd36b24fe5", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "signing-urls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5988e447-a3d3-46da-9fbf-fde027382c7e", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "envelopes", ":id", "signing-urls" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] }, { "name": "me", "description": "", "item": [ { "id": "8a63faa0-4776-4711-bb23-2b0c3c6bc5fb", "name": "Get key context (partner)", "request": { "name": "Get key context (partner)", "description": { "content": "Returns the user who created the API key, their tenant, the key's\nenvironment (`live` / `sandbox`), and the list of granted scopes.\nUseful for verifying connectivity and debugging scope issues.\n", "type": "text/plain" }, "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "42815ee1-7941-4425-b4d1-b3a56c74e682", "name": "Key context", "originalRequest": { "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": \"\",\n \"email\": \"\",\n \"tenantId\": \"\",\n \"keyId\": \"\",\n \"env\": \"sandbox\",\n \"scopes\": [\n \"\",\n \"\"\n ],\n \"name\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2deb5af9-6731-4caa-85fc-df3f186582f4", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e027c688-8ec9-4a3e-ba56-b2ba8f5612a7", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddc6cf52-accf-4271-8ce0-87879c8a10d0", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea58e78c-788d-46e7-a65e-2372185dbe94", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "me" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "webhooks", "description": "", "item": [ { "id": "76c702d8-9d50-4800-9a74-3f8f344c3551", "name": "List webhook endpoints (partner)", "request": { "name": "List webhook endpoints (partner)", "description": { "content": "Returns all webhook endpoints registered for the tenant, ordered by\ncreation date descending. Requires the `webhooks:read` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "606d253b-aaf8-4e48-abc0-4e28461be7ef", "name": "List of webhook endpoints", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"url\": \"\",\n \"description\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"env\": \"sandbox\",\n \"status\": \"active\",\n \"secret_prefix\": \"\",\n \"secret_hashed_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n },\n {\n \"id\": \"\",\n \"url\": \"\",\n \"description\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"env\": \"live\",\n \"status\": \"active\",\n \"secret_prefix\": \"\",\n \"secret_hashed_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n }\n ],\n \"total\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0414b6da-b2ad-4a7b-a9ba-321188661089", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e847e7da-374f-4c79-ad09-0f1c7f42de8e", "name": "Forbidden (missing `webhooks:read` scope)", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9abdab1-d81a-48a2-862b-bd0cdb6c7f19", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7efaef20-03d6-42ba-a90e-c2d20d0e90ba", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "12af581e-d006-474a-a9b3-8fad2acd868c", "name": "Create webhook endpoint (partner)", "request": { "name": "Create webhook endpoint (partner)", "description": { "content": "Register a new webhook endpoint to receive Permissio domain events.\nThe response includes the plaintext signing secret (`secret` field,\nprefixed `whsec_…`) — store it securely. It is only returned once\nat creation time; delete and recreate the endpoint to change the secret.\n\nUse the secret to verify incoming deliveries: compute\n`HMAC-SHA256(\"${t}.${rawBody}\", secret)` where `t` is the Unix\nseconds from the `Permissio-Signature` header (`t=,v1=`)\nand compare with the `v1` field using constant-time comparison.\n\nRequires the `webhooks:write` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"env\": \"live\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "e8616e77-a54a-44dd-bac7-3e15ae59357f", "name": "Webhook endpoint created", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"env\": \"live\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"created_at\": \"\",\n \"description\": \"\",\n \"env\": \"live\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"secret\": \"\",\n \"secret_hashed_at\": \"\",\n \"secret_prefix\": \"\",\n \"status\": \"paused\",\n \"updated_at\": \"\",\n \"url\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2442ef6b-73b8-4b64-9aa4-b064068c83fa", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"env\": \"live\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "34c48651-b485-456b-a3ad-fa24b83b9bd6", "name": "Plan webhook endpoint limit reached (`webhook_endpoint_limit_exceeded`)", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"env\": \"live\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfd2a09f-0e1d-4689-bc2d-425486947657", "name": "Forbidden (missing `webhooks:write` scope)", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"env\": \"live\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76bf76ad-97b5-4abc-bd53-7c4cf82a0cae", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"env\": \"live\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4eaffe7b-b815-40bf-a08a-823a0b83eacc", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"env\": \"live\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "64a9c0b0-6723-4032-becc-0897f5236375", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"events\": [\n \"\"\n ],\n \"description\": \"\",\n \"env\": \"live\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{id}", "description": "", "item": [ { "id": "c37116ce-261b-48dc-b457-ae4d5caa5dc0", "name": "Get webhook endpoint (partner)", "request": { "name": "Get webhook endpoint (partner)", "description": { "content": "Retrieve a single webhook endpoint. The plaintext secret is **not**\nreturned after creation — use the stored value or rotate it.\nRequires the `webhooks:read` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "1e6554f5-2a62-41a9-a2e9-567a18773480", "name": "Webhook endpoint", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"description\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"env\": \"sandbox\",\n \"status\": \"paused\",\n \"secret_prefix\": \"\",\n \"secret_hashed_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47a6774b-07ce-4f5c-a050-9f456bc16790", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1b247d78-b8a6-43cc-b48d-c531f6e98190", "name": "Forbidden (missing `webhooks:read` scope)", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "97f18f6f-a1a3-416e-930b-7a96954705da", "name": "Endpoint not found", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "720e63c9-babe-4ac7-b5f1-2c901889b7ac", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b37b60c-b6c3-4117-b027-f83a5bad32fb", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6590f008-fdee-4f56-82c3-582a5484ab2e", "name": "Update webhook endpoint (partner)", "request": { "name": "Update webhook endpoint (partner)", "description": { "content": "Update the URL, description, or subscribed event list for a webhook\nendpoint. Fields omitted from the body are left unchanged.\nRequires the `webhooks:write` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"description\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "86e95c94-e013-4921-84fc-ce5292f97f4a", "name": "Updated webhook endpoint", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"description\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"id\": \"\",\n \"url\": \"\",\n \"description\": \"\",\n \"events\": [\n \"\",\n \"\"\n ],\n \"env\": \"sandbox\",\n \"status\": \"paused\",\n \"secret_prefix\": \"\",\n \"secret_hashed_at\": \"\",\n \"created_at\": \"\",\n \"updated_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5266eeb7-0289-4f68-9597-20a5c23abb4b", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"description\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3eaf9944-9fda-4bca-b146-74a062ebdf98", "name": "Forbidden (missing `webhooks:write` scope)", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"description\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bfad5cfd-9ea7-4d44-9fa8-679831424f30", "name": "Endpoint not found", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"description\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ef100b77-689c-4e82-9c3a-0dfcbf3a4d73", "name": "Validation error", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"description\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5acb19d3-d853-485f-a424-3fa9f3fa0d3f", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"description\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7fb62b33-af83-4fe3-b041-0fcc24660138", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"description\": \"\",\n \"events\": [\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "729e4ab5-f324-4b80-a90d-be7e881b418e", "name": "Delete webhook endpoint (partner)", "request": { "name": "Delete webhook endpoint (partner)", "description": { "content": "Permanently remove a webhook endpoint. Any pending deliveries are\nabandoned. This action is irreversible.\nRequires the `webhooks:write` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "ee8a534b-84a8-4d4f-961d-58cfe32e350b", "name": "Endpoint deleted", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "999ee966-627c-4603-8293-71602f8e2dfe", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b926a64-f856-4a8e-89d0-5b9f081cbd29", "name": "Forbidden (missing `webhooks:write` scope)", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3b54b727-a3ce-4659-b0e1-c7fd0375d5a7", "name": "Endpoint not found", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b6f1645b-39c3-484f-881c-4fd196284fa7", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f49b6d7-0c49-46bd-9637-5f5273de925b", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "rotate-secret", "description": "", "item": [ { "id": "b5fb3f0d-561b-4664-9c31-778520699efb", "name": "Rotate webhook signing secret (partner)", "request": { "name": "Rotate webhook signing secret (partner)", "description": { "content": "Generate a new signing secret for the webhook endpoint and immediately\ninvalidate the old one. The new plaintext secret (`whsec_…`) is returned\nexactly once in the response — store it securely.\n\nAfter rotation, update your verification logic to use the new secret.\nAny delivery signed with the previous secret will fail HMAC verification.\n\nSandbox keys can only rotate sandbox endpoints; live keys can only rotate\nlive endpoints. Mismatches are rejected with `403 env_mismatch`.\n\nRequires the `webhooks:write` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "d611b246-0304-4c1a-9071-ae544ad89682", "name": "New signing secret", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"secret\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c33df4b8-4e23-4b38-a3d3-498533832a7c", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c5a210cc-52f2-4042-bd57-c8f111dc7ed5", "name": "Forbidden (missing `webhooks:write` scope or env mismatch)", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "808a7a97-f82f-4ee6-806a-5466817e5ab9", "name": "Endpoint not found", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cdfe4696-7e7c-48fd-a0ba-80bf24fbba45", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0a13bde8-88b3-4c81-9ce2-e7502d1cc50c", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "rotate-secret" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "test", "description": "", "item": [ { "id": "b6e37763-8a6a-4ad6-bbec-0801f45b1a90", "name": "Send a test event to a webhook endpoint (partner)", "request": { "name": "Send a test event to a webhook endpoint (partner)", "description": { "content": "Fire a synthetic sandbox delivery against the specified endpoint to\nverify your HMAC verification logic, inspect the payload shape, and\nconfirm delivery before wiring up real signing workflows.\n\n**Key differences from a real delivery:**\n- The delivery row is always flagged `env: \"sandbox\"` regardless of\n the endpoint's configured environment — receivers can filter test\n traffic with `event.env === \"sandbox\"`.\n- Subscription filtering is bypassed: the endpoint receives the test\n event even if it is not subscribed to that event name.\n- No real envelope or template is touched.\n\n**Payload is returned synchronously** in the response so you can verify\nyour HMAC locally without waiting for the HTTP callback:\n1. Extract `t` and `v1` from `Permissio-Signature: t=,v1=`.\n2. Compute `HMAC-SHA256(\"${t}.${JSON.stringify(payload)}\", secret)`.\n3. Compare (constant-time) with `v1`.\n\nRequires the `webhooks:write` scope.\n\nSandbox keys can only test sandbox endpoints; live keys can only test\nlive endpoints. Mismatches are rejected with `403 env_mismatch`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"data\": {\n \"key_0\": 6326,\n \"key_1\": 1846.1104553477714,\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "3fd682e8-bde9-4471-a51c-ce8785fccfab", "name": "Test delivery enqueued; returns the delivery id and full signed payload", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"data\": {\n \"key_0\": 6326,\n \"key_1\": 1846.1104553477714,\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"delivery_id\": \"\",\n \"payload\": {\n \"key_0\": true\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32fcc36f-d040-46e6-9f3f-ab66f03044a6", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"data\": {\n \"key_0\": 6326,\n \"key_1\": 1846.1104553477714,\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "435dc32c-eff4-4e5c-ac09-ac3b185e1fcd", "name": "Forbidden (missing `webhooks:write` scope or env mismatch)", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"data\": {\n \"key_0\": 6326,\n \"key_1\": 1846.1104553477714,\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cad042e9-9375-4cdc-9b43-536fabc85ff4", "name": "Endpoint not found", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"data\": {\n \"key_0\": 6326,\n \"key_1\": 1846.1104553477714,\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "086567dd-d996-4045-8132-a19ad7ac2a4d", "name": "Validation error (unknown event name or wildcard)", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"data\": {\n \"key_0\": 6326,\n \"key_1\": 1846.1104553477714,\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39582e52-ca85-439e-9a47-ce3c162777ac", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"data\": {\n \"key_0\": 6326,\n \"key_1\": 1846.1104553477714,\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9e6607a2-c8f1-4afa-8cb9-1b43ae085d1b", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"event\": \"\",\n \"data\": {\n \"key_0\": 6326,\n \"key_1\": 1846.1104553477714,\n \"key_2\": \"string\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "deliveries", "description": "", "item": [ { "id": "64392bea-a309-4929-99fb-b5db73835f62", "name": "List webhook deliveries (partner)", "request": { "name": "List webhook deliveries (partner)", "description": { "content": "Returns a paginated list of delivery records for the specified webhook\nendpoint, ordered by `created_at` descending. Optionally filter by\n`status`. Requires the `webhooks:read` scope.\n\nTenant isolation and sandbox/live environment separation are enforced:\na live API key cannot list deliveries for a sandbox endpoint and vice versa.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter deliveries by status. Valid values: `pending`, `in_progress`,\n`succeeded`, `failed`, `dead_lettered`.\n (This can only be one of pending,in_progress,succeeded,failed,dead_lettered)", "type": "text/plain" }, "key": "status", "value": "in_progress" }, { "disabled": false, "description": { "content": "Maximum number of records to return (1–100, default 20).", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "c4003526-c7c3-49b7-a1a4-9d1efdded067", "name": "Paginated list of delivery records", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter deliveries by status. Valid values: `pending`, `in_progress`,\n`succeeded`, `failed`, `dead_lettered`.\n (This can only be one of pending,in_progress,succeeded,failed,dead_lettered)", "type": "text/plain" }, "key": "status", "value": "in_progress" }, { "disabled": false, "description": { "content": "Maximum number of records to return (1–100, default 20).", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"items\": [\n {\n \"id\": \"\",\n \"event_name\": \"\",\n \"event_id\": \"\",\n \"status\": \"succeeded\",\n \"attempt_count\": \"\",\n \"created_at\": \"\",\n \"completed_at\": \"\",\n \"next_attempt_at\": \"\"\n },\n {\n \"id\": \"\",\n \"event_name\": \"\",\n \"event_id\": \"\",\n \"status\": \"dead_lettered\",\n \"attempt_count\": \"\",\n \"created_at\": \"\",\n \"completed_at\": \"\",\n \"next_attempt_at\": \"\"\n }\n ],\n \"next_cursor\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b21c061-307b-416f-94f7-5ff0bec63941", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter deliveries by status. Valid values: `pending`, `in_progress`,\n`succeeded`, `failed`, `dead_lettered`.\n (This can only be one of pending,in_progress,succeeded,failed,dead_lettered)", "type": "text/plain" }, "key": "status", "value": "in_progress" }, { "disabled": false, "description": { "content": "Maximum number of records to return (1–100, default 20).", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5c26ab5f-c8b2-47ae-b474-7ef05f4a606c", "name": "Forbidden (missing `webhooks:read` scope or env mismatch)", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter deliveries by status. Valid values: `pending`, `in_progress`,\n`succeeded`, `failed`, `dead_lettered`.\n (This can only be one of pending,in_progress,succeeded,failed,dead_lettered)", "type": "text/plain" }, "key": "status", "value": "in_progress" }, { "disabled": false, "description": { "content": "Maximum number of records to return (1–100, default 20).", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9af9655a-7eaf-4c4b-8ffb-52d602bce86b", "name": "Endpoint not found", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter deliveries by status. Valid values: `pending`, `in_progress`,\n`succeeded`, `failed`, `dead_lettered`.\n (This can only be one of pending,in_progress,succeeded,failed,dead_lettered)", "type": "text/plain" }, "key": "status", "value": "in_progress" }, { "disabled": false, "description": { "content": "Maximum number of records to return (1–100, default 20).", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8edd1ed3-eda5-4c3d-8096-9b660aa44d85", "name": "Invalid status filter value", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter deliveries by status. Valid values: `pending`, `in_progress`,\n`succeeded`, `failed`, `dead_lettered`.\n (This can only be one of pending,in_progress,succeeded,failed,dead_lettered)", "type": "text/plain" }, "key": "status", "value": "in_progress" }, { "disabled": false, "description": { "content": "Maximum number of records to return (1–100, default 20).", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ccdb0691-86e7-4cfd-9c1b-4c1045228fe1", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter deliveries by status. Valid values: `pending`, `in_progress`,\n`succeeded`, `failed`, `dead_lettered`.\n (This can only be one of pending,in_progress,succeeded,failed,dead_lettered)", "type": "text/plain" }, "key": "status", "value": "in_progress" }, { "disabled": false, "description": { "content": "Maximum number of records to return (1–100, default 20).", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13255196-6c50-4c42-9795-c73f38a4c016", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Filter deliveries by status. Valid values: `pending`, `in_progress`,\n`succeeded`, `failed`, `dead_lettered`.\n (This can only be one of pending,in_progress,succeeded,failed,dead_lettered)", "type": "text/plain" }, "key": "status", "value": "in_progress" }, { "disabled": false, "description": { "content": "Maximum number of records to return (1–100, default 20).", "type": "text/plain" }, "key": "limit", "value": "20" }, { "disabled": false, "description": { "content": "Opaque pagination cursor returned as `next_cursor` from a previous\nresponse. Pass it to fetch the next page of results.\n", "type": "text/plain" }, "key": "cursor", "value": "" } ], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "{deliveryId}", "description": "", "item": [ { "id": "a372b213-362a-46fc-accd-12fd30f73cdc", "name": "Get webhook delivery detail (partner)", "request": { "name": "Get webhook delivery detail (partner)", "description": { "content": "Retrieve a single delivery record plus its full attempt history (HTTP\nstatus codes, latency, response snippet, error message, and timestamp\nfor each attempt). Attempts are ordered by `attempt_number` ascending.\n\nRequires the `webhooks:read` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "deliveryId", "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "741a37aa-0ce5-46ff-b16e-1ad498be7017", "name": "Delivery detail with attempt history", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" }, "type": "any", "value": "", "key": "deliveryId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"attempt_count\": \"\",\n \"attempts\": [\n {\n \"id\": \"\",\n \"attempt_number\": \"\",\n \"status_code\": \"\",\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error\": \"\",\n \"attempted_at\": \"\"\n },\n {\n \"id\": \"\",\n \"attempt_number\": \"\",\n \"status_code\": \"\",\n \"response_body_snippet\": \"\",\n \"latency_ms\": \"\",\n \"error\": \"\",\n \"attempted_at\": \"\"\n }\n ],\n \"completed_at\": \"\",\n \"created_at\": \"\",\n \"event_id\": \"\",\n \"event_name\": \"\",\n \"id\": \"\",\n \"next_attempt_at\": \"\",\n \"status\": \"dead_lettered\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "938fa811-904b-46c7-a290-d87376945ebf", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" }, "type": "any", "value": "", "key": "deliveryId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f11ce16d-941f-41ab-960c-3501ea1f1458", "name": "Forbidden (missing `webhooks:read` scope or env mismatch)", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" }, "type": "any", "value": "", "key": "deliveryId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9e6a4ac-ea32-41c1-a29b-751b9efe5f4a", "name": "Endpoint or delivery not found", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" }, "type": "any", "value": "", "key": "deliveryId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48e05e25-5909-4e5a-8fac-fa7bef2d1c79", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" }, "type": "any", "value": "", "key": "deliveryId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0f1cf294-df41-429a-8a9f-3808f185d2ac", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" }, "type": "any", "value": "", "key": "deliveryId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "retry", "description": "", "item": [ { "id": "7b4bb62c-526e-45f3-a61a-e719c4f76483", "name": "Retry a failed webhook delivery (partner)", "request": { "name": "Retry a failed webhook delivery (partner)", "description": { "content": "Re-enqueues a `failed` or `dead_lettered` delivery for immediate retry.\nThe delivery status is reset to `pending` and a new attempt is scheduled.\n\nReturns `409 not_terminal` if the delivery is not in a terminal state\n(`pending`, `in_progress`, or `succeeded` deliveries cannot be retried).\n\nRequires the `webhooks:write` scope.\n", "type": "text/plain" }, "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } }, { "type": "any", "value": "", "key": "deliveryId", "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}" } ] } }, "response": [ { "id": "846482ca-414d-40f9-828a-81504f15a703", "name": "Delivery re-enqueued; returns the updated delivery record", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" }, "type": "any", "value": "", "key": "deliveryId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"id\": \"\",\n \"event_name\": \"\",\n \"event_id\": \"\",\n \"status\": \"failed\",\n \"attempt_count\": \"\",\n \"created_at\": \"\",\n \"completed_at\": \"\",\n \"next_attempt_at\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f77d1577-ab13-4a05-aa85-109d10abd184", "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" }, "type": "any", "value": "", "key": "deliveryId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ed29fd64-1858-4438-b9c6-84a0ac307e54", "name": "Forbidden (missing `webhooks:write` scope or env mismatch)", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" }, "type": "any", "value": "", "key": "deliveryId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e434396f-0dea-4012-a81f-4c25083f2b06", "name": "Endpoint or delivery not found", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" }, "type": "any", "value": "", "key": "deliveryId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9eb46bf1-fb5a-414f-8886-21e6c2ff6a3c", "name": "Delivery is not in a terminal state (`not_terminal` code). Only\n`failed` or `dead_lettered` deliveries may be retried.", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" }, "type": "any", "value": "", "key": "deliveryId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f123f511-c295-4507-ab30-a0b24cf32fe0", "name": "Rate limit exceeded", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" }, "type": "any", "value": "", "key": "deliveryId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dc5ec570-902e-4124-867e-77670500664d", "name": "Error", "originalRequest": { "url": { "path": [ "v1", "webhooks", ":id", "deliveries", ":deliveryId", "retry" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" }, { "disabled": false, "description": { "content": "(Required) Delivery ID (`whd_…`)", "type": "text/plain" }, "type": "any", "value": "", "key": "deliveryId" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Limit", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Remaining", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-RateLimit-Reset", "value": "" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\",\n \"request_id\": \"\",\n \"details\": {\n \"key_0\": 3705.4779512310397\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ] } ] } ] } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.permissio.us" }, { "key": "apiKey", "value": "", "type": "string" } ], "info": { "_postman_id": "41157455-911d-4049-b34f-9190577b7701", "name": "Permissio Partner API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Official Postman collection for the Permissio Partner API. Set the {{apiKey}} variable to your sk_test_… (sandbox) or sk_live_… (live) key; {{baseUrl}} defaults to https://api.permissio.us." }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] } }