Skip to content
ThreadkiteThreadkite Docs

Set or clear months of campaign spend

PUT
/v1/campaign-spend
curl --request PUT \
  --url https://api.threadkite.app/v1/campaign-spend \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "entries": [ { "campaignId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "month": "2026-09", "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "amountMinor": 1 } ] }'

Amounts are in minor units of your currency; a null amount clears that month. Answers with the months changed. Managers and above, who see every inbox. Part of Pro.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
entries
required
Array<object>
>= 1 items <= 500 items
object
campaignId
required
string format: uuid
month
required
string
/^\d{4}-(0[1-9]|1[0-2])$/

Example 

2026-09
locationId

Null or left out: the whole organisation

string format: uuid
nullable
amountMinor
required

Minor units; null clears the month (no spend entered)

integer
nullable <= 10000000000

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
currency
required
string
months
required
Array<string>
campaigns
required

A to Z

Array<object>
object
campaignId
required
string format: uuid
name
required
string
platform
required
string
Allowed values: google microsoft meta tiktok email other
archived
required

Archived: shown only when it has spend

boolean
locations
required
Array<object>
object
locationId
required
string format: uuid
name
required
string
entries
required
Array<object>
object
campaignId
required
string format: uuid
month
required

YYYY-MM

string
locationId
required

Null: the whole organisation

string format: uuid
nullable
amountMinor
required
number

Example 

{
  "currency": "GBP",
  "months": [
    "2026-08",
    "2026-09"
  ],
  "campaigns": [
    {
      "name": "Spring sale",
      "platform": "google"
    }
  ],
  "entries": [
    {
      "month": "2026-09",
      "amountMinor": 125000
    }
  ]
}

400

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

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

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
}