Publish destination type to organization

PUT

connectors

{service_name}

publish_to_organization

curl --request PUT \
  --url https://app.getcensus.com/api/v1/connectors/{service_name}/publish_to_organization \
  --header 'Authorization: Bearer <token>'

{
  "status": "published_to_organization",
  "data": {
    "documentation_slug": "braze",
    "label": "Braze",
    "service_name": "braze",
    "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",
          "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

Authorization

string

header

required

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

Path Parameters

service_name

string

required

Name of the destination type to publish

Response

200 - application/json

Connector published successfully

status

enum<string>

Outcome of the operation.

Available options:

published_to_organization,

not_found,

error

data

object

data.service_name

string

required

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

data.documentation_slug

string

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

data.label

string

The name of this destination type.

data.auth_method

enum<string>

How to authorize a destination of this type of destination type.

Available options:

credentials,

oauth,

other

data.creatable_via_api

boolean

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

data.creatable_via_connect_link

boolean

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

data.configuration_fields

object

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

Was this page helpful?

Raise issue

Update destination type Delete destination type

curl --request PUT \
  --url https://app.getcensus.com/api/v1/connectors/{service_name}/publish_to_organization \
  --header 'Authorization: Bearer <token>'

{
  "status": "published_to_organization",
  "data": {
    "documentation_slug": "braze",
    "label": "Braze",
    "service_name": "braze",
    "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",
          "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"
        }
      ]
    }
  }
}

Introduction

Organization APIs

Workspace APIs

Publish destination type to organization

Authorizations

Path Parameters

Response