Skip to content

Upload Persona Photo

POST
/mailboxes/personas/{persona_id}/photo

Set the photo this sender persona uses. Multipart upload.

REPLACES the current photo. The image is stored by graph8 and referenced from the returned photo_url; 503 means photo storage was unavailable and the persona is unchanged, so it is safe to retry.

Org admins and owners only, and a personal API key.

Authorizations

Parameters

Path Parameters

persona_id
required

Sender persona id - from GET /mailboxes/personas

integer
> 0

Sender persona id - from GET /mailboxes/personas

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
file
required

Image file. Oversized or non-image uploads are refused with a 422.

string format: binary

Responses

200

Successful Response

object
data
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.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string