Name an event type, or show it on the timeline

PATCH

/v1/event-types/{name}

curl --request PATCH \
  --url https://api.threadkite.app/v1/event-types/finance.agreement_ending \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "label": "example", "showOnTimeline": true }'

• Threadkite API

With showOnTimeline, events of this type sent through the API add a line to the contact’s thread. Events Threadkite records itself cannot be shown again.

Authorizations

• api_key
  events:write

Parameters

Path Parameters

name

required

string

Example

finance.agreement_ending

Request Body^required

Media typeapplication/json

object

label

Null goes back to the standard label

string

nullable >= 1 characters <= 80 characters

showOnTimeline

Add a line to the contact’s thread for API-sent events

boolean

Example ^generated

{
  "label": "example",
  "showOnTimeline": true
}

Responses

200

Media typeapplication/json

object

name

required

event.<name> for events from other systems

string

label

required

string

internal

required

Recorded by Threadkite itself (never shown as a timeline line)

boolean

standard

required

A standard type (core or your industry pack)

boolean

showOnTimeline

required

API-sent events of this type add a line to the contact’s thread

boolean

lastSeenAt

required

string format: date-time

nullable

propertyKeys

required

Property keys seen on these events

Array<string>

properties

required

The properties a standard type carries

Array<object>

object

key

required

string

label

required

string

type

required

string

Allowed values: text number date boolean

Example

{
  "name": "event.order.paid",
  "label": "Finance agreement ending",
  "properties": [
    {
      "key": "endDate",
      "label": "End date",
      "type": "text"
    }
  ]
}

400

Media typeapplication/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"
    }
  ]
}

401

Missing or invalid API key

Media typeapplication/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)

Media typeapplication/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)

Media typeapplication/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"
    }
  ]
}

404

Media typeapplication/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

Media typeapplication/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
}