Rename or describe a topic

PATCH/v1/topics/{id}

Path Parameters

idstringrequired

Body Parameters

namestring
At most 60 characters.
descriptionstring
At most 200 characters. Nullable.

Responses

200Topic
The topic
401Error
Missing, malformed, or revoked API key
402Error
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404Error
Not found
409Error
A topic with that name exists
429Error
Rate limit or quota exceeded

Response Fields

idstring
Example: tp_marketing.
objecttopic
namestring
descriptionstring
Nullable.
builtinboolean
created_atstring (date-time)
updated_atstring (date-time)

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

401
Missing, malformed, or revoked API key
402
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
404
Not found
409
A topic with that name exists
429
Rate limit or quota exceeded

const res = await fetch('https://api.jointextkit.com/v1/topics/tp_marketing', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Response 200

{
  "id": "tp_marketing",
  "object": "topic"
}