Test New Connection

Tests a new connection before creating it.

POST /connections/test

Test New Connection

cURL

curl --request POST \
  --url https://api.xplenty.com/{account_id}/api/connections/test \
  --header 'Accept: <accept>' \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "<string>"
}
'

200

{
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

Enter your API key as the username. Leave the password field blank. Example: curl -u YOUR_API_KEY: https://api.xplenty.com/...

Headers

Accept · string · default: application/vnd.xplenty+json; version=2 · required

API version header — required on all requests

Body

application/json

name · string · required

type · string · required

Connection type identifier

Response

200 - application/vnd.xplenty+json; version=2

Connection test result

status · enum<string>

Available options: success, failure

message · string