{ "info": { "_postman_id": "5af26875-fff9-431d-b337-678831d5f790", "name": "Dub Analytics Partners API", "description": "Dub is the modern link attribution platform for short links, conversion tracking, and affiliate programs.\n\nContact Support:\n Name: Dub Support\n Email: support@dub.co", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "lastUpdatedBy": "35240", "uid": "35240-5af26875-fff9-431d-b337-678831d5f790" }, "item": [ { "name": "partners", "item": [ { "name": "links", "item": [ { "name": "upsert", "item": [ { "name": "Upsert a link for a partner", "id": "c6cc511a-05fe-4685-aa14-ae9e400c59f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links/upsert", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links", "upsert" ] }, "description": "Upsert a link for a partner that is enrolled in your program. If a link with the same URL already exists, return it (or update it if there are any changes). Otherwise, a new link will be created." }, "response": [ { "id": "f3675065-f41b-40be-871a-c8c978042012", "name": "The upserted partner link", "originalRequest": { "method": "PUT", "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 \"url\": \"\",\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links/upsert", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links", "upsert" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"domain\": \"\",\n \"key\": \"\",\n \"url\": \"\",\n \"trackConversion\": false,\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"programId\": \"\",\n \"partnerId\": \"\",\n \"archived\": false,\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"disabledAt\": \"\",\n \"password\": \"\",\n \"proxy\": false,\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": false,\n \"doIndex\": false,\n \"ios\": \"\",\n \"android\": \"\",\n \"geo\": {\n \"dolore_341\": \"\",\n \"anim_0\": \"\"\n },\n \"publicStats\": false,\n \"tags\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"blue\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"blue\"\n }\n ],\n \"folderId\": \"\",\n \"webhookIds\": [\n \"\",\n \"\"\n ],\n \"comments\": \"\",\n \"shortLink\": \"\",\n \"qrCode\": \"\",\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"userId\": \"\",\n \"workspaceId\": \"\",\n \"clicks\": 0,\n \"leads\": 0,\n \"conversions\": 0,\n \"sales\": 0,\n \"saleAmount\": 0,\n \"lastClicked\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"tagId\": \"\",\n \"projectId\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-f3675065-f41b-40be-871a-c8c978042012" }, { "id": "f725eb91-5ecc-4df1-899c-e3b65b749d31", "name": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).", "originalRequest": { "method": "PUT", "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 \"url\": \"\",\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links/upsert", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links", "upsert" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"bad_request\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-f725eb91-5ecc-4df1-899c-e3b65b749d31" }, { "id": "cc03bc3f-68a2-4fc5-8ddc-1b60327e470f", "name": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.", "originalRequest": { "method": "PUT", "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 \"url\": \"\",\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links/upsert", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links", "upsert" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unauthorized\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-cc03bc3f-68a2-4fc5-8ddc-1b60327e470f" }, { "id": "cdac68b6-5fb5-46e6-bb08-b68e55f885aa", "name": "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.", "originalRequest": { "method": "PUT", "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 \"url\": \"\",\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links/upsert", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links", "upsert" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"forbidden\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-cdac68b6-5fb5-46e6-bb08-b68e55f885aa" }, { "id": "a652acc6-3460-4974-8146-f6b5ad7f512f", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "PUT", "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 \"url\": \"\",\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links/upsert", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links", "upsert" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-a652acc6-3460-4974-8146-f6b5ad7f512f" }, { "id": "3183e5e2-df13-46f6-8fc6-5614356f11b6", "name": "This response is sent when a request conflicts with the current state of the server.", "originalRequest": { "method": "PUT", "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 \"url\": \"\",\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links/upsert", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links", "upsert" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"conflict\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-3183e5e2-df13-46f6-8fc6-5614356f11b6" }, { "id": "53baac16-52dc-47d3-bd8a-0357c8e70d6d", "name": "This response is sent when the requested content has been permanently deleted from server, with no forwarding address.", "originalRequest": { "method": "PUT", "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 \"url\": \"\",\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links/upsert", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links", "upsert" ] } }, "status": "Gone", "code": 410, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"invite_expired\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-53baac16-52dc-47d3-bd8a-0357c8e70d6d" }, { "id": "190820c1-4876-47b6-ba87-6a2cce885bf8", "name": "The request was well-formed but was unable to be followed due to semantic errors.", "originalRequest": { "method": "PUT", "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 \"url\": \"\",\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links/upsert", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links", "upsert" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unprocessable_entity\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-190820c1-4876-47b6-ba87-6a2cce885bf8" }, { "id": "1ad17c91-f342-4102-9128-971fe31f6d7b", "name": "The user has sent too many requests in a given amount of time (\"rate limiting\")", "originalRequest": { "method": "PUT", "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 \"url\": \"\",\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links/upsert", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links", "upsert" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-1ad17c91-f342-4102-9128-971fe31f6d7b" }, { "id": "625fa7de-9f68-482a-863b-50747aff2229", "name": "The server has encountered a situation it does not know how to handle.", "originalRequest": { "method": "PUT", "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 \"url\": \"\",\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links/upsert", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links", "upsert" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"internal_server_error\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-625fa7de-9f68-482a-863b-50747aff2229" } ], "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-c6cc511a-05fe-4685-aa14-ae9e400c59f5" } ], "id": "ec1cda37-fbe9-43d4-a245-7f3b33f145be", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-ec1cda37-fbe9-43d4-a245-7f3b33f145be" }, { "name": "Create a link for a partner", "id": "21126f95-fee2-4e2c-be28-d0fbe59c8e7a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"url\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ] }, "description": "Create a link for a partner that is enrolled in your program." }, "response": [ { "id": "478a4a1d-180c-4a27-ade4-0f9c6afaffda", "name": "The created partner link", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"url\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"domain\": \"\",\n \"key\": \"\",\n \"url\": \"\",\n \"trackConversion\": false,\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"programId\": \"\",\n \"partnerId\": \"\",\n \"archived\": false,\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"disabledAt\": \"\",\n \"password\": \"\",\n \"proxy\": false,\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": false,\n \"doIndex\": false,\n \"ios\": \"\",\n \"android\": \"\",\n \"geo\": {\n \"dolore_341\": \"\",\n \"anim_0\": \"\"\n },\n \"publicStats\": false,\n \"tags\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"blue\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"color\": \"blue\"\n }\n ],\n \"folderId\": \"\",\n \"webhookIds\": [\n \"\",\n \"\"\n ],\n \"comments\": \"\",\n \"shortLink\": \"\",\n \"qrCode\": \"\",\n \"utm_source\": \"\",\n \"utm_medium\": \"\",\n \"utm_campaign\": \"\",\n \"utm_term\": \"\",\n \"utm_content\": \"\",\n \"userId\": \"\",\n \"workspaceId\": \"\",\n \"clicks\": 0,\n \"leads\": 0,\n \"conversions\": 0,\n \"sales\": 0,\n \"saleAmount\": 0,\n \"lastClicked\": \"\",\n \"createdAt\": \"\",\n \"updatedAt\": \"\",\n \"tagId\": \"\",\n \"projectId\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-478a4a1d-180c-4a27-ade4-0f9c6afaffda" }, { "id": "944a05e8-d130-4751-b5ce-20185639c9d7", "name": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"url\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"bad_request\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-944a05e8-d130-4751-b5ce-20185639c9d7" }, { "id": "0e740c05-8c1e-4c0c-b02a-93acb41a1cce", "name": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"url\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unauthorized\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-0e740c05-8c1e-4c0c-b02a-93acb41a1cce" }, { "id": "646b8b16-0f30-406d-b5f6-401e3cf35495", "name": "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"url\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"forbidden\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-646b8b16-0f30-406d-b5f6-401e3cf35495" }, { "id": "d458a235-d718-4361-8e29-7eacf4662611", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"url\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-d458a235-d718-4361-8e29-7eacf4662611" }, { "id": "d46e71f1-706c-41ca-a884-152fc7ceda2a", "name": "This response is sent when a request conflicts with the current state of the server.", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"url\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"conflict\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-d46e71f1-706c-41ca-a884-152fc7ceda2a" }, { "id": "3a8b68c7-94f5-45a3-9443-e4af74d81cec", "name": "This response is sent when the requested content has been permanently deleted from server, with no forwarding address.", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"url\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ] } }, "status": "Gone", "code": 410, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"invite_expired\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-3a8b68c7-94f5-45a3-9443-e4af74d81cec" }, { "id": "407f9aae-5771-46d8-9e1d-4dcb1de64e51", "name": "The request was well-formed but was unable to be followed due to semantic errors.", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"url\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unprocessable_entity\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-407f9aae-5771-46d8-9e1d-4dcb1de64e51" }, { "id": "c5731a69-9b3d-4dc1-8e5f-f1f920f75054", "name": "The user has sent too many requests in a given amount of time (\"rate limiting\")", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"url\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-c5731a69-9b3d-4dc1-8e5f-f1f920f75054" }, { "id": "d6406a22-9b09-4d62-b9ed-3853ed822368", "name": "The server has encountered a situation it does not know how to handle.", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"url\": \"\",\n \"key\": \"\",\n \"comments\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/links", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"internal_server_error\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-d6406a22-9b09-4d62-b9ed-3853ed822368" } ], "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-21126f95-fee2-4e2c-be28-d0fbe59c8e7a" }, { "name": "Retrieve a partner's links.", "id": "5b8de8e8-b18e-4021-982c-e26c06c7c99d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/links?partnerId=&tenantId=", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" } ] }, "description": "Retrieve a partner's links by their partner ID or tenant ID." }, "response": [ { "id": "a898c95f-01e9-450b-87dd-c72a89e16329", "name": "The retrieved partner links.", "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}}/partners/links?partnerId=&tenantId=", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"key\": \"\",\n \"shortLink\": \"\",\n \"url\": \"\",\n \"clicks\": 0,\n \"leads\": 0,\n \"conversions\": 0,\n \"sales\": 0,\n \"saleAmount\": 0\n },\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"key\": \"\",\n \"shortLink\": \"\",\n \"url\": \"\",\n \"clicks\": 0,\n \"leads\": 0,\n \"conversions\": 0,\n \"sales\": 0,\n \"saleAmount\": 0\n }\n]", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-a898c95f-01e9-450b-87dd-c72a89e16329" }, { "id": "e19f568b-e0b2-4518-8d8a-266754612d1c", "name": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).", "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}}/partners/links?partnerId=&tenantId=", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"bad_request\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-e19f568b-e0b2-4518-8d8a-266754612d1c" }, { "id": "b03eca31-e2a0-40d6-af08-99ad65cf1bd4", "name": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.", "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}}/partners/links?partnerId=&tenantId=", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unauthorized\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-b03eca31-e2a0-40d6-af08-99ad65cf1bd4" }, { "id": "05b40e11-3ae3-4af2-bf0b-bd71b7e11e41", "name": "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.", "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}}/partners/links?partnerId=&tenantId=", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"forbidden\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-05b40e11-3ae3-4af2-bf0b-bd71b7e11e41" }, { "id": "2dc98e02-e3c5-49f1-accf-ce2e394be673", "name": "The server cannot find the requested resource.", "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}}/partners/links?partnerId=&tenantId=", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-2dc98e02-e3c5-49f1-accf-ce2e394be673" }, { "id": "ac6288ec-3e2f-400d-9360-2aab40201f61", "name": "This response is sent when a request conflicts with the current state of the server.", "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}}/partners/links?partnerId=&tenantId=", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"conflict\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-ac6288ec-3e2f-400d-9360-2aab40201f61" }, { "id": "d196ac95-af05-4181-8a71-b62d4d4a68d4", "name": "This response is sent when the requested content has been permanently deleted from server, with no forwarding address.", "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}}/partners/links?partnerId=&tenantId=", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" } ] } }, "status": "Gone", "code": 410, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"invite_expired\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-d196ac95-af05-4181-8a71-b62d4d4a68d4" }, { "id": "690ee4cb-e2e2-4568-87b3-dacae26267eb", "name": "The request was well-formed but was unable to be followed due to semantic errors.", "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}}/partners/links?partnerId=&tenantId=", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unprocessable_entity\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-690ee4cb-e2e2-4568-87b3-dacae26267eb" }, { "id": "411ee298-05ad-4014-a881-ad1f543ecd12", "name": "The user has sent too many requests in a given amount of time (\"rate limiting\")", "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}}/partners/links?partnerId=&tenantId=", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-411ee298-05ad-4014-a881-ad1f543ecd12" }, { "id": "0c2b8717-6f3b-46d2-93cc-8e807d3cff5a", "name": "The server has encountered a situation it does not know how to handle.", "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}}/partners/links?partnerId=&tenantId=", "host": [ "{{baseUrl}}" ], "path": [ "partners", "links" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"internal_server_error\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-0c2b8717-6f3b-46d2-93cc-8e807d3cff5a" } ], "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-5b8de8e8-b18e-4021-982c-e26c06c7c99d" } ], "id": "d7e33436-a0ba-4e4f-9134-789d9b72b850", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-d7e33436-a0ba-4e4f-9134-789d9b72b850" }, { "name": "analytics", "item": [ { "name": "Retrieve analytics for a partner", "id": "039295ec-09a0-4f49-9f1d-06bb16235264", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners/analytics?partnerId=&tenantId=&interval=30d&start=&end=&timezone=UTC&query=&groupBy=count", "host": [ "{{baseUrl}}" ], "path": [ "partners", "analytics" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "30d" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" } ] }, "description": "Retrieve analytics for a partner within a program. The response type vary based on the `groupBy` query parameter." }, "response": [ { "id": "4bdf1466-27d3-4611-a9cc-e08e244427f2", "name": "Partner analytics data", "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}}/partners/analytics?partnerId=&tenantId=&interval=30d&start=&end=&timezone=UTC&query=&groupBy=count", "host": [ "{{baseUrl}}" ], "path": [ "partners", "analytics" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "30d" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"clicks\": 0,\n \"leads\": 0,\n \"sales\": 0,\n \"saleAmount\": 0,\n \"earnings\": 0\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-4bdf1466-27d3-4611-a9cc-e08e244427f2" }, { "id": "f35cd7df-469d-4d16-936d-95794409b63b", "name": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).", "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}}/partners/analytics?partnerId=&tenantId=&interval=30d&start=&end=&timezone=UTC&query=&groupBy=count", "host": [ "{{baseUrl}}" ], "path": [ "partners", "analytics" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "30d" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"bad_request\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-f35cd7df-469d-4d16-936d-95794409b63b" }, { "id": "80e579be-2f03-4693-bdbd-5d8df092a932", "name": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.", "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}}/partners/analytics?partnerId=&tenantId=&interval=30d&start=&end=&timezone=UTC&query=&groupBy=count", "host": [ "{{baseUrl}}" ], "path": [ "partners", "analytics" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "30d" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unauthorized\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-80e579be-2f03-4693-bdbd-5d8df092a932" }, { "id": "451cdd2c-4f1f-4f41-9226-dde118cdc721", "name": "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.", "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}}/partners/analytics?partnerId=&tenantId=&interval=30d&start=&end=&timezone=UTC&query=&groupBy=count", "host": [ "{{baseUrl}}" ], "path": [ "partners", "analytics" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "30d" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"forbidden\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-451cdd2c-4f1f-4f41-9226-dde118cdc721" }, { "id": "20ca3668-c87e-49c4-a71e-01ce70081ec6", "name": "The server cannot find the requested resource.", "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}}/partners/analytics?partnerId=&tenantId=&interval=30d&start=&end=&timezone=UTC&query=&groupBy=count", "host": [ "{{baseUrl}}" ], "path": [ "partners", "analytics" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "30d" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-20ca3668-c87e-49c4-a71e-01ce70081ec6" }, { "id": "4733f4a3-5ca9-43e3-a21d-51097414f555", "name": "This response is sent when a request conflicts with the current state of the server.", "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}}/partners/analytics?partnerId=&tenantId=&interval=30d&start=&end=&timezone=UTC&query=&groupBy=count", "host": [ "{{baseUrl}}" ], "path": [ "partners", "analytics" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "30d" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"conflict\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-4733f4a3-5ca9-43e3-a21d-51097414f555" }, { "id": "127d5019-2015-499a-bbe4-d1121283af44", "name": "This response is sent when the requested content has been permanently deleted from server, with no forwarding address.", "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}}/partners/analytics?partnerId=&tenantId=&interval=30d&start=&end=&timezone=UTC&query=&groupBy=count", "host": [ "{{baseUrl}}" ], "path": [ "partners", "analytics" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "30d" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" } ] } }, "status": "Gone", "code": 410, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"invite_expired\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-127d5019-2015-499a-bbe4-d1121283af44" }, { "id": "2b28f464-cb4a-4eba-bfd8-724a608da9a0", "name": "The request was well-formed but was unable to be followed due to semantic errors.", "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}}/partners/analytics?partnerId=&tenantId=&interval=30d&start=&end=&timezone=UTC&query=&groupBy=count", "host": [ "{{baseUrl}}" ], "path": [ "partners", "analytics" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "30d" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unprocessable_entity\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-2b28f464-cb4a-4eba-bfd8-724a608da9a0" }, { "id": "c80ca0c9-ce28-4c99-ae2b-c8ab0255b581", "name": "The user has sent too many requests in a given amount of time (\"rate limiting\")", "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}}/partners/analytics?partnerId=&tenantId=&interval=30d&start=&end=&timezone=UTC&query=&groupBy=count", "host": [ "{{baseUrl}}" ], "path": [ "partners", "analytics" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "30d" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-c80ca0c9-ce28-4c99-ae2b-c8ab0255b581" }, { "id": "4a901426-8937-4ce2-bbbe-47ef98372e81", "name": "The server has encountered a situation it does not know how to handle.", "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}}/partners/analytics?partnerId=&tenantId=&interval=30d&start=&end=&timezone=UTC&query=&groupBy=count", "host": [ "{{baseUrl}}" ], "path": [ "partners", "analytics" ], "query": [ { "description": "The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.", "key": "partnerId", "value": "" }, { "description": "The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.", "key": "tenantId", "value": "" }, { "description": "The interval to retrieve analytics for. If undefined, defaults to 24h.", "key": "interval", "value": "30d" }, { "description": "The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.", "key": "start", "value": "" }, { "description": "The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.", "key": "end", "value": "" }, { "description": "The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.", "key": "timezone", "value": "UTC" }, { "description": "Search the events by a custom metadata value. Only available for lead and sale events. Examples: `metadata['key']:'value'`", "key": "query", "value": "" }, { "description": "The parameter to group the analytics data points by. Defaults to `count` if undefined.", "key": "groupBy", "value": "count" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"internal_server_error\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-4a901426-8937-4ce2-bbbe-47ef98372e81" } ], "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-039295ec-09a0-4f49-9f1d-06bb16235264" } ], "id": "55a8fd72-044d-4ebe-8f58-718b180955c4", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-55a8fd72-044d-4ebe-8f58-718b180955c4" }, { "name": "ban", "item": [ { "name": "Ban a partner", "id": "ef694924-a613-409a-8a46-0cf7c714af2e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"reason\": \"brand_abuse\",\n \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/ban", "host": [ "{{baseUrl}}" ], "path": [ "partners", "ban" ] }, "description": "Ban a partner from your program. This will disable all links and mark all commissions as canceled." }, "response": [ { "id": "2adb2ebe-8b8a-4b08-a941-eb001dccbc90", "name": "The banned partner", "originalRequest": { "method": "POST", "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 \"reason\": \"brand_abuse\",\n \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/ban", "host": [ "{{baseUrl}}" ], "path": [ "partners", "ban" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"partnerId\": \"\"\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-2adb2ebe-8b8a-4b08-a941-eb001dccbc90" }, { "id": "0605e4cc-2441-49e0-a5b9-35dda3dfcfc6", "name": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).", "originalRequest": { "method": "POST", "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 \"reason\": \"brand_abuse\",\n \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/ban", "host": [ "{{baseUrl}}" ], "path": [ "partners", "ban" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"bad_request\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-0605e4cc-2441-49e0-a5b9-35dda3dfcfc6" }, { "id": "987254ee-4256-467f-9c39-1d42c6d8ce9a", "name": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.", "originalRequest": { "method": "POST", "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 \"reason\": \"brand_abuse\",\n \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/ban", "host": [ "{{baseUrl}}" ], "path": [ "partners", "ban" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unauthorized\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-987254ee-4256-467f-9c39-1d42c6d8ce9a" }, { "id": "0dc67c95-ffd7-44cb-9cba-58e4e84fe87c", "name": "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.", "originalRequest": { "method": "POST", "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 \"reason\": \"brand_abuse\",\n \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/ban", "host": [ "{{baseUrl}}" ], "path": [ "partners", "ban" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"forbidden\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-0dc67c95-ffd7-44cb-9cba-58e4e84fe87c" }, { "id": "fe4f6b0f-4d6c-4602-bf07-fac94d672b9c", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "POST", "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 \"reason\": \"brand_abuse\",\n \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/ban", "host": [ "{{baseUrl}}" ], "path": [ "partners", "ban" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-fe4f6b0f-4d6c-4602-bf07-fac94d672b9c" }, { "id": "f9457df8-1f6d-4756-96c3-bb66c36e985f", "name": "This response is sent when a request conflicts with the current state of the server.", "originalRequest": { "method": "POST", "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 \"reason\": \"brand_abuse\",\n \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/ban", "host": [ "{{baseUrl}}" ], "path": [ "partners", "ban" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"conflict\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-f9457df8-1f6d-4756-96c3-bb66c36e985f" }, { "id": "3af48f54-4c12-4a9d-a15e-82a861b18fa8", "name": "This response is sent when the requested content has been permanently deleted from server, with no forwarding address.", "originalRequest": { "method": "POST", "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 \"reason\": \"brand_abuse\",\n \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/ban", "host": [ "{{baseUrl}}" ], "path": [ "partners", "ban" ] } }, "status": "Gone", "code": 410, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"invite_expired\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-3af48f54-4c12-4a9d-a15e-82a861b18fa8" }, { "id": "a6f3f969-54f4-4c4c-9529-6dd0c9b3e59f", "name": "The request was well-formed but was unable to be followed due to semantic errors.", "originalRequest": { "method": "POST", "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 \"reason\": \"brand_abuse\",\n \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/ban", "host": [ "{{baseUrl}}" ], "path": [ "partners", "ban" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unprocessable_entity\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-a6f3f969-54f4-4c4c-9529-6dd0c9b3e59f" }, { "id": "a1523745-c798-4feb-8d6f-018418530a75", "name": "The user has sent too many requests in a given amount of time (\"rate limiting\")", "originalRequest": { "method": "POST", "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 \"reason\": \"brand_abuse\",\n \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/ban", "host": [ "{{baseUrl}}" ], "path": [ "partners", "ban" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-a1523745-c798-4feb-8d6f-018418530a75" }, { "id": "1f1bacef-f227-4314-991b-c6f2c5bbc702", "name": "The server has encountered a situation it does not know how to handle.", "originalRequest": { "method": "POST", "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 \"reason\": \"brand_abuse\",\n \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/ban", "host": [ "{{baseUrl}}" ], "path": [ "partners", "ban" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"internal_server_error\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-1f1bacef-f227-4314-991b-c6f2c5bbc702" } ], "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-ef694924-a613-409a-8a46-0cf7c714af2e" } ], "id": "647bf61c-b068-45f0-897b-c1042d5a4468", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-647bf61c-b068-45f0-897b-c1042d5a4468" }, { "name": "deactivate", "item": [ { "name": "Deactivate a partner", "id": "aa7c6b79-2fdb-47b9-b576-6358d66bab7c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "partners", "deactivate" ] }, "description": "This will deactivate the partner from your program and disable all their active links. Their commissions and payouts will remain intact. You can reactivate them later if needed." }, "response": [ { "id": "184ea36a-652c-4d09-89df-c12c76c84fe5", "name": "The deactivated partner", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "partners", "deactivate" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"partnerId\": \"\"\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-184ea36a-652c-4d09-89df-c12c76c84fe5" }, { "id": "a4eaa6de-0bf1-43a1-9cf5-4ab644a38912", "name": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "partners", "deactivate" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"bad_request\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-a4eaa6de-0bf1-43a1-9cf5-4ab644a38912" }, { "id": "a26772b2-aecd-49b0-8f3d-b690c68325bd", "name": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "partners", "deactivate" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unauthorized\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-a26772b2-aecd-49b0-8f3d-b690c68325bd" }, { "id": "cfceb42d-713d-4435-afab-9307a65f16be", "name": "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "partners", "deactivate" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"forbidden\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-cfceb42d-713d-4435-afab-9307a65f16be" }, { "id": "14b55a2a-463f-4093-88e7-dac2c6098831", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "partners", "deactivate" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-14b55a2a-463f-4093-88e7-dac2c6098831" }, { "id": "a111884a-5b43-4f5d-b65b-82d649e6a3ff", "name": "This response is sent when a request conflicts with the current state of the server.", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "partners", "deactivate" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"conflict\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-a111884a-5b43-4f5d-b65b-82d649e6a3ff" }, { "id": "541dc9da-abe2-4105-962b-615470d3bf3a", "name": "This response is sent when the requested content has been permanently deleted from server, with no forwarding address.", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "partners", "deactivate" ] } }, "status": "Gone", "code": 410, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"invite_expired\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-541dc9da-abe2-4105-962b-615470d3bf3a" }, { "id": "3055fa55-925f-492e-ab2b-a6d7bd22f314", "name": "The request was well-formed but was unable to be followed due to semantic errors.", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "partners", "deactivate" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unprocessable_entity\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-3055fa55-925f-492e-ab2b-a6d7bd22f314" }, { "id": "965a5979-8987-4b04-af6d-8caf9be972b9", "name": "The user has sent too many requests in a given amount of time (\"rate limiting\")", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "partners", "deactivate" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-965a5979-8987-4b04-af6d-8caf9be972b9" }, { "id": "8d6b31ea-2188-4e1b-9a2d-da8db61f2676", "name": "The server has encountered a situation it does not know how to handle.", "originalRequest": { "method": "POST", "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 \"partnerId\": \"\",\n \"tenantId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners/deactivate", "host": [ "{{baseUrl}}" ], "path": [ "partners", "deactivate" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"internal_server_error\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-8d6b31ea-2188-4e1b-9a2d-da8db61f2676" } ], "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-aa7c6b79-2fdb-47b9-b576-6358d66bab7c" } ], "id": "3be0cf32-9d85-4edc-9e41-bdc37482be4f", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-3be0cf32-9d85-4edc-9e41-bdc37482be4f" }, { "name": "Create or update a partner", "id": "4766abee-ad9e-4310-9392-e60528d77ba3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"BnKA2J0EaM@WiEty8.subT65.f9mY.N9xSsrd.nAcF.hiKVj.wmbKSP4Jt.EZFbgWSyWTJG\",\n \"name\": \"\",\n \"username\": \"\",\n \"image\": \"\",\n \"tenantId\": \"\",\n \"groupId\": \"\",\n \"country\": \"\",\n \"description\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners", "host": [ "{{baseUrl}}" ], "path": [ "partners" ] }, "description": "Creates or updates a partner record (upsert behavior). If a partner with the same email already exists, their program enrollment will be updated with the provided tenantId. If no existing partner is found, a new partner will be created using the supplied information." }, "response": [ { "id": "ae7fd7f5-45e8-4116-8375-4110fe46bcfc", "name": "The created or updated partner", "originalRequest": { "method": "POST", "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 \"email\": \"BnKA2J0EaM@WiEty8.subT65.f9mY.N9xSsrd.nAcF.hiKVj.wmbKSP4Jt.EZFbgWSyWTJG\",\n \"name\": \"\",\n \"username\": \"\",\n \"image\": \"\",\n \"tenantId\": \"\",\n \"groupId\": \"\",\n \"country\": \"\",\n \"description\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners", "host": [ "{{baseUrl}}" ], "path": [ "partners" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"username\": \"\",\n \"email\": \"\",\n \"image\": \"\",\n \"country\": \"\",\n \"companyName\": \"\",\n \"networkStatus\": \"approved\",\n \"defaultPayoutMethod\": \"paypal\",\n \"paypalEmail\": \"\",\n \"stripeConnectId\": \"\",\n \"payoutsEnabledAt\": \"\",\n \"identityVerifiedAt\": \"\",\n \"programId\": \"\",\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"createdAt\": \"\",\n \"status\": \"banned\",\n \"links\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"key\": \"\",\n \"shortLink\": \"\",\n \"url\": \"\",\n \"clicks\": 0,\n \"leads\": 0,\n \"conversions\": 0,\n \"sales\": 0,\n \"saleAmount\": 0\n },\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"key\": \"\",\n \"shortLink\": \"\",\n \"url\": \"\",\n \"clicks\": 0,\n \"leads\": 0,\n \"conversions\": 0,\n \"sales\": 0,\n \"saleAmount\": 0\n }\n ],\n \"totalCommissions\": 0,\n \"totalClicks\": 0,\n \"totalLeads\": 0,\n \"totalConversions\": 0,\n \"totalSales\": 0,\n \"totalSaleAmount\": 0,\n \"netRevenue\": 0,\n \"description\": \"\",\n \"groupId\": \"\",\n \"clickRewardId\": \"\",\n \"leadRewardId\": \"\",\n \"saleRewardId\": \"\",\n \"referralRewardId\": \"\",\n \"discountId\": \"\",\n \"applicationId\": \"\",\n \"bannedAt\": \"\",\n \"bannedReason\": \"tos_violation\",\n \"referralFormData\": {\n \"fields\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"locked\": \"\",\n \"position\": \"\",\n \"type\": \"text\",\n \"constraints\": {\n \"maxLength\": \"\",\n \"pattern\": \"\"\n }\n }\n ]\n },\n \"application\": {\n \"rejectionReason\": \"other\",\n \"rejectionNote\": \"\",\n \"reviewedAt\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"earningsPerClick\": \"\",\n \"averageLifetimeValue\": \"\",\n \"clickToLeadRate\": \"\",\n \"clickToConversionRate\": \"\",\n \"leadToConversionRate\": \"\",\n \"returnOnAdSpend\": \"\",\n \"website\": \"\",\n \"youtube\": \"\",\n \"twitter\": \"\",\n \"linkedin\": \"\",\n \"instagram\": \"\",\n \"tiktok\": \"\",\n \"trustedAt\": \"\"\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-ae7fd7f5-45e8-4116-8375-4110fe46bcfc" }, { "id": "f5cc7f40-a0dc-4d06-872c-47c40991e7e6", "name": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).", "originalRequest": { "method": "POST", "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 \"email\": \"BnKA2J0EaM@WiEty8.subT65.f9mY.N9xSsrd.nAcF.hiKVj.wmbKSP4Jt.EZFbgWSyWTJG\",\n \"name\": \"\",\n \"username\": \"\",\n \"image\": \"\",\n \"tenantId\": \"\",\n \"groupId\": \"\",\n \"country\": \"\",\n \"description\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners", "host": [ "{{baseUrl}}" ], "path": [ "partners" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"bad_request\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-f5cc7f40-a0dc-4d06-872c-47c40991e7e6" }, { "id": "b497b879-f1ef-4310-8067-1bdbe58d2567", "name": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.", "originalRequest": { "method": "POST", "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 \"email\": \"BnKA2J0EaM@WiEty8.subT65.f9mY.N9xSsrd.nAcF.hiKVj.wmbKSP4Jt.EZFbgWSyWTJG\",\n \"name\": \"\",\n \"username\": \"\",\n \"image\": \"\",\n \"tenantId\": \"\",\n \"groupId\": \"\",\n \"country\": \"\",\n \"description\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners", "host": [ "{{baseUrl}}" ], "path": [ "partners" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unauthorized\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-b497b879-f1ef-4310-8067-1bdbe58d2567" }, { "id": "1550bbb9-12ea-47a3-9394-2909ea2e5783", "name": "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.", "originalRequest": { "method": "POST", "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 \"email\": \"BnKA2J0EaM@WiEty8.subT65.f9mY.N9xSsrd.nAcF.hiKVj.wmbKSP4Jt.EZFbgWSyWTJG\",\n \"name\": \"\",\n \"username\": \"\",\n \"image\": \"\",\n \"tenantId\": \"\",\n \"groupId\": \"\",\n \"country\": \"\",\n \"description\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners", "host": [ "{{baseUrl}}" ], "path": [ "partners" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"forbidden\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-1550bbb9-12ea-47a3-9394-2909ea2e5783" }, { "id": "89bf32dd-1c24-4b41-b2ea-1e2ab1f3f537", "name": "The server cannot find the requested resource.", "originalRequest": { "method": "POST", "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 \"email\": \"BnKA2J0EaM@WiEty8.subT65.f9mY.N9xSsrd.nAcF.hiKVj.wmbKSP4Jt.EZFbgWSyWTJG\",\n \"name\": \"\",\n \"username\": \"\",\n \"image\": \"\",\n \"tenantId\": \"\",\n \"groupId\": \"\",\n \"country\": \"\",\n \"description\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners", "host": [ "{{baseUrl}}" ], "path": [ "partners" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-89bf32dd-1c24-4b41-b2ea-1e2ab1f3f537" }, { "id": "70dfbff5-59df-46ed-9067-3a9fb18da351", "name": "This response is sent when a request conflicts with the current state of the server.", "originalRequest": { "method": "POST", "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 \"email\": \"BnKA2J0EaM@WiEty8.subT65.f9mY.N9xSsrd.nAcF.hiKVj.wmbKSP4Jt.EZFbgWSyWTJG\",\n \"name\": \"\",\n \"username\": \"\",\n \"image\": \"\",\n \"tenantId\": \"\",\n \"groupId\": \"\",\n \"country\": \"\",\n \"description\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners", "host": [ "{{baseUrl}}" ], "path": [ "partners" ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"conflict\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-70dfbff5-59df-46ed-9067-3a9fb18da351" }, { "id": "68a04ff1-a052-47bc-96d5-a0860d7d9541", "name": "This response is sent when the requested content has been permanently deleted from server, with no forwarding address.", "originalRequest": { "method": "POST", "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 \"email\": \"BnKA2J0EaM@WiEty8.subT65.f9mY.N9xSsrd.nAcF.hiKVj.wmbKSP4Jt.EZFbgWSyWTJG\",\n \"name\": \"\",\n \"username\": \"\",\n \"image\": \"\",\n \"tenantId\": \"\",\n \"groupId\": \"\",\n \"country\": \"\",\n \"description\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners", "host": [ "{{baseUrl}}" ], "path": [ "partners" ] } }, "status": "Gone", "code": 410, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"invite_expired\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-68a04ff1-a052-47bc-96d5-a0860d7d9541" }, { "id": "16498ed1-f376-4f8d-b9f8-84d7bf24976e", "name": "The request was well-formed but was unable to be followed due to semantic errors.", "originalRequest": { "method": "POST", "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 \"email\": \"BnKA2J0EaM@WiEty8.subT65.f9mY.N9xSsrd.nAcF.hiKVj.wmbKSP4Jt.EZFbgWSyWTJG\",\n \"name\": \"\",\n \"username\": \"\",\n \"image\": \"\",\n \"tenantId\": \"\",\n \"groupId\": \"\",\n \"country\": \"\",\n \"description\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners", "host": [ "{{baseUrl}}" ], "path": [ "partners" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unprocessable_entity\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-16498ed1-f376-4f8d-b9f8-84d7bf24976e" }, { "id": "3be5b459-1b8c-4a5f-95eb-32b7d1620ac5", "name": "The user has sent too many requests in a given amount of time (\"rate limiting\")", "originalRequest": { "method": "POST", "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 \"email\": \"BnKA2J0EaM@WiEty8.subT65.f9mY.N9xSsrd.nAcF.hiKVj.wmbKSP4Jt.EZFbgWSyWTJG\",\n \"name\": \"\",\n \"username\": \"\",\n \"image\": \"\",\n \"tenantId\": \"\",\n \"groupId\": \"\",\n \"country\": \"\",\n \"description\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners", "host": [ "{{baseUrl}}" ], "path": [ "partners" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-3be5b459-1b8c-4a5f-95eb-32b7d1620ac5" }, { "id": "6a99790f-c6ce-4096-b5b7-9098217652b8", "name": "The server has encountered a situation it does not know how to handle.", "originalRequest": { "method": "POST", "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 \"email\": \"BnKA2J0EaM@WiEty8.subT65.f9mY.N9xSsrd.nAcF.hiKVj.wmbKSP4Jt.EZFbgWSyWTJG\",\n \"name\": \"\",\n \"username\": \"\",\n \"image\": \"\",\n \"tenantId\": \"\",\n \"groupId\": \"\",\n \"country\": \"\",\n \"description\": \"\",\n \"linkProps\": {\n \"externalId\": \"\",\n \"tenantId\": \"\",\n \"prefix\": \"\",\n \"archived\": \"\",\n \"tagIds\": \"\",\n \"tagNames\": \"\",\n \"comments\": \"\",\n \"expiresAt\": \"\",\n \"expiredUrl\": \"\",\n \"password\": \"\",\n \"proxy\": \"\",\n \"title\": \"\",\n \"description\": \"\",\n \"image\": \"\",\n \"video\": \"\",\n \"rewrite\": \"\",\n \"ios\": \"\",\n \"android\": \"\",\n \"doIndex\": \"\",\n \"testVariants\": [\n {\n \"url\": \"\",\n \"percentage\": \"\"\n },\n {\n \"url\": \"\",\n \"percentage\": \"\"\n }\n ],\n \"testStartedAt\": \"\",\n \"testCompletedAt\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/partners", "host": [ "{{baseUrl}}" ], "path": [ "partners" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"internal_server_error\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-6a99790f-c6ce-4096-b5b7-9098217652b8" } ], "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-4766abee-ad9e-4310-9392-e60528d77ba3" }, { "name": "List all partners", "id": "ab96818b-241f-4986-94fe-16834bccb950", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/partners?groupId=&status=approved&country=&sortBy=totalSaleAmount&sortOrder=desc&email=&tenantId=&search=&page=&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "partners" ], "query": [ { "description": "A filter on the list based on the partner's `groupId` field.", "key": "groupId", "value": "" }, { "description": "A filter on the list based on the partner's `status` field.", "key": "status", "value": "approved" }, { "description": "A filter on the list based on the partner's `country` field.", "key": "country", "value": "" }, { "description": "The field to sort the partners by. The default is `totalSaleAmount`.", "key": "sortBy", "value": "totalSaleAmount" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "Filter the partner list based on the partner's `email`. The value must be a string. Takes precedence over `search`.", "key": "email", "value": "" }, { "description": "Filter the partner list based on the partner's `tenantId`. The value must be a string. Takes precedence over `email` and `search`.", "key": "tenantId", "value": "" }, { "description": "A search query to filter partners by ID, name, email, or link.", "key": "search", "value": "" }, { "description": "The page number for pagination.", "key": "page", "value": "" }, { "description": "The number of items per page.", "key": "pageSize", "value": "100" } ] }, "description": "List all partners for a partner program." }, "response": [ { "id": "92a09e84-71fa-48c5-804b-1e05549ba28f", "name": "The list of partners.", "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}}/partners?groupId=&status=approved&country=&sortBy=totalSaleAmount&sortOrder=desc&email=&tenantId=&search=&page=&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "partners" ], "query": [ { "description": "A filter on the list based on the partner's `groupId` field.", "key": "groupId", "value": "" }, { "description": "A filter on the list based on the partner's `status` field.", "key": "status", "value": "approved" }, { "description": "A filter on the list based on the partner's `country` field.", "key": "country", "value": "" }, { "description": "The field to sort the partners by. The default is `totalSaleAmount`.", "key": "sortBy", "value": "totalSaleAmount" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "Filter the partner list based on the partner's `email`. The value must be a string. Takes precedence over `search`.", "key": "email", "value": "" }, { "description": "Filter the partner list based on the partner's `tenantId`. The value must be a string. Takes precedence over `email` and `search`.", "key": "tenantId", "value": "" }, { "description": "A search query to filter partners by ID, name, email, or link.", "key": "search", "value": "" }, { "description": "The page number for pagination.", "key": "page", "value": "" }, { "description": "The number of items per page.", "key": "pageSize", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"id\": \"\",\n \"name\": \"\",\n \"username\": \"\",\n \"email\": \"\",\n \"image\": \"\",\n \"country\": \"\",\n \"companyName\": \"\",\n \"networkStatus\": \"draft\",\n \"defaultPayoutMethod\": \"paypal\",\n \"paypalEmail\": \"\",\n \"stripeConnectId\": \"\",\n \"payoutsEnabledAt\": \"\",\n \"identityVerifiedAt\": \"\",\n \"programId\": \"\",\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"createdAt\": \"\",\n \"status\": \"rejected\",\n \"links\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"key\": \"\",\n \"shortLink\": \"\",\n \"url\": \"\",\n \"clicks\": 0,\n \"leads\": 0,\n \"conversions\": 0,\n \"sales\": 0,\n \"saleAmount\": 0\n },\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"key\": \"\",\n \"shortLink\": \"\",\n \"url\": \"\",\n \"clicks\": 0,\n \"leads\": 0,\n \"conversions\": 0,\n \"sales\": 0,\n \"saleAmount\": 0\n }\n ],\n \"totalCommissions\": 0,\n \"totalClicks\": 0,\n \"totalLeads\": 0,\n \"totalConversions\": 0,\n \"totalSales\": 0,\n \"totalSaleAmount\": 0,\n \"netRevenue\": 0,\n \"description\": \"\",\n \"groupId\": \"\",\n \"clickRewardId\": \"\",\n \"leadRewardId\": \"\",\n \"saleRewardId\": \"\",\n \"referralRewardId\": \"\",\n \"discountId\": \"\",\n \"applicationId\": \"\",\n \"bannedAt\": \"\",\n \"bannedReason\": \"inappropriate_content\",\n \"referralFormData\": {\n \"fields\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"locked\": \"\",\n \"position\": \"\",\n \"type\": \"text\",\n \"constraints\": {\n \"maxLength\": \"\",\n \"pattern\": \"\"\n }\n }\n ]\n },\n \"application\": {\n \"rejectionReason\": \"needsMoreDetail\",\n \"rejectionNote\": \"\",\n \"reviewedAt\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"earningsPerClick\": \"\",\n \"averageLifetimeValue\": \"\",\n \"clickToLeadRate\": \"\",\n \"clickToConversionRate\": \"\",\n \"leadToConversionRate\": \"\",\n \"returnOnAdSpend\": \"\",\n \"website\": \"\",\n \"youtube\": \"\",\n \"twitter\": \"\",\n \"linkedin\": \"\",\n \"instagram\": \"\",\n \"tiktok\": \"\",\n \"trustedAt\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"username\": \"\",\n \"email\": \"\",\n \"image\": \"\",\n \"country\": \"\",\n \"companyName\": \"\",\n \"networkStatus\": \"submitted\",\n \"defaultPayoutMethod\": \"paypal\",\n \"paypalEmail\": \"\",\n \"stripeConnectId\": \"\",\n \"payoutsEnabledAt\": \"\",\n \"identityVerifiedAt\": \"\",\n \"programId\": \"\",\n \"partnerId\": \"\",\n \"tenantId\": \"\",\n \"createdAt\": \"\",\n \"status\": \"archived\",\n \"links\": [\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"key\": \"\",\n \"shortLink\": \"\",\n \"url\": \"\",\n \"clicks\": 0,\n \"leads\": 0,\n \"conversions\": 0,\n \"sales\": 0,\n \"saleAmount\": 0\n },\n {\n \"id\": \"\",\n \"domain\": \"\",\n \"key\": \"\",\n \"shortLink\": \"\",\n \"url\": \"\",\n \"clicks\": 0,\n \"leads\": 0,\n \"conversions\": 0,\n \"sales\": 0,\n \"saleAmount\": 0\n }\n ],\n \"totalCommissions\": 0,\n \"totalClicks\": 0,\n \"totalLeads\": 0,\n \"totalConversions\": 0,\n \"totalSales\": 0,\n \"totalSaleAmount\": 0,\n \"netRevenue\": 0,\n \"description\": \"\",\n \"groupId\": \"\",\n \"clickRewardId\": \"\",\n \"leadRewardId\": \"\",\n \"saleRewardId\": \"\",\n \"referralRewardId\": \"\",\n \"discountId\": \"\",\n \"applicationId\": \"\",\n \"bannedAt\": \"\",\n \"bannedReason\": \"brand_abuse\",\n \"referralFormData\": {\n \"fields\": [\n {\n \"key\": \"\",\n \"label\": \"\",\n \"required\": \"\",\n \"locked\": \"\",\n \"position\": \"\",\n \"type\": \"text\",\n \"constraints\": {\n \"maxLength\": \"\",\n \"pattern\": \"\"\n }\n }\n ]\n },\n \"application\": {\n \"rejectionReason\": \"doesNotMeetRequirements\",\n \"rejectionNote\": \"\",\n \"reviewedAt\": \"\"\n },\n \"tags\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"earningsPerClick\": \"\",\n \"averageLifetimeValue\": \"\",\n \"clickToLeadRate\": \"\",\n \"clickToConversionRate\": \"\",\n \"leadToConversionRate\": \"\",\n \"returnOnAdSpend\": \"\",\n \"website\": \"\",\n \"youtube\": \"\",\n \"twitter\": \"\",\n \"linkedin\": \"\",\n \"instagram\": \"\",\n \"tiktok\": \"\",\n \"trustedAt\": \"\"\n }\n]", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-92a09e84-71fa-48c5-804b-1e05549ba28f" }, { "id": "c6d4d337-681b-477b-abef-85877fbc34e0", "name": "The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).", "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}}/partners?groupId=&status=approved&country=&sortBy=totalSaleAmount&sortOrder=desc&email=&tenantId=&search=&page=&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "partners" ], "query": [ { "description": "A filter on the list based on the partner's `groupId` field.", "key": "groupId", "value": "" }, { "description": "A filter on the list based on the partner's `status` field.", "key": "status", "value": "approved" }, { "description": "A filter on the list based on the partner's `country` field.", "key": "country", "value": "" }, { "description": "The field to sort the partners by. The default is `totalSaleAmount`.", "key": "sortBy", "value": "totalSaleAmount" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "Filter the partner list based on the partner's `email`. The value must be a string. Takes precedence over `search`.", "key": "email", "value": "" }, { "description": "Filter the partner list based on the partner's `tenantId`. The value must be a string. Takes precedence over `email` and `search`.", "key": "tenantId", "value": "" }, { "description": "A search query to filter partners by ID, name, email, or link.", "key": "search", "value": "" }, { "description": "The page number for pagination.", "key": "page", "value": "" }, { "description": "The number of items per page.", "key": "pageSize", "value": "100" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"bad_request\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-c6d4d337-681b-477b-abef-85877fbc34e0" }, { "id": "60d5c426-2699-433b-8d46-11ec31055bac", "name": "Although the HTTP standard specifies \"unauthorized\", semantically this response means \"unauthenticated\". That is, the client must authenticate itself to get the requested response.", "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}}/partners?groupId=&status=approved&country=&sortBy=totalSaleAmount&sortOrder=desc&email=&tenantId=&search=&page=&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "partners" ], "query": [ { "description": "A filter on the list based on the partner's `groupId` field.", "key": "groupId", "value": "" }, { "description": "A filter on the list based on the partner's `status` field.", "key": "status", "value": "approved" }, { "description": "A filter on the list based on the partner's `country` field.", "key": "country", "value": "" }, { "description": "The field to sort the partners by. The default is `totalSaleAmount`.", "key": "sortBy", "value": "totalSaleAmount" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "Filter the partner list based on the partner's `email`. The value must be a string. Takes precedence over `search`.", "key": "email", "value": "" }, { "description": "Filter the partner list based on the partner's `tenantId`. The value must be a string. Takes precedence over `email` and `search`.", "key": "tenantId", "value": "" }, { "description": "A search query to filter partners by ID, name, email, or link.", "key": "search", "value": "" }, { "description": "The page number for pagination.", "key": "page", "value": "" }, { "description": "The number of items per page.", "key": "pageSize", "value": "100" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unauthorized\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-60d5c426-2699-433b-8d46-11ec31055bac" }, { "id": "5b8b9ad3-72e6-4b73-93b2-114f56b35362", "name": "The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.", "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}}/partners?groupId=&status=approved&country=&sortBy=totalSaleAmount&sortOrder=desc&email=&tenantId=&search=&page=&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "partners" ], "query": [ { "description": "A filter on the list based on the partner's `groupId` field.", "key": "groupId", "value": "" }, { "description": "A filter on the list based on the partner's `status` field.", "key": "status", "value": "approved" }, { "description": "A filter on the list based on the partner's `country` field.", "key": "country", "value": "" }, { "description": "The field to sort the partners by. The default is `totalSaleAmount`.", "key": "sortBy", "value": "totalSaleAmount" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "Filter the partner list based on the partner's `email`. The value must be a string. Takes precedence over `search`.", "key": "email", "value": "" }, { "description": "Filter the partner list based on the partner's `tenantId`. The value must be a string. Takes precedence over `email` and `search`.", "key": "tenantId", "value": "" }, { "description": "A search query to filter partners by ID, name, email, or link.", "key": "search", "value": "" }, { "description": "The page number for pagination.", "key": "page", "value": "" }, { "description": "The number of items per page.", "key": "pageSize", "value": "100" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"forbidden\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-5b8b9ad3-72e6-4b73-93b2-114f56b35362" }, { "id": "3b71e5e5-9563-4a6d-ad28-2922616ba808", "name": "The server cannot find the requested resource.", "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}}/partners?groupId=&status=approved&country=&sortBy=totalSaleAmount&sortOrder=desc&email=&tenantId=&search=&page=&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "partners" ], "query": [ { "description": "A filter on the list based on the partner's `groupId` field.", "key": "groupId", "value": "" }, { "description": "A filter on the list based on the partner's `status` field.", "key": "status", "value": "approved" }, { "description": "A filter on the list based on the partner's `country` field.", "key": "country", "value": "" }, { "description": "The field to sort the partners by. The default is `totalSaleAmount`.", "key": "sortBy", "value": "totalSaleAmount" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "Filter the partner list based on the partner's `email`. The value must be a string. Takes precedence over `search`.", "key": "email", "value": "" }, { "description": "Filter the partner list based on the partner's `tenantId`. The value must be a string. Takes precedence over `email` and `search`.", "key": "tenantId", "value": "" }, { "description": "A search query to filter partners by ID, name, email, or link.", "key": "search", "value": "" }, { "description": "The page number for pagination.", "key": "page", "value": "" }, { "description": "The number of items per page.", "key": "pageSize", "value": "100" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"not_found\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-3b71e5e5-9563-4a6d-ad28-2922616ba808" }, { "id": "69a754d6-df32-4291-8d2f-62ec8f5eb063", "name": "This response is sent when a request conflicts with the current state of the server.", "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}}/partners?groupId=&status=approved&country=&sortBy=totalSaleAmount&sortOrder=desc&email=&tenantId=&search=&page=&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "partners" ], "query": [ { "description": "A filter on the list based on the partner's `groupId` field.", "key": "groupId", "value": "" }, { "description": "A filter on the list based on the partner's `status` field.", "key": "status", "value": "approved" }, { "description": "A filter on the list based on the partner's `country` field.", "key": "country", "value": "" }, { "description": "The field to sort the partners by. The default is `totalSaleAmount`.", "key": "sortBy", "value": "totalSaleAmount" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "Filter the partner list based on the partner's `email`. The value must be a string. Takes precedence over `search`.", "key": "email", "value": "" }, { "description": "Filter the partner list based on the partner's `tenantId`. The value must be a string. Takes precedence over `email` and `search`.", "key": "tenantId", "value": "" }, { "description": "A search query to filter partners by ID, name, email, or link.", "key": "search", "value": "" }, { "description": "The page number for pagination.", "key": "page", "value": "" }, { "description": "The number of items per page.", "key": "pageSize", "value": "100" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"conflict\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-69a754d6-df32-4291-8d2f-62ec8f5eb063" }, { "id": "f65108af-3378-4536-9399-df08c2c7ead1", "name": "This response is sent when the requested content has been permanently deleted from server, with no forwarding address.", "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}}/partners?groupId=&status=approved&country=&sortBy=totalSaleAmount&sortOrder=desc&email=&tenantId=&search=&page=&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "partners" ], "query": [ { "description": "A filter on the list based on the partner's `groupId` field.", "key": "groupId", "value": "" }, { "description": "A filter on the list based on the partner's `status` field.", "key": "status", "value": "approved" }, { "description": "A filter on the list based on the partner's `country` field.", "key": "country", "value": "" }, { "description": "The field to sort the partners by. The default is `totalSaleAmount`.", "key": "sortBy", "value": "totalSaleAmount" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "Filter the partner list based on the partner's `email`. The value must be a string. Takes precedence over `search`.", "key": "email", "value": "" }, { "description": "Filter the partner list based on the partner's `tenantId`. The value must be a string. Takes precedence over `email` and `search`.", "key": "tenantId", "value": "" }, { "description": "A search query to filter partners by ID, name, email, or link.", "key": "search", "value": "" }, { "description": "The page number for pagination.", "key": "page", "value": "" }, { "description": "The number of items per page.", "key": "pageSize", "value": "100" } ] } }, "status": "Gone", "code": 410, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"invite_expired\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-f65108af-3378-4536-9399-df08c2c7ead1" }, { "id": "5fe46508-3aa4-4e1d-9df9-6a33601e89d3", "name": "The request was well-formed but was unable to be followed due to semantic errors.", "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}}/partners?groupId=&status=approved&country=&sortBy=totalSaleAmount&sortOrder=desc&email=&tenantId=&search=&page=&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "partners" ], "query": [ { "description": "A filter on the list based on the partner's `groupId` field.", "key": "groupId", "value": "" }, { "description": "A filter on the list based on the partner's `status` field.", "key": "status", "value": "approved" }, { "description": "A filter on the list based on the partner's `country` field.", "key": "country", "value": "" }, { "description": "The field to sort the partners by. The default is `totalSaleAmount`.", "key": "sortBy", "value": "totalSaleAmount" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "Filter the partner list based on the partner's `email`. The value must be a string. Takes precedence over `search`.", "key": "email", "value": "" }, { "description": "Filter the partner list based on the partner's `tenantId`. The value must be a string. Takes precedence over `email` and `search`.", "key": "tenantId", "value": "" }, { "description": "A search query to filter partners by ID, name, email, or link.", "key": "search", "value": "" }, { "description": "The page number for pagination.", "key": "page", "value": "" }, { "description": "The number of items per page.", "key": "pageSize", "value": "100" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"unprocessable_entity\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-5fe46508-3aa4-4e1d-9df9-6a33601e89d3" }, { "id": "4b8fc875-a39b-47c8-8a26-f7532c0845a4", "name": "The user has sent too many requests in a given amount of time (\"rate limiting\")", "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}}/partners?groupId=&status=approved&country=&sortBy=totalSaleAmount&sortOrder=desc&email=&tenantId=&search=&page=&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "partners" ], "query": [ { "description": "A filter on the list based on the partner's `groupId` field.", "key": "groupId", "value": "" }, { "description": "A filter on the list based on the partner's `status` field.", "key": "status", "value": "approved" }, { "description": "A filter on the list based on the partner's `country` field.", "key": "country", "value": "" }, { "description": "The field to sort the partners by. The default is `totalSaleAmount`.", "key": "sortBy", "value": "totalSaleAmount" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "Filter the partner list based on the partner's `email`. The value must be a string. Takes precedence over `search`.", "key": "email", "value": "" }, { "description": "Filter the partner list based on the partner's `tenantId`. The value must be a string. Takes precedence over `email` and `search`.", "key": "tenantId", "value": "" }, { "description": "A search query to filter partners by ID, name, email, or link.", "key": "search", "value": "" }, { "description": "The page number for pagination.", "key": "page", "value": "" }, { "description": "The number of items per page.", "key": "pageSize", "value": "100" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-4b8fc875-a39b-47c8-8a26-f7532c0845a4" }, { "id": "cb518237-7a4b-4813-aeca-76d765e3dfdb", "name": "The server has encountered a situation it does not know how to handle.", "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}}/partners?groupId=&status=approved&country=&sortBy=totalSaleAmount&sortOrder=desc&email=&tenantId=&search=&page=&pageSize=100", "host": [ "{{baseUrl}}" ], "path": [ "partners" ], "query": [ { "description": "A filter on the list based on the partner's `groupId` field.", "key": "groupId", "value": "" }, { "description": "A filter on the list based on the partner's `status` field.", "key": "status", "value": "approved" }, { "description": "A filter on the list based on the partner's `country` field.", "key": "country", "value": "" }, { "description": "The field to sort the partners by. The default is `totalSaleAmount`.", "key": "sortBy", "value": "totalSaleAmount" }, { "description": "The sort order. The default is `desc`.", "key": "sortOrder", "value": "desc" }, { "description": "Filter the partner list based on the partner's `email`. The value must be a string. Takes precedence over `search`.", "key": "email", "value": "" }, { "description": "Filter the partner list based on the partner's `tenantId`. The value must be a string. Takes precedence over `email` and `search`.", "key": "tenantId", "value": "" }, { "description": "A search query to filter partners by ID, name, email, or link.", "key": "search", "value": "" }, { "description": "The page number for pagination.", "key": "page", "value": "" }, { "description": "The number of items per page.", "key": "pageSize", "value": "100" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"internal_server_error\",\n \"message\": \"\",\n \"doc_url\": \"\"\n }\n}", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-cb518237-7a4b-4813-aeca-76d765e3dfdb" } ], "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-ab96818b-241f-4986-94fe-16834bccb950" } ], "id": "f831422c-7839-4945-9de5-eb3b2a62f0c9", "createdAt": "2026-07-28T01:32:56.000Z", "updatedAt": "2026-07-28T01:32:56.000Z", "uid": "35240-f831422c-7839-4945-9de5-eb3b2a62f0c9" } ], "variable": [ { "key": "baseUrl", "value": "https://api.dub.co" } ] }