Relayers

Updates a relayer's information based on the provided update request.

patch/api/v1/relayers/{relayer_id}

Request

The document declares no server URL.
Auth
HTTP bearer
TypeScript
https://skmtc.dev/openzeppelin/apis/openzeppelin-relayer-api/docs/api/v1/relayers/:relayer_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

relayer_idstring required

The unique identifier of the relayer

namestring nullable

notification_idstring

pausedboolean

{
  "custom_rpc_urls": [
    {
      "url": "https://rpc.example.com",
      "weight": 100
    }
  ]
}

Relayer updated successfully

errorstring

successboolean required

Jul 28, 2026e6e7514284f5 Revision changes
- info
  added the new optional request property /////
- info
  added the optional property ////// to the response with the status
Jan 12, 202641cbb68dc72d Revision changes
- warning
  the // request property's max was set to 100.00
- info
  the request property // with a default value became required
- info
  the request property default value 100 was added
- info
  the response property /// became required for the status