Skip to main content
PATCH
Update a purchased mailbox's profile

Authorizations

Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Get your API key from the Reply dashboard: Settings → API Key.

Path Parameters

id
integer<int64>
required

Email account ID of the purchased mailbox

Required range: x >= 1

Body

application/json

The profile values to set on a purchased mailbox. Send at least one field. A field left out is not changed; null and an empty string are rejected, because the provider cannot clear a value.

firstName
string

Latin letters, digits, spaces and the punctuation . , - ' & / ( ) # ", with no leading or trailing space, up to 127 characters.

Required string length: 1 - 127
Pattern: ^(?! )[A-Za-z0-9 .,'&/()#"-]{1,127}(?<! )$
lastName
string

Latin letters, digits, spaces and the punctuation . , - ' & / ( ) # ", with no leading or trailing space, up to 127 characters.

Required string length: 1 - 127
Pattern: ^(?! )[A-Za-z0-9 .,'&/()#"-]{1,127}(?<! )$
avatarUrl
string<uri>

HTTP or HTTPS URL of the mailbox profile picture, up to 500 characters

Maximum string length: 500

Response

The update was scheduled; poll the returned job for the outcome

jobId
string<uuid>
required

Poll GET /v3/background-jobs/{jobId} for the outcome