Mailboxes

Update Sender Persona

Change a sender persona. Send only the fields that change.

first_name, last_name and email cannot be set to null. Domains already registered keep the registrant details they were bought with. Org admins and owners only, and a personal API key.

patch/mailboxes/personas/{persona_id}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/mailboxes/personas/{persona_id}
  • Auth: HTTP bearer

Path parameters

persona_idinteger required

Sender persona id - from GET /mailboxes/personas

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

first_namestring nullable

Given name

last_namestring nullable

Family name

emailstring nullable

The persona's own address

phonestring nullable

Contact phone

titlestring nullable

Job title shown in signatures

organizationstring nullable

Organisation name

address_line1string nullable

Registrant address, line 1

address_line2string nullable

Registrant address, line 2

citystring nullable

City

statestring nullable

State or region

countrystring nullable

Country

postal_codestring nullable

Postal code

photo_urlstring nullable

Photo URL

team_member_idstring uuid nullable

Team member whose identity this persona uses

Response

Successful Response

dataMailboxDomainPayload required

An open envelope for one provider/deliverability result.

Open on purpose. These payloads are provider state and advisory reads whose contents grow with the product, and a dropped field reads as "nothing to report" rather than "we did not tell you". Every value passes through scrub_vendor_names on the way in.

Changes

No recorded changes to this operation across all 2 revisions of this API.