update_project_settings

Arguments

• object
• project_idstring · uuidrequired

  The project’s id.

• namestring

  The new name; leave it out to keep the name.

• settingsSettingsArguments

  Settings to change; the rest keep their values.

  11 fields

  • SettingsArguments object
  • auto_footerboolean | null

    Add an unsubscribe footer when a template has none.

  • brandingBrandingArguments

    Branding of the public pages.

    4 fields

    • BrandingArguments object
    • brand_namestring | null

      The name the pages show, 1 to 128 characters.

    • languagestring | null

      en or ru.

    • support_emailstring | null

      The address the pages give for questions.

    • text_overridesmap of string → string | null

      Texts of the pages by key, replacing every override at once: at most 64, keys [a-z][a-z0-9_]*, texts 1 to 2000 characters.

  • daily_send_quotainteger · int64 | null

    Most messages a day, 1 or more; null: no quota.

  • default_throttle_per_hourinteger · int64 | null

    Default campaign speed, messages an hour; null: no limit.

  • dns_credentialsDnsCredentialsArguments

    The project’s DNS-provider credentials.

    1 fields

    • DnsCredentialsArguments object
    • porkbunPorkbunCredentialsArguments | null

      Porkbun credentials; set them, null clears them, left out keeps them. They override the node’s global [dns.porkbun].

      2 fields

      • PorkbunCredentialsArguments object · all fields required
      • api_keystring

        The Porkbun API key.

      • secret_api_keystring

        The Porkbun secret API key.

  • from_emailstring | null

    Default sender address of campaigns.

  • from_namestring | null

    Default sender name of campaigns, 1 to 128 characters, no line breaks.

  • reply_tostring | null

    Default Reply-To address.

  • soft_bounce_suppress_afterinteger · int64 | null

    Soft bounces in a row after which an address is suppressed; null: off.

  • trackingTrackingArguments

    Tracking defaults.

    2 fields

    • TrackingArguments object
    • clicksboolean | null

      Click redirects.

    • opensboolean | null

      Open pixel.

  • transportstring | null

    Default transport: direct or relay:<name> of a relay the node offers (get_server_info); null: the node’s default.

No other arguments are accepted.

Result

The result comes back as structuredContent, with the same JSON as a text block.

• object · all fields required
• created_atstring · date-time
• deleted_atstring · date-time | null

  When the project was deleted; null while it is live. A deleted project can only be read.

• idstring · uuid
• namestring
• settingsProjectSettings

  A project’s settings, every field present.

  11 fields

  • ProjectSettings object · all fields required
  • auto_footerboolean

    Add an unsubscribe footer when a template has none.

  • brandingBranding

    How the public pages look.

    4 fields

    • Branding object · all fields required
    • brand_namestring | null
    • languagePageLanguage

      The language of the public pages.

      • en
      • ru
    • support_emailstring | null
    • text_overridesmap of string → string

      Texts of the pages by key.

  • daily_send_quotainteger · uint32 | null

    Most messages a day; null: no quota.

    ≥ 0

  • default_throttle_per_hourinteger · uint32 | null

    Default campaign speed, messages an hour; null: no limit.

    ≥ 0

  • dns_credentialsDnsCredentials

    Which DNS providers the project set its own credentials for; the credentials themselves are never returned.

    1 fields

    • DnsCredentials object · all fields required
    • porkbunboolean

      Whether the project set its own Porkbun credentials.

  • from_emailstring | null

    Default sender address of campaigns.

  • from_namestring | null

    Default sender name of campaigns.

  • reply_tostring | null

    Default Reply-To.

  • soft_bounce_suppress_afterinteger · uint32 | null

    Soft bounces in a row after which an address is suppressed; null: off.

    ≥ 0

  • trackingTracking

    What campaigns track by default.

    2 fields

    • Tracking object · all fields required
    • clicksboolean
    • opensboolean
  • transportstring | null

    Default transport, direct or relay:<name>; null: the node’s default.

• slugstring

  Unique among live projects; it never changes.

• updated_atstring · date-time

  The latest change: creation, rename, settings, deletion.

Definitions

Errors

A failed call answers isError: true with a code from the same table as the HTTP API, and detail. How tools report errors

HTTP API

The same operation over HTTP: PATCH /api/v1/projects/{project_id}