/api/v1/imports/{id}/homebox-connect

POST

/api/v1/imports/{id}/homebox-connect

curl --request POST \
  --url https://example.com/api/v1/imports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/homebox-connect \
  --header 'Content-Type: application/json' \
  --data '{ "baseUrl": "example", "apiKey": "example" }'

Parameters

Path Parameters

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Body^required

Media typeapplication/json

Any of:

object

object

baseUrl

required

string

>= 1 characters <= 2048 characters

apiKey

required

string

>= 1 characters <= 4096 characters

object

object

baseUrl

required

string

>= 1 characters <= 2048 characters

username

required

string

>= 1 characters <= 320 characters

password

required

string

>= 1 characters <= 4096 characters

Example^generated

{
  "baseUrl": "example",
  "apiKey": "example"
}

Responses

200

Default Response

Media typeapplication/json

object

version

required

string

collections

required

Array<object>

object

id

required

string

name

required

string

currency

required

string

members

Array<object>

object

name

required

string

email

required

string

Example^generated

{
  "version": "example",
  "collections": [
    {
      "id": "example",
      "name": "example",
      "currency": "example"
    }
  ],
  "members": [
    {
      "name": "example",
      "email": "example"
    }
  ]
}