Update topic
Update certain values of a specified topic
Request schema
Path parameters
source_id
integerrequired
ID of the source
topic_id
integerrequired
ID of the topic
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Request
name
string
The name of this topic.
example:
sample_message
object
An example of the structure of a message that would be pushed to this topic.
example:
description
string
The description for this topic.
example:
Http + 1.1
PATCH
https://app.getcensus.com/api/v1/sources/{source_id}/topics/{topic_id}
PATCH /api/v1/sources/{source_id}/topics/{topic_id} HTTP/1.1 Authorization: Bearer REPLACE_BEARER_TOKEN Content-Type: application/json Host: app.getcensus.com Content-Length: 197 { "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." }
Responses
200
Successfully updated the topic
400
Missing property or improperly formatted topic name
404
Http request source not located
405
Connection parameter associated with connection not of type HTTPRequestConnection
409
Topic with name already exists for connection
200
status
string
Outcome of the operation.
enum:
data
object
id
integer
The id of this topic.
example:
name
string
The name of this topic.
example:
description
string
The description for this topic.
example:
created_at
string
When this topic was created.
format:
example:
updated_at
string
When this topic was last updated.
format:
example:
schema
object
The fields available to be used in syncs, extracted from the sample message along with their respective types
example:
400
status
string
Outcome of the operation.
example:
message
string
Description of the outcome.
example:
404
status
string
Outcome of the operation.
example:
message
string
Description of the outcome.
example:
405
status
string
Outcome of the operation.
example:
message
string
Description of the outcome.
example:
409
status
string
Outcome of the operation.
example:
message
string
Description of the outcome.
example:
{ "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" } } }