{ "info": { "_postman_id": "5327dd41-5ee3-4a33-8e57-b74371a973f6", "name": "Clerk Backend Account Portal Instance Settings API", "description": "The Clerk REST Backend API, meant to be accessed by backend servers.\n\n### Versions\n\nWhen the API changes in a way that isn't compatible with older versions, a new version is released.\nEach version is identified by its release date, e.g. `2025-04-10`. For more information, please see [Clerk API Versions](https://clerk.com/docs/versioning/available-versions).\n\nPlease see https://clerk.com/docs for more information.\n\nContact Support:\n Name: Clerk Platform Team\n Email: support@clerk.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "lastUpdatedBy": "35240", "uid": "35240-5327dd41-5ee3-4a33-8e57-b74371a973f6" }, "item": [ { "name": "instance", "item": [ { "name": "restrictions", "item": [ { "name": "Update Instance Restrictions", "id": "1791acc7-038d-4e99-95e1-734d468f21c0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"allowlist\": \"\",\n \"blocklist\": \"\",\n \"allowlist_blocklist_disabled_on_sign_in\": \"\",\n \"block_email_subaddresses\": \"\",\n \"block_disposable_email_domains\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/restrictions", "host": [ "{{baseUrl}}" ], "path": [ "instance", "restrictions" ] }, "description": "Updates the restriction settings of an instance" }, "response": [ { "id": "824ee048-7c75-4f5f-adad-1f0ac24f27de", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"allowlist\": \"\",\n \"blocklist\": \"\",\n \"allowlist_blocklist_disabled_on_sign_in\": \"\",\n \"block_email_subaddresses\": \"\",\n \"block_disposable_email_domains\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/restrictions", "host": [ "{{baseUrl}}" ], "path": [ "instance", "restrictions" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"instance_restrictions\",\n \"allowlist\": \"\",\n \"blocklist\": \"\",\n \"allowlist_blocklist_disabled_on_sign_in\": \"\",\n \"block_email_subaddresses\": \"\",\n \"block_disposable_email_domains\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-824ee048-7c75-4f5f-adad-1f0ac24f27de" }, { "id": "61c6e6a8-d73e-4a38-8863-99126ef9986b", "name": "Payment required", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"allowlist\": \"\",\n \"blocklist\": \"\",\n \"allowlist_blocklist_disabled_on_sign_in\": \"\",\n \"block_email_subaddresses\": \"\",\n \"block_disposable_email_domains\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/restrictions", "host": [ "{{baseUrl}}" ], "path": [ "instance", "restrictions" ] } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-61c6e6a8-d73e-4a38-8863-99126ef9986b" }, { "id": "0edf1dc8-251c-4d54-9d6d-162da50856f5", "name": "Invalid request parameters", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"allowlist\": \"\",\n \"blocklist\": \"\",\n \"allowlist_blocklist_disabled_on_sign_in\": \"\",\n \"block_email_subaddresses\": \"\",\n \"block_disposable_email_domains\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/restrictions", "host": [ "{{baseUrl}}" ], "path": [ "instance", "restrictions" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-0edf1dc8-251c-4d54-9d6d-162da50856f5" } ], "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-1791acc7-038d-4e99-95e1-734d468f21c0" } ], "id": "5411c69f-895e-426c-92b2-92d220e0df04", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-5411c69f-895e-426c-92b2-92d220e0df04" }, { "name": "protect", "item": [ { "name": "Get Instance Protect Settings", "id": "1b39ffdb-ff87-43e1-8be9-11943b346b81", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instance/protect", "host": [ "{{baseUrl}}" ], "path": [ "instance", "protect" ] } }, "response": [ { "id": "e54f12e1-b01c-4745-9c35-e67e8deba702", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/instance/protect", "host": [ "{{baseUrl}}" ], "path": [ "instance", "protect" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"instance_protect\",\n \"rules_enabled\": \"\",\n \"specter_enabled\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-e54f12e1-b01c-4745-9c35-e67e8deba702" } ], "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-1b39ffdb-ff87-43e1-8be9-11943b346b81" }, { "name": "Update Instance Protect Settings", "id": "0a62c6be-5913-4a1d-8112-9b8781e88a08", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"rules_enabled\": \"\",\n \"specter_enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/protect", "host": [ "{{baseUrl}}" ], "path": [ "instance", "protect" ] } }, "response": [ { "id": "54a8aaeb-6332-4648-bcb6-ef3a6214704c", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"rules_enabled\": \"\",\n \"specter_enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/protect", "host": [ "{{baseUrl}}" ], "path": [ "instance", "protect" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"instance_protect\",\n \"rules_enabled\": \"\",\n \"specter_enabled\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-54a8aaeb-6332-4648-bcb6-ef3a6214704c" }, { "id": "f3d2c505-06ea-4dd0-aa27-6f9671256cab", "name": "Invalid request parameters", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"rules_enabled\": \"\",\n \"specter_enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/protect", "host": [ "{{baseUrl}}" ], "path": [ "instance", "protect" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-f3d2c505-06ea-4dd0-aa27-6f9671256cab" } ], "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-0a62c6be-5913-4a1d-8112-9b8781e88a08" } ], "id": "4ede72f7-9116-4237-8c1b-22bf064036ca", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-4ede72f7-9116-4237-8c1b-22bf064036ca" }, { "name": "communication", "item": [ { "name": "Get Instance Communication Settings", "id": "5df57340-e9a8-4092-91f7-55d031fd09d8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instance/communication", "host": [ "{{baseUrl}}" ], "path": [ "instance", "communication" ] }, "description": "Retrieves the per-instance SMS communication settings, including the SMS country blocklist." }, "response": [ { "id": "a1de4e72-f985-442b-87d8-8fa0061c7008", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/instance/communication", "host": [ "{{baseUrl}}" ], "path": [ "instance", "communication" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"instance_communication\",\n \"blocked_country_codes\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-a1de4e72-f985-442b-87d8-8fa0061c7008" } ], "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-5df57340-e9a8-4092-91f7-55d031fd09d8" }, { "name": "Update Instance Communication Settings", "id": "e9c6086a-ffb3-469d-899e-8b434b6c0c4b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"blocked_country_codes\": [\n \"MT\",\n \"LI\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/communication", "host": [ "{{baseUrl}}" ], "path": [ "instance", "communication" ] }, "description": "Replaces the SMS country blocklist for this instance. Pass the full set of ISO 3166-1\nalpha-2 country codes that should be blocked; codes that aren't recognized as SMS-tier\ncountries are silently dropped from the persisted list. Omitting `blocked_country_codes`\nis a no-op.\n" }, "response": [ { "id": "80a99afc-def6-4f18-bd3c-37d4fbad6f09", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"blocked_country_codes\": [\n \"MT\",\n \"LI\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/communication", "host": [ "{{baseUrl}}" ], "path": [ "instance", "communication" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"instance_communication\",\n \"blocked_country_codes\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-80a99afc-def6-4f18-bd3c-37d4fbad6f09" }, { "id": "76cf0ad3-e297-412e-80a2-9776dab873b6", "name": "Invalid request parameters", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"blocked_country_codes\": [\n \"MT\",\n \"LI\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/communication", "host": [ "{{baseUrl}}" ], "path": [ "instance", "communication" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-76cf0ad3-e297-412e-80a2-9776dab873b6" } ], "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-e9c6086a-ffb3-469d-899e-8b434b6c0c4b" } ], "id": "67d76f4f-859e-428e-a3ae-bd11b67e4d88", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-67d76f4f-859e-428e-a3ae-bd11b67e4d88" }, { "name": "oauth_application_settings", "item": [ { "name": "Get OAuth Application Settings", "id": "1669c6cf-d8c8-412b-bd60-16bd7d68bd33", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instance/oauth_application_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "oauth_application_settings" ] }, "description": "Retrieves the settings for OAuth applications for the instance (dynamic client registration, JWT access tokens, etc.)." }, "response": [ { "id": "c6faa3a8-f89b-4071-b977-6cfea148cee6", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/instance/oauth_application_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "oauth_application_settings" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"oauth_application_settings\",\n \"dynamic_oauth_client_registration\": \"\",\n \"oauth_jwt_access_tokens\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-c6faa3a8-f89b-4071-b977-6cfea148cee6" } ], "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-1669c6cf-d8c8-412b-bd60-16bd7d68bd33" }, { "name": "Update OAuth Application Settings", "id": "1a9bb569-3170-49cb-8063-0ef6776210dd", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"dynamic_oauth_client_registration\": \"\",\n \"oauth_jwt_access_tokens\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/oauth_application_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "oauth_application_settings" ] }, "description": "Updates the OAuth application settings for the instance." }, "response": [ { "id": "6aaaa04a-bd48-4237-a84f-63b15771a3e4", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"dynamic_oauth_client_registration\": \"\",\n \"oauth_jwt_access_tokens\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/oauth_application_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "oauth_application_settings" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"oauth_application_settings\",\n \"dynamic_oauth_client_registration\": \"\",\n \"oauth_jwt_access_tokens\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-6aaaa04a-bd48-4237-a84f-63b15771a3e4" }, { "id": "cfed933b-e8ae-4d64-8917-2121b978c9db", "name": "Invalid request parameters", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"dynamic_oauth_client_registration\": \"\",\n \"oauth_jwt_access_tokens\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/oauth_application_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "oauth_application_settings" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-cfed933b-e8ae-4d64-8917-2121b978c9db" } ], "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-1a9bb569-3170-49cb-8063-0ef6776210dd" } ], "id": "a74026e3-9659-4ccc-a65d-f364c583a119", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-a74026e3-9659-4ccc-a65d-f364c583a119" }, { "name": "organization_settings", "item": [ { "name": "Get Instance Organization Settings", "id": "c2e74e90-532b-4393-acfa-0694955d3850", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instance/organization_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "organization_settings" ] }, "description": "Retrieves the organization settings of the instance" }, "response": [ { "id": "1b8e43aa-dfab-4346-9ac8-ee4de4304efe", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/instance/organization_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "organization_settings" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"organization_settings\",\n \"enabled\": \"\",\n \"max_allowed_memberships\": \"\",\n \"max_allowed_roles\": \"\",\n \"max_allowed_domains\": \"\",\n \"creator_role\": \"\",\n \"admin_delete_enabled\": \"\",\n \"domains_enabled\": \"\",\n \"domains_enrollment_modes\": [\n \"automatic_invitation\",\n \"automatic_invitation\"\n ],\n \"domains_default_role\": \"\",\n \"max_role_sets_allowed\": \"\",\n \"max_allowed_permissions\": \"\",\n \"slug_disabled\": \"\",\n \"initial_role_set_key\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-1b8e43aa-dfab-4346-9ac8-ee4de4304efe" }, { "id": "b117821a-6c9a-4222-ab6a-185daf32b38d", "name": "Payment required", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/instance/organization_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "organization_settings" ] } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-b117821a-6c9a-4222-ab6a-185daf32b38d" }, { "id": "f5700be4-210e-4a15-912c-8fcda021e595", "name": "Resource not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/instance/organization_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "organization_settings" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-f5700be4-210e-4a15-912c-8fcda021e595" }, { "id": "458030c9-772b-45c5-b69c-9ca63199e444", "name": "Invalid request parameters", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/instance/organization_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "organization_settings" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-458030c9-772b-45c5-b69c-9ca63199e444" } ], "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-c2e74e90-532b-4393-acfa-0694955d3850" }, { "name": "Update Instance Organization Settings", "id": "752ab3b8-f99d-4be1-baa5-d5cdd7054458", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\",\n \"max_allowed_memberships\": \"\",\n \"admin_delete_enabled\": \"\",\n \"domains_enabled\": \"\",\n \"slug_disabled\": \"\",\n \"domains_enrollment_modes\": [\n \"\",\n \"\"\n ],\n \"creator_role_id\": \"\",\n \"domains_default_role_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/organization_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "organization_settings" ] }, "description": "Updates the organization settings of the instance" }, "response": [ { "id": "eba1b76f-39bf-47f2-8f23-b3be65f6933f", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\",\n \"max_allowed_memberships\": \"\",\n \"admin_delete_enabled\": \"\",\n \"domains_enabled\": \"\",\n \"slug_disabled\": \"\",\n \"domains_enrollment_modes\": [\n \"\",\n \"\"\n ],\n \"creator_role_id\": \"\",\n \"domains_default_role_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/organization_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "organization_settings" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"organization_settings\",\n \"enabled\": \"\",\n \"max_allowed_memberships\": \"\",\n \"max_allowed_roles\": \"\",\n \"max_allowed_domains\": \"\",\n \"creator_role\": \"\",\n \"admin_delete_enabled\": \"\",\n \"domains_enabled\": \"\",\n \"domains_enrollment_modes\": [\n \"automatic_invitation\",\n \"automatic_invitation\"\n ],\n \"domains_default_role\": \"\",\n \"max_role_sets_allowed\": \"\",\n \"max_allowed_permissions\": \"\",\n \"slug_disabled\": \"\",\n \"initial_role_set_key\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-eba1b76f-39bf-47f2-8f23-b3be65f6933f" }, { "id": "32d1be7f-a782-41bc-9e48-dd26bcd0a5b7", "name": "Request was not successful", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\",\n \"max_allowed_memberships\": \"\",\n \"admin_delete_enabled\": \"\",\n \"domains_enabled\": \"\",\n \"slug_disabled\": \"\",\n \"domains_enrollment_modes\": [\n \"\",\n \"\"\n ],\n \"creator_role_id\": \"\",\n \"domains_default_role_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/organization_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "organization_settings" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-32d1be7f-a782-41bc-9e48-dd26bcd0a5b7" }, { "id": "6bad5b7b-ad08-4fdd-a169-ba64a14d8caf", "name": "Payment required", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\",\n \"max_allowed_memberships\": \"\",\n \"admin_delete_enabled\": \"\",\n \"domains_enabled\": \"\",\n \"slug_disabled\": \"\",\n \"domains_enrollment_modes\": [\n \"\",\n \"\"\n ],\n \"creator_role_id\": \"\",\n \"domains_default_role_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/organization_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "organization_settings" ] } }, "status": "Payment Required", "code": 402, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-6bad5b7b-ad08-4fdd-a169-ba64a14d8caf" }, { "id": "a1d43c96-3aaf-430d-b3e3-bbabd3de59a3", "name": "Resource not found", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\",\n \"max_allowed_memberships\": \"\",\n \"admin_delete_enabled\": \"\",\n \"domains_enabled\": \"\",\n \"slug_disabled\": \"\",\n \"domains_enrollment_modes\": [\n \"\",\n \"\"\n ],\n \"creator_role_id\": \"\",\n \"domains_default_role_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/organization_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "organization_settings" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-a1d43c96-3aaf-430d-b3e3-bbabd3de59a3" }, { "id": "1c0d948a-174b-4a5b-a710-a90bb8cab574", "name": "Invalid request parameters", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\",\n \"max_allowed_memberships\": \"\",\n \"admin_delete_enabled\": \"\",\n \"domains_enabled\": \"\",\n \"slug_disabled\": \"\",\n \"domains_enrollment_modes\": [\n \"\",\n \"\"\n ],\n \"creator_role_id\": \"\",\n \"domains_default_role_id\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance/organization_settings", "host": [ "{{baseUrl}}" ], "path": [ "instance", "organization_settings" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-1c0d948a-174b-4a5b-a710-a90bb8cab574" } ], "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-752ab3b8-f99d-4be1-baa5-d5cdd7054458" } ], "id": "f126ffcc-86ab-462e-a96e-303dec727607", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-f126ffcc-86ab-462e-a96e-303dec727607" }, { "name": "Fetch the Current Instance", "id": "080808f8-d09b-49f4-806b-0aaa5fd99843", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/instance", "host": [ "{{baseUrl}}" ], "path": [ "instance" ] }, "description": "Fetches the current instance" }, "response": [ { "id": "957a1273-71cd-41ae-ad21-85cf85e734c2", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/instance", "host": [ "{{baseUrl}}" ], "path": [ "instance" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"object\": \"instance\",\n \"id\": \"\",\n \"environment_type\": \"\",\n \"allowed_origins\": [\n \"\",\n \"\"\n ]\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-957a1273-71cd-41ae-ad21-85cf85e734c2" } ], "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-080808f8-d09b-49f4-806b-0aaa5fd99843" }, { "name": "Update Instance Settings", "id": "0d3ced12-50d2-4fbe-8d05-87f9c5ab84b2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"test_mode\": \"\",\n \"hibp\": \"\",\n \"support_email\": \"\",\n \"clerk_js_version\": \"\",\n \"development_origin\": \"\",\n \"allowed_origins\": [\n \"\",\n \"\"\n ],\n \"cookieless_dev\": \"\",\n \"url_based_session_syncing\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance", "host": [ "{{baseUrl}}" ], "path": [ "instance" ] }, "description": "Updates the settings of an instance" }, "response": [ { "id": "0ab47fec-e450-4698-92da-2ddc8b937db3", "name": "Accepted", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"test_mode\": \"\",\n \"hibp\": \"\",\n \"support_email\": \"\",\n \"clerk_js_version\": \"\",\n \"development_origin\": \"\",\n \"allowed_origins\": [\n \"\",\n \"\"\n ],\n \"cookieless_dev\": \"\",\n \"url_based_session_syncing\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance", "host": [ "{{baseUrl}}" ], "path": [ "instance" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-0ab47fec-e450-4698-92da-2ddc8b937db3" }, { "id": "75b3279a-9c3c-46e4-bc8e-05220f704f70", "name": "Invalid request parameters", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"test_mode\": \"\",\n \"hibp\": \"\",\n \"support_email\": \"\",\n \"clerk_js_version\": \"\",\n \"development_origin\": \"\",\n \"allowed_origins\": [\n \"\",\n \"\"\n ],\n \"cookieless_dev\": \"\",\n \"url_based_session_syncing\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/instance", "host": [ "{{baseUrl}}" ], "path": [ "instance" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n },\n {\n \"message\": \"\",\n \"long_message\": \"\",\n \"code\": \"\",\n \"meta\": {}\n }\n ],\n \"meta\": {},\n \"clerk_trace_id\": \"\"\n}", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-75b3279a-9c3c-46e4-bc8e-05220f704f70" } ], "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-0d3ced12-50d2-4fbe-8d05-87f9c5ab84b2" } ], "id": "d06d5fc7-25b5-4c20-850b-a01874dec955", "createdAt": "2026-07-28T01:23:25.000Z", "updatedAt": "2026-07-28T01:23:25.000Z", "uid": "35240-d06d5fc7-25b5-4c20-850b-a01874dec955" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.clerk.com/v1" } ] }