Mark an appointment confirmed, attended or missed

POST

/v1/appointments/{id}/status

curl --request POST \
  --url https://api.threadkite.app/v1/appointments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/status \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "booked" }'

• Threadkite API

Authorizations

• api_key
  appointments:write

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

status

required

confirmed when they confirm; after it, completed (they came) or no_show

string

Allowed values: booked confirmed no_show completed

Responses

200

Media typeapplication/json

object

id

required

string format: uuid

threadId

required

string format: uuid

inboxId

required

The thread’s inbox

string format: uuid

contact

required

One of:

object

object

id

required

string format: uuid

name

required

string

nullable

type

required

string

typeLabel

required

string

startsAt

required

string format: date-time

endsAt

required

string format: date-time

timeZone

required

The time zone it is written in

string

status

required

string

Allowed values: booked confirmed cancelled no_show completed

host

required

One of:

object

object

id

required

string

name

required

string

locationId

required

string format: uuid

nullable

item

required

One of:

object

object

id

required

string format: uuid

title

required

string

notes

required

string

nullable

notifyChannel

required

The channel the customer is told on (null: not told)

string

nullable

Allowed values: email sms whatsapp

notifyFailure

required

Why the latest message to the customer wasn’t sent, if it wasn’t

string

nullable

cancelledReason

required

Why it was cancelled (for the team)

string

nullable

createdBy

required

One of:

object

object

id

required

string

name

required

string

canEdit

required

You can move, cancel and mark it

boolean

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "contact": {
    "name": "Sarah Turner"
  },
  "type": "consultation",
  "typeLabel": "Consultation",
  "timeZone": "Europe/London",
  "status": "booked",
  "host": {
    "id": "usr_8f2c",
    "name": "James Patel"
  },
  "item": {
    "title": "Oak dining table"
  },
  "notifyChannel": "email",
  "notifyFailure": "They have opted out of texts.",
  "createdBy": {
    "id": "usr_8f2c",
    "name": "James Patel"
  }
}

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"
    }
  ]
}

409

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
}