Skip to content
ThreadkiteThreadkite Docs

Change an item

PATCH
/v1/items/{id}
curl --request PATCH \
  --url https://api.threadkite.app/v1/items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "attributes": { "title": "Merino jumper", "description": "example", "link": "https://example.com", "imageLinks": [ "https://example.com" ], "price": { "amountMinor": 1299500, "currency": "GBP" }, "salePrice": { "amountMinor": 1299500, "currency": "GBP" }, "availability": "in_stock", "condition": "new", "brand": "example", "gtin": "example", "mpn": "example", "sku": "example", "googleProductCategory": "example", "productType": "example", "itemGroupId": "example", "size": "example", "colour": "example", "material": "example", "pattern": "example", "customLabel0": "example", "customLabel1": "example", "customLabel2": "example", "customLabel3": "example", "customLabel4": "example" }, "billing": "one_off", "addOn": true, "addOnFor": [ "example" ] }'

Attribute fields sent replace the current ones and null clears an optional field; the result is validated as a whole.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
locationId
string format: uuid
nullable
attributes
One of:
object
title

Google/Meta title

string
<= 150 characters

Example 

Merino jumper
description

Google/Meta description

string
nullable <= 5000 characters
link

Product page. Google/Meta link

string format: uri
nullable
imageLinks

Main image first. Google/Meta image_link and additional_image_link

Array<string>
nullable <= 11 items
price

Google/Meta price

object
amountMinor
required

Amount in minor units (pence, cents)

number

Example 

1299500
currency
required

ISO 4217

string

Example 

GBP
salePrice
One of:
object
amountMinor
required

Amount in minor units (pence, cents)

number

Example 

1299500
currency
required

ISO 4217

string

Example 

GBP
availability

Google/Meta availability

string
default: in_stock nullable
Allowed values: in_stock out_of_stock preorder backorder
condition

Google/Meta condition

string
default: new nullable
Allowed values: new refurbished used
brand

Google/Meta brand

string
nullable <= 70 characters
gtin

GTIN-8, 12, 13 or 14. Google/Meta gtin

string
nullable
mpn

Google/Meta mpn

string
nullable <= 70 characters
sku

Your own stock code

string
nullable <= 100 characters
googleProductCategory

Google/Meta google_product_category

string
nullable <= 750 characters
productType

Google/Meta product_type

string
nullable <= 750 characters
itemGroupId

Shared by variants. Google/Meta item_group_id

string
nullable <= 50 characters
size

Google/Meta size

string
nullable <= 100 characters
colour

Google/Meta color

string
nullable <= 100 characters
material

Google/Meta material

string
nullable <= 200 characters
pattern

Google/Meta pattern

string
nullable <= 100 characters
customLabel0

Google/Meta custom_label_0

string
nullable <= 100 characters
customLabel1

Google/Meta custom_label_1

string
nullable <= 100 characters
customLabel2

Google/Meta custom_label_2

string
nullable <= 100 characters
customLabel3

Google/Meta custom_label_3

string
nullable <= 100 characters
customLabel4

Google/Meta custom_label_4

string
nullable <= 100 characters
billing

How the price is charged: one_off (once, the default for a new item), monthly or annual. Left out, an existing item keeps its own

string
Allowed values: one_off monthly annual

Example 

monthly
addOn

Usually sold as an add-on to something else (suggested when adding add-ons)

boolean
addOnFor

The item types it is usually added to; empty means anything

Array<string>
<= 20 items

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
One of: discriminator: type
object
id
required
string format: uuid
source
required

Where the item came from: manual, csv, api or an integration key

string
externalId
required

The item’s id in its source

string
locationId
required
string format: uuid
nullable
title
required

From the attributes

string
status
required

The availability: in_stock, out_of_stock, preorder or backorder for products; an industry pack’s item types have their own

string
price
required
One of:
object
amountMinor
required

Amount in minor units (pence, cents)

number
currency
required

ISO 4217

string
billing
required

How the price is charged: one_off (once), monthly (every month) or annual (every year)

string
Allowed values: one_off monthly annual
images
required

Image links, main image first

Array<string>
archivedAt
required

When it was removed from the catalogue (no longer in stock). Removed items stay on the leads and threads that mention them

string format: date-time
nullable
url
required

Advert or product page

string
nullable
addOn
required

Usually sold as an add-on to something else (a warranty, delivery, an onboarding package). Suggestions only

boolean
addOnFor
required

The item types it is usually added to; empty means anything

Array<string>
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
attributes
required
object
title
required

Google/Meta title

string
<= 150 characters
description

Google/Meta description

string
<= 5000 characters
link

Product page. Google/Meta link

string format: uri
imageLinks

Main image first. Google/Meta image_link and additional_image_link

Array<string>
<= 11 items
price
required

Google/Meta price

object
amountMinor
required

Amount in minor units (pence, cents)

number
currency
required

ISO 4217

string
salePrice

Google/Meta sale_price

object
amountMinor
required

Amount in minor units (pence, cents)

number
currency
required

ISO 4217

string
availability

Google/Meta availability

string
default: in_stock
Allowed values: in_stock out_of_stock preorder backorder
condition

Google/Meta condition

string
default: new
Allowed values: new refurbished used
brand

Google/Meta brand

string
<= 70 characters
gtin

GTIN-8, 12, 13 or 14. Google/Meta gtin

string
mpn

Google/Meta mpn

string
<= 70 characters
sku

Your own stock code

string
<= 100 characters
googleProductCategory

Google/Meta google_product_category

string
<= 750 characters
productType

Google/Meta product_type

string
<= 750 characters
itemGroupId

Shared by variants. Google/Meta item_group_id

string
<= 50 characters
size

Google/Meta size

string
<= 100 characters
colour

Google/Meta color

string
<= 100 characters
material

Google/Meta material

string
<= 200 characters
pattern

Google/Meta pattern

string
<= 100 characters
customLabel0

Google/Meta custom_label_0

string
<= 100 characters
customLabel1

Google/Meta custom_label_1

string
<= 100 characters
customLabel2

Google/Meta custom_label_2

string
<= 100 characters
customLabel3

Google/Meta custom_label_3

string
<= 100 characters
customLabel4

Google/Meta custom_label_4

string
<= 100 characters
type
required
string
Allowed values: product

Example 

{
  "source": "my-dms",
  "externalId": "SKU-1042",
  "title": "Oak dining table",
  "status": "in_stock",
  "price": {
    "amountMinor": 1299500,
    "currency": "GBP"
  },
  "billing": "one_off",
  "addOnFor": [
    "product"
  ],
  "attributes": {
    "title": "Merino jumper",
    "price": {
      "amountMinor": 1299500,
      "currency": "GBP"
    },
    "salePrice": {
      "amountMinor": 1299500,
      "currency": "GBP"
    },
    "availability": "in_stock",
    "condition": "new"
  },
  "type": "product"
}

400

Section titled “400”
Media typeapplication/json
object
statusCode
required
number
code
required

Stable machine-readable reason

string
message
required
string
errors
required
Array<object>
object
path
required

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

string
message
required
string

Example 

{
  "statusCode": 400,
  "code": "invalid_attributes",
  "message": "Enter the make",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

401

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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
}