Create a new destination

POST

destinations

Authorizations

Authorization

string

headerrequired

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

Body

application/json

service_connection

object

Contains the information for the connection.

Response

201 - application/json

status

enum<string>

Outcome of the operation.

Available options:

success,

updated,

created,

not_found,

error

data

object

data.id

integer

The id of this destination.

data.name

string

The name of this destination.

data.created_at

string

When the connection was created

data.last_test_results

object

data.last_test_succeeded

boolean | null

Indicates if the last connection test to this destination was successful.

data.last_tested_at

string | null

Timestamp of when the last connection test was conducted on this destination.

data.connection_details

object

Connection details associated with this destination.

data.objects

object[]

A list of objects associated with this destination.

data.objects.label

string

The label for this object.

data.objects.full_name

string

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

data.objects.supported_operations

enum<string>[]

A list of the operations this object supports when being synced to.

Available options:

append,

insert,

mirror,

update,

upsert

data.objects.allow_custom_fields

boolean

Whether or not you can define custom fields on this object.

data.objects.allow_case_sensitive_fields

boolean

Whether or not field names and labels are case sensitive on this object.

data.objects.supports_field_ordering

boolean

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.

data.objects.fields

object[]

A list of fields associated with this destination.

Was this page helpful?

List destinations Fetch destination

Introduction

Organization APIs

Workspace APIs

Authorizations

Body

Response