Update a sender

PUT/api/v1/senders/{sender}

Requires anorganization API keywith the scopesenders:write

Parameters

Name	In	Type	Description
`sender`required	path	string	The sender identifier.

Request body

domain_idstring
The ID of one of your domains. Copy it from the domain's page in the dashboard, or read it from GET /domains.
email_account_idstring
Optional. The mailbox this address belongs to, when it is one of your Mailyte mailboxes. Copy its ID from the mailbox's page, or read it from GET /email-accounts.
namestring
The name recipients see next to the address, as in Ada from Acme <ada@yourdomain.com>.
emailstring
The From address, on the domain domain_id.

Request

PUT/api/v1/senders/{sender}

curl -X PUT 'https://app.mailyte.com/api/v1/senders/01JBT8XQ2M9WYC3K4F6R7S8T9V' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Ada from Acme",
    "email": "ada@yourdomain.com"
  }'

const response = await fetch('https://app.mailyte.com/api/v1/senders/01JBT8XQ2M9WYC3K4F6R7S8T9V', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Ada from Acme",
    "email": "ada@yourdomain.com"
  }),
});
const { data } = await response.json();

import requests
response = requests.put(
    "https://app.mailyte.com/api/v1/senders/01JBT8XQ2M9WYC3K4F6R7S8T9V",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
    json={
      "name": "Ada from Acme",
      "email": "ada@yourdomain.com"
    },
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->put('https://app.mailyte.com/api/v1/senders/01JBT8XQ2M9WYC3K4F6R7S8T9V', [
    'name' => 'Ada from Acme',
    'email' => 'ada@yourdomain.com',
]);

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/senders/01JBT8XQ2M9WYC3K4F6R7S8T9V")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = {
  "name": "Ada from Acme",
  "email": "ada@yourdomain.com"
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

The key names its own organization, so no X-Organization-ID header is needed.

Response

Success.

dataobject
- objectstringsender
- idstring
  Unique identifier for the sender.
- namestring
  The display name recipients see, e.g. Acme Support in Acme Support <hello@acme.com>.
- emailstring
  The address this identity sends as. POST /messages refuses a from that is not a verified sender.
- domainstring
  The domain this address sends from, such as acme.com. Its DNS details are on GET /domains/{domain}.
- verificationobject
  Whether this address may be sent from. Verification checks the domain's public DNS records; there is no token.
  - statestringpending | verified | failed
    The one verification answer. Only verified permits sending; pending and failed both do not, and differ in whether a check has run.
  - verified_atstring
    When the address last passed verification. Set only while state is verified. Read state to know whether the sender works.
  - errorstring
    Why the last check failed, usually DNS records still missing. Null when state is not failed.
- created_atstring
  When this sender was created.
- updated_atstring
  When this sender was last changed.

Returned inside the standard envelope.

Errors

Status	When
`401`	The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist.
`403`	The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys.
`404`	No such resource in this organization.
`422`	The request was understood but the values were not acceptable.
`429`	Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait.

Every status, with what causes it and what to do, is on the error reference.