PATCH
/
sources
/
{source_id}
/
topics
/
{topic_id}
curl --request PATCH \
  --url https://app.getcensus.com/api/v1/sources/{source_id}/topics/{topic_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "NewAppUsers",
  "sample_message": {
    "name": "Jill",
    "id": "1",
    "email": "Jill@foo.com"
  },
  "description": "Users that have signed up for our product in the last week."
}'
{
  "status": "updated",
  "data": {
    "id": 18,
    "name": "NewAppUsers",
    "description": "Users that have signed up for our product in the last week.",
    "created_at": "2021-10-20T02:43:07.120Z",
    "updated_at": "2021-10-20T02:50:35.477Z",
    "schema": {
      "name": "string",
      "id": "number",
      "email": "string"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.

Path Parameters

​
source_id
integer
required

ID of the source

​
topic_id
integer
required

ID of the topic

Body

application/json
​
name
string

The name of this topic.

Example:

"NewAppUsers"

​
sample_message
object

An example of the structure of a message that would be pushed to this topic.

Example:
{
  "name": "Jill",
  "id": "1",
  "email": "Jill@foo.com"
}
​
description
string

The description for this topic.

Example:

"Users that have signed up for our product in the last week."

Response

200
application/json
Successfully updated the topic
​
status
enum<string>

Outcome of the operation.

Available options:
updated,
error
Example:

"updated"

​
data
object

Was this page helpful?

Raise issue