Update sender | HubLinks

curl -X PUT https://hublinks.io/rest/accounts/account_id/emails/senders/sender@example.com \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "sender": {
    "status": "DISABLED",
    "seat_id": "{{seat_id}}",
    "account_id": "{{account_id}}"
  }
}'

{
  "success": true,
  "sender": {
    "app": "hublinks",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "oauth": {
      "scope": "https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/gmail.readonly openid https://www.googleapis.com/auth/gmail.send",
      "id_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjJkN2VkMzM4YzBmMTQ1N2IyMTRhMjc0YjVlMGU2NjdiNDRhNDJkZGUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJodHRwczovL2FjY291bnRzLmdvb2dsZS5jb20iLCJhenAiOiIxMDQ3OTA3OTI5ODI4LW81cTdtaHEybDh1Z21jb3YwNnQzbDNtbHRrNTh0NmU2LmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tIiwiYXVkIjoiMTA0NzkwNzkyOTgyOC1vNXE3bWhxMmw4dWdtY292MDZ0M2wzbWx0azU4dDZlNi5hcHBzLmdvb2dsZXVzZXJjb250ZW50LmNvbSIsInN1YiI6IjExMTAzMjQyMDY1NjA0NDYxNDE0OSIsImhkIjoiYWxzb25hLmNvbSIsImVtYWlsIjoiamFjbHluLmN1cnRpc0BhbHNvbmEuY29tIiwiZW1haWxfdmVyaWZpZWQiOnRydWUsImF0X2hhc2giOiJVMklrQ3l2TnNJMnNMNWxNZzRRTEtBIiwibmFtZSI6IkphY2x5biBDdXJ0aXMiLCJnaXZlbl9uYW1lIjoiSmFjbHluIiwiZmFtaWx5X25hbWUiOiJDdXJ0aXMiLCJpYXQiOjE3NTYzMDYyNDUsImV4cCI6MTc1NjMwOTg0NX0.iL8eha3m3C-5fiZJQ8yK3rpAaJ52xDQzBi_ynd-jDnThvBlNpLbZliHba8vscLkkHpSyPWdDFwRH8Qcb_E_V2_bHG7qfa23hCRkIXT5zBb1d_KAGtz59znE5SRhs1Etkc07cl8a5gxR0uxCR5FIMwftVrAl35pcVmlizZqVglqyxVaco3TtAclXM2uJdKvk91Bmbhjan2rwaqHDAgdBpDHO3KHZd5jgnyPapLLzU5l6ulx9H8pvJsFRMeINj32wZD14dfp7ZXcQ8alM3eYek-fwt-a5NRQrgEbv_e1f2v0HE-n06MP-iR7vUws3ORzLuhYv6l6V2MppEWCuSm6Exjw",
      "token_type": "Bearer",
      "expiry_date": 1756309844712,
      "access_token": "Token...",
      "refresh_token": "Token..."
    },
    "status": "ENABLED",
    "seat_id": "seat_6a13e661ecc6a86e3fb7",
    "provider": "google",
    "last_name": "Doe",
    "wl_domain": "string",
    "account_id": "account_136ce10b5f8a7682efb3",
    "created_at": 1756306245825,
    "first_name": "John",
    "picture_url": "https://lh3.googleusercontent.com/...",
    "access_token": "Token...",
    "refresh_token": "Token...",
    "access_token_expire_at": 1756309844712,
    "access_token_updated_at": 1756306245825
  }
}

Update sender details (email in path).

Request body fields (wrapped in sender object):

seat_id (string, required) - Associated seat ID.
account_id (string, required) - Account this sender belongs to.
status (string, optional) - ENABLED | DISABLED.
name (string, optional) - Display name for this sender.

Update sender details (email in path). **Request body fields (wrapped in `sender` object):** - `seat_id` (string, required) - Associated seat ID. - `account_id` (string, required) - Account this sender belongs to. - `status` (string, optional) - `ENABLED` | `DISABLED`. - `name` (string, optional) - Display name for this sender.

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

account_idstringRequired

Request

This endpoint expects an object.

senderobjectRequired

Response

This endpoint returns an object.

successboolean

senderobject

Authentication

Path parameters

Request

Response

Errors