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
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.
Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.
Contains the information for the connection.
The name of this destination.
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.
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.
Authorizations
Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.
Body
Contains the information for the connection.
The name of this destination.
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.
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.
Response
Outcome of the operation.
success, updated, created, not_found, error The id of this destination.
The name of this destination.
When the connection was created
An ordered array of steps representing the results of the last connection test. If one step fails then we won't surface details on later steps.
The name of the step in the connection test process.
The error message associated with the step, if any.
The status of the step.
running, success, failed, warning Indicates if the last connection test to this destination was successful.
Timestamp of when the last connection test was conducted on this destination.
Connection details associated with this destination.
A list of objects associated with this destination.
The label for this object.
The full name for this object. This is used to identify the object in the API.
A list of the operations this object supports when being synced to.
append, insert, mirror, update, upsert Whether or not you can define custom fields on this object.
Whether or not field names and labels are case sensitive on this object.
Whether or not you can set the field_order attribute on a sync to this object. Valid field_order configurations are alphabetical_column_name and mapping_order.
Whether or not you can create a sync to this object. This will be false if the object has been deleted.
A list of fields associated with this destination.
The label for this field.
The full name for this field. This is used to identify the field in the API.
Whether or not this field can be created in the destination if it doesn't exist.
Whether or not this field can be updated in the destination.
For an array type, what operations are supported on this field. One of the following types:
overwrite: Overwrite existing values with inputted valuesmerge: Merge inputted values with existing values
overwrite, merge Whether or not this field is an array type.
If a value exists in the destination for this field, whether or not it can be overwritten by Census.
Whether or not this field is required.
Whether or not this field can be the primary identifier for an upsert sync.
Whether or not this field can be the primary identifier for an update only sync.
Whether or not this field can be the primary identifier for a create only sync.
Whether or not this field can be the identifier for a lookup on its containing object.
What object, if any, that this field references.
The type of this field.
Was this page helpful?