Creates a connector.

POST

/api/v1/workspaces/{workspace_id}/connectors

Creates a new connector.

Authorizations

• CookieAuth
• BearerAuth

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

Request Body

object

name

required

Connector name

string

Example

Mailchimp

integration_name

required

Integration name

string

Example

mailchimp

settings

required

object

key

additional properties

any

Responses

201

Successful

object

id

required

integer

Example

12345

name

required

string

Example

Mailchimp

integration_name

required

string

Example

mailchimp

settings

required

object

setup_fields

object

key

additional properties

string

key

additional properties

any

created_at

required

string format: date-time

Example

2023-08-23T10:30:00.000Z

updated_at

required

string format: date-time

Example

2023-08-23T10:30:00.000Z

oauth_authorization_url

required

string

nullable

Example

https://app.constantcontact.com/oauth2/v1/authorize?client_id=12345&redirect_uri=https://app.constantcontact.com/oauth2/v1/callback&response_type=code&scope=email_profile_read

422

Unprocessable Entity

object

message

required

string

Example

Failed to save

errors

required

object

key

additional properties

Array<string>

Example

{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}