curl --request PUT \
--url https://{subdomain}.conveyour.com/api/senders/verify/{id} \
--header 'Content-Type: application/json' \
--header 'x-conveyour-token: <api-key>' \
--data '
{
"verify_email": false
}
'const options = {
method: 'PUT',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({verify_email: false})
};
fetch('https://{subdomain}.conveyour.com/api/senders/verify/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'PUT',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({verify_email: false})
};
fetch('https://{subdomain}.conveyour.com/api/senders/verify/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/senders/verify/{id}"
payload = { "verify_email": False }
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/senders/verify/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'verify_email' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "ran verification",
"data": {
"id": "64a1b2c3d4e5f6a7b8c9d0e1",
"org_id": 990,
"user_id": 123,
"name": "Acme Recruiting",
"email": "hello@acme.com",
"domain": "acme.com",
"dkim_status": "valid",
"spf_status": "valid",
"spf_record": "v=spf1 include:sparkpostmail.com ~all",
"ready": true
}
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}Verify an email address
Verifies a sender. With verify_email: true, re-sends the verification email to the sender address. Otherwise, checks the sending domain’s SPF/DKIM DNS records with SparkPost and updates the stored verification status.
Re-send verification email or verify the sending domain
Not callable with an API key. Every Senders endpoint requires org admin and returns 403 You are not authorized to access this resource otherwise. Service accounts cannot be admin, so this is unreachable with any API key — use a signed-in admin session.
Permission: org admin. A non-admin receives HTTP 403 with the message You are not authorized to access this resource.
A missing record does not return 404. This handler reports the failure without a status code, and the error envelope defaults to HTTP 200 — you get 200 with status: "failed". Branch on status, not on the HTTP code.
curl --request PUT \
--url https://{subdomain}.conveyour.com/api/senders/verify/{id} \
--header 'Content-Type: application/json' \
--header 'x-conveyour-token: <api-key>' \
--data '
{
"verify_email": false
}
'const options = {
method: 'PUT',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({verify_email: false})
};
fetch('https://{subdomain}.conveyour.com/api/senders/verify/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {
method: 'PUT',
headers: {'x-conveyour-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({verify_email: false})
};
fetch('https://{subdomain}.conveyour.com/api/senders/verify/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/senders/verify/{id}"
payload = { "verify_email": False }
headers = {
"x-conveyour-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/senders/verify/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'verify_email' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "ran verification",
"data": {
"id": "64a1b2c3d4e5f6a7b8c9d0e1",
"org_id": 990,
"user_id": 123,
"name": "Acme Recruiting",
"email": "hello@acme.com",
"domain": "acme.com",
"dkim_status": "valid",
"spf_status": "valid",
"spf_record": "v=spf1 include:sparkpostmail.com ~all",
"ready": true
}
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}Authorizations
Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.
Path Parameters
The id identifier.
Query Parameters
Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.
Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.
Body
Optional. Omit the body to run domain verification.
When true a verification email is sent and the request returns immediately, skipping domain verification.
Response
Success.
The common response envelope shared by all ConveYour endpoints.