apply_mail_setup
Apply a prepared email setup plan to a client's account. Requires explicit approval only when replacing an existing record; otherwise, it executes safely and returns the changes made.
Instructions
Carry out a plan from plan_mail_setup.
Returns what was published and what was left unchanged, plus a run_id.
When approval is needed and not given it returns needs_approval and
changes nothing, so calling it again with approved=true is safe.
approved is required only for records that already exist. Creating one
that is absent is not a judgement call; replacing one somebody published
is theirs to make, so show them the plan first.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| client | Yes | The client to act on, by the name you registered them under. A write resolves this one client's credentials and no other. | |
| plan_id | Yes | The plan_id that plan_mail_setup returned. A plan made for a different client is refused. | |
| approved | No | Required only when the plan would replace a record that already exists. That is the client's decision, so show them the plan before setting this. |