Skip to main content
PATCH
/
relay_servers
/
{id}
Update relay server fields
curl --request PATCH \
  --url https://api-v2.missioninbox.com/relay_servers/{id}/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "transporter_key": "<string>"
}
'
{
  "id": 123,
  "domain_count": "<string>",
  "mailbox_count": "<string>",
  "name": "<string>",
  "transporter_provider": "<string>",
  "users": [
    123
  ],
  "transporter_key": "<string>",
  "slug": "<string>"
}

Path Parameters

id
integer
required

A unique integer value identifying this relay server.

Body

name
string

New name for the relay server

transporter_key
string

Updated API key

Response

id
integer
required
domain_count
string
required
mailbox_count
string
required
name
string
required
Maximum string length: 255
transporter_provider
string
required
Maximum string length: 255
users
integer[]
required
transporter_key
string | null
Maximum string length: 255
slug
string
Maximum string length: 50