Confirm an adapter address with the code that was emailed to it

Some credentials are an email address Widgetic sends a widget’s messages to (confirmation: email_code in getUserAdapterConnections). Saving one with setUserAdapterConnection emails a six-digit code to it; this gives the code back. Only then is the address used: until it is confirmed, the widgets that need it are not charged and their visitors are told the feature is unavailable.

The code works for 30 minutes and for five wrong tries. After that, save the address again and a new code is emailed (not sooner than a minute after the last one). A code that is not made of digits is refused without counting as a try.

Confirming an address that is already confirmed answers 200 with the same state, so a retry of a request that went through is harmless. Saving a different address, or the same one before it was confirmed, starts again.

This needs an API key with full access. The caller must be the account itself or a Widgetic administrator.

POST /users/{userId}/adapter-connections/{adapterId}/{credentialKey}/confirm

TypeScript SDK

TypeScript

import { Configuration, UsersApi } from '@widgetic/api-sdk-ts';

const usersApi = new UsersApi(new Configuration({ apiKey: 'YOUR_API_KEY' }));

// After setUserAdapterConnection emailed a code to the address:
const { data: connection } = await usersApi.confirmUserAdapterConnection({
  userId,
  adapterId: 'email',
  credentialKey: 'recipient',
  confirmAdapterConnectionRequest: { code: '123456' },
});
console.log(connection.awaitingConfirmation, connection.confirmedAt);

200

{
  "success": true,
  "data": {
    "adapterId": "email",
    "adapterLabel": "Email",
    "credentialKey": "resendApiKey",
    "label": "Resend API key",
    "scope": "Example scope",
    "connected": true,
    "updatedAt": "2026-01-15T09:30:00.000Z",
    "confirmation": "email_code",
    "awaitingConfirmation": true,
    "confirmedAt": "2026-01-15T09:30:00.000Z"
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId · string<uuid> · required

The account that keeps the address. For your own, your own user id

adapterId · string · required

The adapter the address is for

Maximum string length: 40

credentialKey · string · required

The credential's name within the adapter

Maximum string length: 40

Body

application/json

code · string · required

The digits of the code Widgetic emailed to the address, with nothing else. It works for 30 minutes and for five wrong tries; after that, save the address again and a new code is emailed

Maximum string length: 32

Example:

"123456"

Response

200

application/json

The address is confirmed (or was already)

success · boolean · required

data · object · required

A key an adapter can take from an account, and whether the account has connected it. The key itself is never part of this: it is given once, when it is connected, and Widgetic keeps it encrypted.

Show child attributes

Example:

{
  "adapterId": "email",
  "adapterLabel": "Email",
  "credentialKey": "resendApiKey",
  "label": "Resend API key",
  "scope": "Example scope",
  "connected": true,
  "updatedAt": "2026-01-15T09:30:00.000Z",
  "confirmation": "email_code",
  "awaitingConfirmation": true,
  "confirmedAt": "2026-01-15T09:30:00.000Z"
}

meta · object

Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.

Show child attributes