Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference
Mailboxes

Update a mailbox policy

Updates the fields you name and keeps the rest. Set `enabled` to `false` to stop a policy applying without deleting it.

PATCH
/v1/mailboxes/{id}/policies/{policyId}

Updates the fields you name and keeps the rest. Set enabled to false to stop a policy applying without deleting it.

Authorization

apiKey
x-api-key<token>

In: header

Path Parameters

id*string
Match^mbx_[0-9a-hjkmnp-tv-z]{16,24}$
policyId*string
Match^mbxpol_[0-9a-hjkmnp-tv-z]{16,24}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?|null
outcome?|null
reason?|null|null
enabled?boolean|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/policies/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "outcome": "requireApproval",  "reason": "string",  "enabled": true,  "createdAt": "string",  "updatedAt": "string"}

Related documentation

Update a mailbox note

Updates the fields you name and keeps the rest. Only the note's author may. Use this endpoint to update a mailbox note through the Samva email API.

Update a mailbox thread

Updates the fields you name and keeps the rest. View request and response details for this Samva email API endpoint.