---
updatedAt: 2026-05-20T17:17:32.000Z
agentTools:
  projectIndex: https://docs.conveyor.com/llms.txt
---

# PATCH Authorization

Revoke an authorization or update it with new access groups

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "portal-api",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.conveyor.com/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v2/exchange/authorizations/{authorization_id}": {
      "patch": {
        "summary": "PATCH Authorization",
        "description": "Revoke an authorization or update it with new access groups",
        "operationId": "patch-authorization",
        "parameters": [
          {
            "name": "authorization_id",
            "in": "path",
            "description": "The ID of the authorization",
            "schema": {
              "type": "string"
            },
            "required": true
          },
          {
            "name": "access_group_ids",
            "in": "query",
            "description": "An array of Access Group IDs. Remove an Access Group by specifying the Access Groups that should remain. Remove all Access Groups by passing an empty array.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "X-API-KEY",
            "in": "header",
            "description": "Your Conveyor API key",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Used to update the status to \"revoked\". Cannot update the status to anything else.",
            "schema": {
              "type": "string",
              "enum": [
                "revoked"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"id\": \"1643748f-9690-4547-9b7f-73ff2c97dccc\",\n  \"created_at\": \"2021-11-03T18:18:52Z\",\n  \"updated_at\": \"2021-11-10T22:46:57Z\",\n  \"_type\": \"exchange/authorization\",\n  \"dataroom_id\": \"2a8a3c45-9333-478c-9d7d-21798baeeed5\",\n  \"gate_document_signature_id\": null,\n  \"connection_id\": \"31949c44-326a-4a2e-9e10-a1962bc82040\",\n  \"email\": \"foo@bar.com\",\n  \"status\": \"gated\",\n  \"is_owner\": false,\n  \"subscribed\": false,\n  \"_embedded\": {\n    \"access_groups\": [\n      {\n        \"id\": \"d2358f1b-c58b-4fbd-ba77-612d1d098c7b\",\n        \"created_at\": \"2021-11-05T19:42:19Z\",\n        \"updated_at\": \"2021-11-05T19:42:19Z\",\n        \"_type\": \"exchange/access_group\",\n        \"name\": \"Super secret group\",\n        \"dataroom_id\": \"2a8a3c45-9333-478c-9d7d-21798baeeed5\",\n        \"_links\": {\n          \"self\": {\n            \"href\": \"http://localhost:4007/exchange/access_groups/d2358f1b-c58b-4fbd-ba77-612d1d098c7b\"\n          }\n        }\n      }\n    ]\n  },\n  \"_links\": {\n    \"self\": {\n      \"href\": \"http://localhost:4007/exchange/authorizations/1643748f-9690-4547-9b7f-73ff2c97dccc\"\n    }\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "example": "1643748f-9690-4547-9b7f-73ff2c97dccc"
                    },
                    "created_at": {
                      "type": "string",
                      "example": "2021-11-03T18:18:52Z"
                    },
                    "updated_at": {
                      "type": "string",
                      "example": "2021-11-10T22:46:57Z"
                    },
                    "_type": {
                      "type": "string",
                      "example": "exchange/authorization"
                    },
                    "dataroom_id": {
                      "type": "string",
                      "example": "2a8a3c45-9333-478c-9d7d-21798baeeed5"
                    },
                    "gate_document_signature_id": {},
                    "connection_id": {
                      "type": "string",
                      "example": "31949c44-326a-4a2e-9e10-a1962bc82040"
                    },
                    "email": {
                      "type": "string",
                      "example": "foo@bar.com"
                    },
                    "status": {
                      "type": "string",
                      "example": "gated"
                    },
                    "is_owner": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "subscribed": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "_embedded": {
                      "type": "object",
                      "properties": {
                        "access_groups": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "id": {
                                "type": "string",
                                "example": "d2358f1b-c58b-4fbd-ba77-612d1d098c7b"
                              },
                              "created_at": {
                                "type": "string",
                                "example": "2021-11-05T19:42:19Z"
                              },
                              "updated_at": {
                                "type": "string",
                                "example": "2021-11-05T19:42:19Z"
                              },
                              "_type": {
                                "type": "string",
                                "example": "exchange/access_group"
                              },
                              "name": {
                                "type": "string",
                                "example": "Super secret group"
                              },
                              "dataroom_id": {
                                "type": "string",
                                "example": "2a8a3c45-9333-478c-9d7d-21798baeeed5"
                              },
                              "_links": {
                                "type": "object",
                                "properties": {
                                  "self": {
                                    "type": "object",
                                    "properties": {
                                      "href": {
                                        "type": "string",
                                        "example": "http://localhost:4007/exchange/access_groups/d2358f1b-c58b-4fbd-ba77-612d1d098c7b"
                                      }
                                    }
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "_links": {
                      "type": "object",
                      "properties": {
                        "self": {
                          "type": "object",
                          "properties": {
                            "href": {
                              "type": "string",
                              "example": "http://localhost:4007/exchange/authorizations/1643748f-9690-4547-9b7f-73ff2c97dccc"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Record not found (authorization or access group)": {
                    "value": "{\n  \"error\": \"Record not found\"\n}"
                  },
                  "No access group IDs provided": {
                    "value": "{\n  \"error\": \"Must provide an array of Exchange::AccessGroup IDs\"\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "title": "Record not found (authorization or access group)",
                      "type": "object",
                      "properties": {
                        "error": {
                          "type": "string",
                          "example": "Record not found"
                        }
                      }
                    },
                    {
                      "title": "No access group IDs provided",
                      "type": "object",
                      "properties": {
                        "error": {
                          "type": "string",
                          "example": "Must provide an array of Exchange::AccessGroup IDs"
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "403": {
            "description": "403",
            "content": {
              "application/json": {
                "examples": {
                  "Unauthorized": {
                    "value": ""
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": false,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true
}
```