Get the sending rules

Pacing, new people per day, quiet hours, stop words, expiry and which chats the Mac copies.

Needs a key with the account:read scope. Keys and scopes

Example

curl "https://usebluebot.com/api/v1/settings" \
  -H "Authorization: Bearer $BLUEBOT_API_KEY"

Response

200: The settings.

• object"settings"required
• business_namestring or nullrequired

  Your business’s name, which {{business}} fills in. Null until you set it; texts that would name the business leave it out until then.

• time_zonestringrequired

  The zone quiet hours and daily limits are read in.

• pace_secondsintegerrequired

  Seconds between two texts leaving the Mac, 5 to 300.

• new_people_per_dayintegerrequired

  How many people you have never texted with BlueBot may be texted in a day, 0 to 1,000.

• quiet_hoursobjectrequired
  Show its 3 fieldsHide its fields

  • enabledbooleanrequired
  • startstringrequired

    When quiet hours start, in time_zone.

  • endstringrequired

    When they end.

• smart_quiet_hoursbooleanrequired

  Read quiet hours in the recipient’s zone, from their area code, where BlueBot knows it.

• stop_wordsobjectrequired
  Show its 4 fieldsHide its fields

  • enabledbooleanrequired

    Whether a reply of only a stop word puts the person on the stop list.

  • wordsarray of stringsrequired

    The stop words: your own list, or the defaults when custom is false.

  • custombooleanrequired

    Whether you changed the list. False means BlueBot’s defaults.

  • start_wordsarray of stringsrequired

    Words that take a person who stopped by reply off the list again.

• expiry_hoursintegerrequired

  A text still waiting this long after it was due expires, 1 to 168.

• inbound_modestringrequired

  Which chats the Mac copies to BlueBot: replies (people BlueBot has texted) or everything.

  One of replies, everything.

• paused_untiltimestamp or nullrequired

  While you have sending paused, until when.

• platform_daily_limitintegerrequired

  BlueBot’s ceiling on texts a day, which you can’t change.

• warningsarray of stringsrequired

  Things worth knowing about these settings, in words.

{
  "object": "settings",
  "business_name": "Dana Realty",
  "time_zone": "America/Chicago",
  "pace_seconds": 20,
  "new_people_per_day": 50,
  "quiet_hours": {
    "enabled": true,
    "start": "21:00",
    "end": "08:00"
  },
  "smart_quiet_hours": false,
  "stop_words": {
    "enabled": true,
    "words": [
      "stop",
      "stopall",
      "unsubscribe",
      "cancel",
      "end",
      "quit"
    ],
    "custom": false,
    "start_words": [
      "start",
      "unstop",
      "yes"
    ]
  },
  "expiry_hours": 24,
  "inbound_mode": "replies",
  "paused_until": null,
  "platform_daily_limit": 1000,
  "warnings": []
}

Errors

Every refusal has the same envelope and a page of its own. These are the ones this operation can give.

Try it