Create a new destination

This endpoint can be used to create destinations in Census. Each destination requires a different set of credentials in the request payload. The credentials needed to create each type of connection can be found in the GET /connectors API for most destinations. For OAuth destinations, see this Notion doc.

Request schema

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Request

service_connection

object

Contains the information for the connection.

name

string

The name of this destination.

example:

Google Sheets

credentials

object

The credentials needed to create each type of connection. These can be found in the GET /connectors API for most destinations. For OAuth destinations, see this Notion doc.

type

string

The type of connection to be used for this destination. A valid type is the service_name of a connector returned from the /connectors endpoint, where the connector is marked as creatable_via_api.

Http + 1.1

POST

https://app.getcensus.com/api/v1/destinations

POST /api/v1/destinations HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Content-Type: application/json
Host: app.getcensus.com
Content-Length: 106

{
  "service_connection": {
    "name": "Google Sheets",
    "credentials": {},
    "type": "string"
  }
}

Responses

201

Destination created successfully

`201`

status

string

Outcome of the operation.

enum:

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

data

object

integer

The id of the created destination.

example:

{
  "status": "created",
  "data": {
    "id": 12
  }
}