Create a new custom integration

POST

/openapi/account/addcustomintegration

curl --request POST \
  --url https://open-api.replyco.com/openapi/account/addcustomintegration \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{ "name": "Acme web shop" }'

• Production

Creates a custom integration/account for connecting external systems.

Required fields:

• Name: Integration display name
• Marketplace: Must be set to “CustomIntegration”

Optional fields:

• ApiKey: For authentication
• ApiSecret: For secure authentication
• WebhookUrl: For receiving events
• IsActive: Enable/disable integration (default: true)

Use cases:

• Connect proprietary systems
• Integrate with unsupported marketplaces
• Build custom data pipelines

Sample request:

POST /account/addCustomIntegration
{
  "name": "My Custom Store",
  "marketplace": "CustomIntegration",
  "apiKey": "your-api-key",
  "isActive": true
}

Authorizations

• Bearer

Request Body

Custom integration configuration (ID will be auto-generated)

object

id

string format: uuid

name

The display name of the custom integration (e.g., “My Store”, “Legacy System”)

string

nullable

isBlocked

Indicates whether this integration is blocked/disabled. Set to “true” to disable, “false” or null to enable

string

nullable

icon

object

id

string format: uuid

marketFileId

External marketplace-specific file identifier (if applicable)

string

nullable

mimeType

MIME type of the file (e.g., “image/png”, “application/pdf”)

string

nullable

fileSize

Size of the file in bytes

integer format: int32

fileName

Name of the file including extension (e.g., “logo.png”, “document.pdf”)

string

nullable

filePath

Server-side path where the file is stored (internal use)

string

nullable

fileUrl

Publicly accessible URL to download/view the file

string

nullable

base64

Base64-encoded file content for inline upload/download

string

nullable

Example

{
  "name": "Acme web shop"
}

object

id

string format: uuid

name

The display name of the custom integration (e.g., “My Store”, “Legacy System”)

string

nullable

isBlocked

Indicates whether this integration is blocked/disabled. Set to “true” to disable, “false” or null to enable

string

nullable

icon

object

id

string format: uuid

marketFileId

External marketplace-specific file identifier (if applicable)

string

nullable

mimeType

MIME type of the file (e.g., “image/png”, “application/pdf”)

string

nullable

fileSize

Size of the file in bytes

integer format: int32

fileName

Name of the file including extension (e.g., “logo.png”, “document.pdf”)

string

nullable

filePath

Server-side path where the file is stored (internal use)

string

nullable

fileUrl

Publicly accessible URL to download/view the file

string

nullable

base64

Base64-encoded file content for inline upload/download

string

nullable

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "isBlocked": "example",
  "icon": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "marketFileId": "example",
    "mimeType": "example",
    "fileSize": 1,
    "fileName": "example",
    "filePath": "example",
    "fileUrl": "example",
    "base64": "example"
  }
}

object

id

string format: uuid

name

The display name of the custom integration (e.g., “My Store”, “Legacy System”)

string

nullable

isBlocked

Indicates whether this integration is blocked/disabled. Set to “true” to disable, “false” or null to enable

string

nullable

icon

object

id

string format: uuid

marketFileId

External marketplace-specific file identifier (if applicable)

string

nullable

mimeType

MIME type of the file (e.g., “image/png”, “application/pdf”)

string

nullable

fileSize

Size of the file in bytes

integer format: int32

fileName

Name of the file including extension (e.g., “logo.png”, “document.pdf”)

string

nullable

filePath

Server-side path where the file is stored (internal use)

string

nullable

fileUrl

Publicly accessible URL to download/view the file

string

nullable

base64

Base64-encoded file content for inline upload/download

string

nullable

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "isBlocked": "example",
  "icon": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "marketFileId": "example",
    "mimeType": "example",
    "fileSize": 1,
    "fileName": "example",
    "filePath": "example",
    "fileUrl": "example",
    "base64": "example"
  }
}

object

id

string format: uuid

name

The display name of the custom integration (e.g., “My Store”, “Legacy System”)

string

nullable

isBlocked

Indicates whether this integration is blocked/disabled. Set to “true” to disable, “false” or null to enable

string

nullable

icon

object

id

string format: uuid

marketFileId

External marketplace-specific file identifier (if applicable)

string

nullable

mimeType

MIME type of the file (e.g., “image/png”, “application/pdf”)

string

nullable

fileSize

Size of the file in bytes

integer format: int32

fileName

Name of the file including extension (e.g., “logo.png”, “document.pdf”)

string

nullable

filePath

Server-side path where the file is stored (internal use)

string

nullable

fileUrl

Publicly accessible URL to download/view the file

string

nullable

base64

Base64-encoded file content for inline upload/download

string

nullable

Example ^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "isBlocked": "example",
  "icon": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "marketFileId": "example",
    "mimeType": "example",
    "fileSize": 1,
    "fileName": "example",
    "filePath": "example",
    "fileUrl": "example",
    "base64": "example"
  }
}

Responses

200

Custom integration was created successfully, returns the new ID

Media typeapplication/json

string format: uuid

Example

3f1c2a9e-6b4d-4c8e-9f2a-1d5e7b3c9a06

400

Invalid request data (e.g., missing required fields, invalid marketplace type)

401

User is not authenticated or authorized

403

User does not have permission to create integrations