Update a project
Change a project's settings. Only the fields you send are changed.
/v1/admin/projects/{slug}Admin keySend only the fields you want to change. The slug can't be changed.
Path parameters
The project slug.
Body parameters
A new display name, 1 to 200 characters.
Replaces the whole list; at least one domain. If the project's current defaultFrom is not on the new list (and you don't send a new defaultFrom in the same request), the request fails with 400 invalid_body. Per-domain senders for domains that are no longer on the list are dropped.
A new default sender, which must be on the allowed domains. null removes it, after which every send must include from.
Replaces the list of exact addresses allowed in from. null removes the restriction.
Merged into the stored map, not a replacement:
- A domain set to a sender adds or changes that domain's sender.
- A domain set to
nullremoves that domain's sender. - Domains you don't list keep their sender.
nullfor the whole field removes every per-domain sender.
Each key must be one of the allowed domains (after this request's allowedDomains, if you send both), and each sender must be an address on that key's domain.
Allow or block sends over the MailerRpc service binding.
Live emails per UTC day. 0 means no limit.
Default for open tracking.
Default for click tracking.
Allow or block broadcasts. A broadcast that is already sending is canceled on its next cron tick once this is false.
true disables the project and sets disabledAt (an already disabled project keeps its original disabledAt). false enables it again and clears disabledAt. Disable a project is a shortcut for { "disabled": true }.
Response
Status 200 with the updated project.
Errors
| Status | Code | When |
|---|---|---|
| 400 | invalid_body | A field is malformed, or a sender is not on an allowed domain. param names the field, for example domainSenders.acme.com. |
| 404 | project_not_found | No project has this slug. |