Update connector

PATCH

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

const url = 'https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/connectors/1';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Mailchimp","integration_name":"mailchimp","settings":{},"dynamic_content_profile_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/connectors/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Mailchimp", "integration_name": "mailchimp", "settings": {}, "dynamic_content_profile_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Updates a connector.

Authorizations

OAuth2
connectors:write

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

required

integer

Connector ID

Request Body

application/json

object

name

Connector name

string

Example

Mailchimp

integration_name

Integration name

string

Example

mailchimp

settings

object

key

additional properties

any

dynamic_content_profile_id

Optional dynamic content profile to enforce for exports via this connector. Pass null to remove.

string format: uuid

nullable

Responses

200

Successful

application/json

object

required

integer

name

required

string

integration_name

required

string

settings

required

object

setup_fields

object

key

additional properties

string

nullable

export_images

Whether image-library images should be uploaded to this connector during connector exports.

boolean

key

additional properties

any

created_at

required

string format: date-time

updated_at

required

string format: date-time

oauth_authorization_url

required

string

nullable

dynamic_content_profile_id

required

When set, exports created with this connector will always use this dynamic content profile.

string format: uuid

nullable

Example

{
  "id": 12345,
  "name": "Mailchimp",
  "integration_name": "mailchimp",
  "created_at": "2023-08-23T10:30:00.000Z",
  "updated_at": "2023-08-23T10:30:00.000Z",
  "oauth_authorization_url": "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

application/json

object

message

required

string

errors

required

object

key

additional properties

Array<string>

Example

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