Update activation type

Update a specific activation type by service name. You must be an owner of the activation type and it must not be published in order to update. If you wish to update a published activation type please reach out to Census Support.

Request schema

Path parameters

service_name

stringrequired

Name of the activation type to update

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Request

connector

objectrequired

label

undefined

icon_url

string

The URL to the icon for this activation type. Must be <100kb and must be image/png.

example:

https://example.com/icon.png

configuration_definition

object

your_field_id

object

string

Unique id for this field in the configuration.

example:

my_id

label

stringrequired

User-friendly label for the input.

example:

Api Token

type

stringrequired

The type of this field.

enum:

"string""boolean""integer""float"

default

undefined

The default value for this field.

anyOf:

[ { "type": "string" }, { "type": "number" }, { "type": "integer" }, { "type": "boolean" }, { "type": "array", "items": {} }, { "type": "object" } ]

user_editable

booleanrequired

Whether the user can edit this field.

default:

true

example:

true

secret

boolean

Whether the field is a secret. This ensures the frontend doesn't render secrets in plaintext.

required

boolean

Whether the field is required to set up a connection.

placeholder

string

Placeholder text for the input.

example:

Enter your API token

data

objectrequired

Configuration data for custom activation types. This defines where and how data should be sent.

url

string

The URL endpoint where data should be sent.

example:

https://api.example.com/v1/sync

headers

object

HTTP headers to include with each request.

property name *

string

additional property

Http + 1.1

PATCH

https://app.getcensus.com/api/v2/activation_types/{service_name}

PATCH /api/v2/activation_types/{service_name} HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Content-Type: application/json
Host: app.getcensus.com
Content-Length: 572

{
  "connector": {
    "label": null,
    "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://api.example.com/v1/sync",
      "headers": {
        "Content-Type": "application/json",
        "X-API-Version": "1.0"
      }
    }
  }
}

Responses

200

Activation type updated successfully

400

The request could not be processed, e.g. an invalid `type` or `group_id` was provided.

401

Invalid credentials for the requested resource.

404

Resource not found.

`200`

status

string

Outcome of the operation.

enum:

"success""updated""created""not_found""error"

data

object

documentation_slug

string

The path to this activation type's Census documentation, ie https://docs.getcensus.com/destinations/available-destinations/{documentation_slug}.

example:

braze

label

string

The name of this activation type.

example:

Braze

logo_small

string

URL to the small icon for this activation type.

example:

https://app.getcensus.com/assets/braze-icon-small.png

route_label

string

The route-friendly label for this activation type.

example:

braze

service_name

stringrequired

The full name for this activation type. This is used to identify the activation type in the API.

example:

braze

supports_test

boolean

Whether this activation type supports connection testing.

example:

true

origin

string

The origin of this activation type (census, workspace, organization).

example:

census

auth_method

string

How to authorize an activation of this type.

enum:

"credentials""oauth""other"

creatable_via_api

boolean

Whether you can create connections of this type using the Create Activation API. If you'd like to create an activation via API that isn't marked as creatable_via_api, check out the docs for our Activation Connect Links if the activation is marked as creatable_via_connect_link, or reach out to us.

creatable_via_connect_link

boolean

Whether you can create connections of this type using Census Connect Links. If you'd like to create an activation via Connect Link that isn't currently supported, please reach out to us.

configuration_fields

object

Top level object containing a list of fields needed to create an activation of this type.

fields

array

string

The name of this configuration field. This is used to identify the credential in the API to create a connection of this type.

example:

instance_url

rules

string

Validations around this field, ie 'required'

example:

required

label

string

A user facing name for this field

example:

Endpoint URL

type

string

The type of this field

enum:

"string""integer""boolean"

placeholder

string

A placeholder for this field, usually an example of its value

example:

https://rest.iad-01.braze.com

matches

string

A regex string the value must match

example:

^(?:(?=.*rest)https:\\/\\/rest|(?!.*rest)(https:\\/\\/)?sdk)\\.(iad|fra)-\\d\\d\\.braze\\.(com|eu)

is_password_type_field

boolean

If this is a credential field that contains sensitive data

possible_values

array

If this credential accepts a finite list of values, what those values are

type:

string

read_more

string

A link to read more about this activation destination, usually linking to the Census docs.

example:

https://docs.getcensus.com/destinations/available-destinations/hubspot#managing-object-associations

hint

string

A hint to the user about this field, such as instructions for how to find the value

example:

You can find your API key in the YourService UI under Settings > Integrations > API Key

show

boolean | object

Controls the visibility of this field in the UI based on the values of other fields. This is commonly used for source and destination types that support multiple authentication methods.

When show is true, the field is always visible. When show is an object, it contains conditional logic using if or unless:

if: The field is shown when the specified condition is met
unless: The field is hidden when the specified condition is met

The eq value can be either a boolean or a string, depending on the field being referenced.

For example, in Snowflake which supports both password and keypair authentication:

