An inbox's out-of-hours reply: the message, and whether it is sent

GET

/v1/inbox/settings/out-of-hours-reply

const url = 'https://api.threadkite.app/v1/inbox/settings/out-of-hours-reply';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.threadkite.app/v1/inbox/settings/out-of-hours-reply \
  --header 'Authorization: Bearer <token>'

inboxId, else your default inbox. The out-of-hours reply automation, as one message that is on or off. simple is false when the inbox has more than one, or one with conditions or for every inbox; those are changed in Automations.

Authorizations

api_key
threads:read

Parameters

Query Parameters

inboxId

The inbox (your default inbox when left out)

string format: uuid

The inbox (your default inbox when left out)

Responses

200

application/json

object

inboxId

required

The inbox it is for

string format: uuid

simple

required

False when the inbox has more than one out-of-hours reply, or one with conditions (sources, locations or channels): change those in Automations

boolean

enabled

required

Whether it is sent (the automation is live; when not simple, whether any of them is)

boolean

subject

required

Email subject (null: the usual reply subject)

string

nullable

body

required

The message sent, with merge fields such as {{contact.firstName}}: the automation’s (or its saved reply’s), or the suggested wording when there is none yet

string

bodyHtml

required

The message formatted, as HTML with merge fields; null when plain

string

nullable

appliesTo

required

New leads only, or every message from a contact

string

Allowed values: leads all

flowId

required

The out-of-hours reply automation (null before there is one)

string format: uuid

nullable

savedReplyId

required

The shared saved reply it sends, when it sends one rather than its own wording (null otherwise, or if the reply was deleted or made personal)

string format: uuid

nullable

autoReplyCount

required

How many out-of-hours reply automations the inbox has

number

Example

{
  "appliesTo": "leads",
  "autoReplyCount": 1
}

401

Missing or invalid API key

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

402

The organisation is on the Free plan (code upgrade_required)

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

feature

required

The feature that needs Pro

string

nullable

Allowed values: extraSeats connections aiAssistant aiReplies rules fullReports api inboxes bulkMessages videoMessages

upgradePath

required

Where to upgrade or pay, in the web app

string

Example

{
  "statusCode": 402,
  "code": "upgrade_required",
  "message": "Connections are part of Pro. Upgrade to connect texts, calls and more.",
  "feature": "extraSeats",
  "upgradePath": "/settings/billing"
}

403

The key does not have the scope (or the person the permission)

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

429

Rate limit reached

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

retryAfter

required

Seconds until another request will be accepted

number

Example

{
  "statusCode": 429,
  "code": "rate_limited",
  "message": "Too many requests. Each key can make 120 requests a minute; try again in 12 seconds.",
  "retryAfter": 12
}