Verify a contact

client.contacts.verify(, ?): ContactVerifyResponse { status }

POST/api/v2/contacts/verify

Send a verification message to a contact

ParametersExpand Collapse

body: ContactVerifyParams { number }

number: string

Phone number to verify

ReturnsExpand Collapse

ContactVerifyResponse { status }

status?: string

Verify a contact

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: process.env['SENDBLUE_API_API_KEY'], // This is the default and can be omitted
  apiSecret: process.env['SENDBLUE_API_API_SECRET'], // This is the default and can be omitted
});

const response = await client.contacts.verify({ number: 'number' });

console.log(response.status);

{
  "status": "OK"
}

Returns Examples

{
  "status": "OK"
}