JouloDocs

Correct the EAN or address of a connection

Corrects the EAN or the address of a connection you created. Fields you leave out keep their current value, and Joulo validates the EAN and address together again. On a connection with a signed machtiging, the change revokes it: send acknowledge_mandate_lapses true, then issue a new link with POST /v1/mandate-links.

POST
/v1/connections:update
AuthorizationBearer <token>

OAuth 2.0 client credentials for a CPO client bound to one partner. Request a token with grant_type client_credentials and send client_id and client_secret in the body, as JSON or form data. The token endpoint does not accept HTTP Basic client authentication. The token lasts one hour and has no refresh token. Omit scope to get every scope your client holds. The /v1 routes refuse user tokens and personal API tokens.

In: header

Scope: cpo:accounts:write

Response Body

curl -X POST "https://api.joulo.nl/functions/v1/api/v1/connections:update" \
  -H "Content-Type: application/json" \
  -d '{
    "cpo_external_ref": "CUST-100482",
    "connection": {
      "ean_code": "871685920000123456"
    }
  }'
{
  "ok": true,
  "changed": true,
  "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",
  "account_id": "449e7a5c-69d3-4b8a-aaaf-5c9b713ebc65",
  "ean_code": "string",
  "ean_validation_status": "matched",
  "registration_status": "string",
  "mandate_status": "pending",
  "mandate_revoked": true
}
{
  "error": "invalid_json",
  "detail": "string"
}
{
  "error": "Missing or invalid API token"
}
{
  "error": "Insufficient scope",
  "detail": "string",
  "required_scope": "string"
}
{
  "error": "connection_not_found",
  "detail": "string"
}
{
  "error": "ambiguous_connection",
  "detail": "string"
}
{
  "error": "ean_address_mismatch",
  "detail": "string"
}
{
  "error": "Too many requests",
  "retry_after_seconds": 0
}
{
  "error": "update_failed",
  "detail": "string"
}
{
  "error": "string"
}