Change the settings

Before you call

Credential

Authorization: Bearer $KEY

Scope

contacts:admin

Sdk

contacts.settings.save

Cli

contacts settings save

Request bodyapplication/json, required

• senderNamestring
  At most 100 characters.
• senderAddressstring
  The postal address that goes in every marketing email footer At most 300 characters.
• fromEmailstring or null
• replyTostring or null
• sendingDomainstring or null
• widgetDomainstring or null
• doubleOptInboolean
• policyVersionstring
  At most 40 characters.
• policyUrlstring (uri) or null
• defaultCountrystring or null
• customFieldslist of object
  • keystringrequired
    Pattern: ^[a-z][a-z0-9_]{0,39}$.
  • labelstringrequired
    At most 80 characters.
  • typestringrequired
    One of: text, number, boolean, date, select.
  • optionslist of string
  • sensitiveboolean
• autonomyobject
  • campaignsstring
    One of: human_review, assisted, autonomous.
  • autoSendCapinteger
    At least 0. At most 1000000.
  • agentDefaultobject
    • readboolean
      Default: true.
    • writeboolean
      Default: false.
    • sendboolean
      Default: false.
    • viewstring
      One of: basic, full. Default: basic.
    • maxExportinteger
      Default: 0. At least 0. At most 10000.
  • agentsobject
• limitsobject
  • perHourinteger
    At least 1.
  • perDayinteger
    At least 1.
• trackOpensboolean
• trackClicksboolean
• testModeboolean
• testRecipientslist of string
• smsobject
  • numberIdstring or null
  • quietFromstring
    Pattern: ^\d{2}:\d{2}$.
  • quietTostring
    Pattern: ^\d{2}:\d{2}$.
  • timezonestring or null
  • maxSegmentsinteger
    At least 1. At most 6.
• hubspotobject
  • enabledbooleanrequired
  • connectionIdstring
    At most 80 characters.
  • directionstring
    One of: pull, push, both. Default: both.

Responses

• 200application/json
  Success

  object

• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring