Introduction
Organization APIs
- Users
- Invitations
- Workspaces
Workspace APIs
- Syncs
- Sync Management Links
- Sync Runs
- Destination Types
- Destinations
- Destination Connect Links
- Source Types
- Sources
- Source Connect Links
- Segment Management Links
- Webhooks
Destination Types
Update destination type
Update a specific destination type by service name. You must be an owner of the destination type and it must not be published in order to update. If you wish to update a published destination type please reach out to Census Support.
PATCH
/
connectors
/
{service_name}
curl --request PATCH \
--url https://app.getcensus.com/api/v1/connectors/{service_name} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"connector": {
"label": "Braze",
"icon_url": "https://example.com/icon.png",
"configuration_definition": {
"your_field_id": {
"id": "my_id",
"label": "Api Token",
"type": "string",
"default": "<string>",
"user_editable": true,
"secret": false,
"required": false,
"placeholder": "Enter your API token"
}
},
"data": {
"url": "https://example.com",
"headers": {
"Authorization": "Bearer {{ api_token }}"
}
}
}
}'
{
"status": "updated",
"data": {
"documentation_slug": "braze",
"label": "Braze",
"service_name": "braze",
"auth_method": "credentials",
"creatable_via_api": true,
"creatable_via_connect_link": true,
"source_creatable_via_connect_link": true,
"configuration_fields": {
"fields": [
{
"id": "instance_url",
"rules": "required",
"label": "Endpoint URL",
"type": "string",
"placholder": "https://rest.iad-01.braze.com",
"matches": "^(?:(?=.*rest)https:\\\\/\\\\/rest|(?!.*rest)(https:\\\\/\\\\/)?sdk)\\\\.(iad|fra)-\\\\d\\\\d\\\\.braze\\\\.(com|eu)",
"is_password_type_field": false,
"possible_values": [
"<string>"
],
"read_more": "https://docs.getcensus.com/destinations/available-destinations/hubspot#managing-object-associations",
"hint": "You can find your API key in the YourService UI under Settings > Integrations > API Key\n",
"input_type": "textbox"
}
]
}
}
}
Authorizations
Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.
Path Parameters
Name of the destination type to update
Body
application/json
Response
200 - application/json
Connector updated successfully
The response is of type object
.
Was this page helpful?
curl --request PATCH \
--url https://app.getcensus.com/api/v1/connectors/{service_name} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"connector": {
"label": "Braze",
"icon_url": "https://example.com/icon.png",
"configuration_definition": {
"your_field_id": {
"id": "my_id",
"label": "Api Token",
"type": "string",
"default": "<string>",
"user_editable": true,
"secret": false,
"required": false,
"placeholder": "Enter your API token"
}
},
"data": {
"url": "https://example.com",
"headers": {
"Authorization": "Bearer {{ api_token }}"
}
}
}
}'
{
"status": "updated",
"data": {
"documentation_slug": "braze",
"label": "Braze",
"service_name": "braze",
"auth_method": "credentials",
"creatable_via_api": true,
"creatable_via_connect_link": true,
"source_creatable_via_connect_link": true,
"configuration_fields": {
"fields": [
{
"id": "instance_url",
"rules": "required",
"label": "Endpoint URL",
"type": "string",
"placholder": "https://rest.iad-01.braze.com",
"matches": "^(?:(?=.*rest)https:\\\\/\\\\/rest|(?!.*rest)(https:\\\\/\\\\/)?sdk)\\\\.(iad|fra)-\\\\d\\\\d\\\\.braze\\\\.(com|eu)",
"is_password_type_field": false,
"possible_values": [
"<string>"
],
"read_more": "https://docs.getcensus.com/destinations/available-destinations/hubspot#managing-object-associations",
"hint": "You can find your API key in the YourService UI under Settings > Integrations > API Key\n",
"input_type": "textbox"
}
]
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.