Mailboxes
Update a mailbox endpoint
Updates the fields you name and keeps the rest, and returns the mailbox.
Updates the fields you name and keeps the rest, and returns the mailbox. displayName is the name messages sent from the endpoint carry; null falls back to the mailbox's name. default: true makes the endpoint the one the mailbox starts new conversations from on its channel; replies always leave from the endpoint of their thread.
Authorization
apiKey x-api-key<token>
In: header
Path Parameters
id*string
Match
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$endpointId*string
Match
^mbxep_[0-9a-hjkmnp-tv-z]{16,24}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
displayName?string|null|null
default?|null
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/v1/mailboxes/string/endpoints/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "string", "namespaceId": "string", "slug": "string", "name": "string", "status": "active", "primaryAddress": "string", "createdAt": "string", "description": "string", "metadata": { "property1": "string", "property2": "string" }, "endpoints": [ { "id": "string", "address": "string", "displayName": "string", "default": true, "channel": "email", "source": "samvaHosted", "domainId": "string" } ], "updatedAt": "string"}