Bulk update prospect background URLs based on email domains.
curl --request PATCH \
--url https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-api-secret: <api-key>' \
--data '
{
"extractUrlFromEmail": true
}
'import requests
url = "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk"
payload = { "extractUrlFromEmail": True }
headers = {
"x-api-key": "<api-key>",
"x-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-api-key': '<api-key>',
'x-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({extractUrlFromEmail: true})
};
fetch('https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'extractUrlFromEmail' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-api-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk"
payload := strings.NewReader("{\n \"extractUrlFromEmail\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-api-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk")
.header("x-api-key", "<api-key>")
.header("x-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"extractUrlFromEmail\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"extractUrlFromEmail\": true\n}"
response = http.request(request)
puts response.read_body{
"updatedCount": 123,
"totalCount": 123
}{
"statusCode": 400,
"code": "S400-AHVE",
"error": "Bad Request",
"message": "Invalid request payload input"
}{
"statusCode": 403,
"code": "S403-UPLD",
"error": "Forbidden",
"message": "Invalid request payload input / Any error from provider"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found or invalid access"
}{
"statusCode": 503,
"error": "Service Unavailable",
"message": "Service Unavailable"
}Dynamics Campaign
Bulk update prospect background URLs based on email domains.
This endpoint is used to bulk update prospect background URLs based on email domains.
PATCH
/
v1
/
workspaces
/
{workspaceId}
/
dynamics
/
{dynamicsId}
/
prospects
/
urls
/
bulk
Bulk update prospect background URLs based on email domains.
curl --request PATCH \
--url https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-api-secret: <api-key>' \
--data '
{
"extractUrlFromEmail": true
}
'import requests
url = "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk"
payload = { "extractUrlFromEmail": True }
headers = {
"x-api-key": "<api-key>",
"x-api-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-api-key': '<api-key>',
'x-api-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({extractUrlFromEmail: true})
};
fetch('https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'extractUrlFromEmail' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-api-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk"
payload := strings.NewReader("{\n \"extractUrlFromEmail\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-api-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk")
.header("x-api-key", "<api-key>")
.header("x-api-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"extractUrlFromEmail\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-gw.sendspark.com/v1/workspaces/{workspaceId}/dynamics/{dynamicsId}/prospects/urls/bulk")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["x-api-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"extractUrlFromEmail\": true\n}"
response = http.request(request)
puts response.read_body{
"updatedCount": 123,
"totalCount": 123
}{
"statusCode": 400,
"code": "S400-AHVE",
"error": "Bad Request",
"message": "Invalid request payload input"
}{
"statusCode": 403,
"code": "S403-UPLD",
"error": "Forbidden",
"message": "Invalid request payload input / Any error from provider"
}{
"statusCode": 404,
"error": "Not Found",
"message": "Resource not found or invalid access"
}{
"statusCode": 503,
"error": "Service Unavailable",
"message": "Service Unavailable"
}Body
application/json
If true, sets backgroundUrl based on email domain. If false, removes backgroundUrls matching email domain.
Was this page helpful?
⌘I