The password field has "show": {"unless": {"use_keypair": {"eq": true}}} - shown only when keypair auth is disabled (boolean)
The private_key_pkcs8 field has "show": {"if": {"use_keypair": {"eq": true}}} - shown only when keypair auth is enabled (boolean)

In Facebook Ads with string-based auth type:

"show": {"if": {"auth_type": {"eq": "oauth"}}} - shown only when auth_type equals "oauth" (string)

example:

true

object

Condition object specifying when to show this field. The field is shown when the condition evaluates to true.

property name *

object

additional property

boolean | string

The value (boolean or string) the referenced field must equal for this field to be shown.

unless

object

Condition object specifying when to hide this field. The field is hidden when the condition evaluates to true.

property name *

object

additional property

boolean | string

The value (boolean or string) the referenced field must equal for this field to be hidden.

conditionally_required

null | object

Specifies conditions under which this field becomes required, even if it's not listed in the rules array as required. This is used when a field's requirement status depends on the values of other fields.

When conditionally_required is null, the field's requirement is determined solely by the rules array. When it's an object, it contains conditional logic using if or unless:

if: The field becomes required when the specified condition is met
unless: The field is not required when the specified condition is met

The eq value can be either a boolean or a string, depending on the field being referenced.

For example, in Facebook Ads, auth_type controls which authentication flow is used:

When auth_type is "oauth", the oauth_token field is conditionally required: {"if": {"auth_type": {"eq": "oauth"}}} (string)
When auth_type is "system_user", the system_user_token field is conditionally required: {"if": {"auth_type": {"eq": "system_user"}}} (string)

A field could also use unless with a boolean, such as: {"unless": {"use_keypair": {"eq": true}}} - required unless keypair auth is enabled

example:

{ "if": { "auth_type": { "eq": "system_user" } } }

object

Condition object specifying when this field becomes required. The field is required when the condition evaluates to true.

property name *

object

additional property

boolean | string

The value (boolean or string) the referenced field must equal for this field to become required.

unless

object

Condition object specifying when this field is not required. The field is not required when the condition evaluates to true.

property name *

object

additional property

boolean | string

The value (boolean or string) the referenced field must equal for this field to not be required.

input_type

object

Describes the UI input type for this credential field. All input types have a type field, and some types include additional properties.

Simple input types (only type field):

textbox: Single-line text input
textarea: Multi-line text input
toggle: Boolean toggle switch
oauth: Retrieved from OAuth authentication flow
readonlytextbox: Read-only text display

Complex input types (additional fields):

select: Dropdown with predefined options
- allow_manual_inputs (boolean): Whether users can input custom values
- See possible_values field for the list of options
radio: Radio button selection
- options (object): Map of values to tile configurations with label, description, icon, and coming_soon
- hide_check_bubble (boolean): Whether to hide the selection indicator
keyvaluepairs: Key-value pair editor
- key_label (string, optional): Label for the key field (default: "Header")

type

stringrequired

The input type identifier

enum:

"textbox""textarea""toggle""select""radio""keyvaluepairs""oauth""readonlytextbox"

allow_manual_inputs

boolean

For select type only. Whether users can input custom values not in the predefined list.

options

object

For radio type only. Map of values to tile configuration objects.

property name *

object

additional property

label

string

description

string

icon

string

coming_soon

boolean

hide_check_bubble

boolean

For radio type only. Whether to hide the selection indicator.

example:

true

key_label

string

For keyvaluepairs type only. Label for the key field. Defaults to "Header" if not provided.

example:

Header

user_selectable_field_types

array

A list of field types that can be used when creating custom fields on this activation type. This field is deprecated in favor of supported_custom_field_types at the activation object level, please refer to any of the endpoints that return object information, such as listing activation objects, instead.

type

stringrequired

The data type of the field.

example:

String

array

booleanrequired

Whether this is an array type.

`400`

status

integer

HTTP status code.

enum:

"400"

message

string

Description of the validation error.

example:

Invalid type: not_a_real_type

`401`

status

integer

HTTP status code.

enum:

"401"

`404`

status

integer

HTTP status code.

enum:

"404"

{
  "status": "updated",
  "data": {
    "documentation_slug": "braze",
    "label": "Braze",
    "logo_small": "https://app.getcensus.com/assets/braze-icon-small.png",
    "route_label": "braze",
    "service_name": "braze",
    "supports_test": true,
    "origin": "census",
    "auth_method": "credentials",
    "creatable_via_api": true,
    "creatable_via_connect_link": true,
    "configuration_fields": {
      "fields": [
        {
          "id": "instance_url",
          "rules": "required",
          "label": "Endpoint URL",
          "type": "string",
          "placeholder": "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",
          "show": true,
          "conditionally_required": {
            "if": {
              "auth_type": {
                "eq": "system_user"
              }
            }
          },
          "input_type": {
            "type": "textbox"
          }
        }
      ]
    },
    "user_selectable_field_types": [
      {
        "type": "String",
        "array": false
      }
    ]
  }
}