Create a contact
curl --request POST \
--url https://core-service.prod.brudcast.com/api/v1/user/contacts \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"displayName": "<string>",
"timezone": "<string>",
"language": "<string>",
"tags": [
"<string>"
],
"customFields": {},
"notes": "<string>",
"emails": [
{
"email": "jsmith@example.com",
"isPrimary": true
}
],
"smsNumbers": [
{
"phoneNumber": "<string>",
"countryCode": "<string>",
"isPrimary": true
}
],
"whatsappAccounts": [
{
"phoneNumber": "<string>",
"countryCode": "<string>",
"isPrimary": true,
"isBusinessAccount": true
}
],
"telegramAccounts": [
{
"phoneNumber": "<string>",
"countryCode": "<string>",
"username": "<string>",
"isPrimary": true
}
],
"imessageAccounts": [
{
"appleId": "jsmith@example.com",
"phoneNumber": "<string>",
"isPrimary": true
}
],
"pushNotifications": [
{
"deviceToken": "<string>",
"appVersion": "<string>",
"deviceInfo": {},
"isPrimary": true
}
]
}
'import requests
url = "https://core-service.prod.brudcast.com/api/v1/user/contacts"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"displayName": "<string>",
"timezone": "<string>",
"language": "<string>",
"tags": ["<string>"],
"customFields": {},
"notes": "<string>",
"emails": [
{
"email": "jsmith@example.com",
"isPrimary": True
}
],
"smsNumbers": [
{
"phoneNumber": "<string>",
"countryCode": "<string>",
"isPrimary": True
}
],
"whatsappAccounts": [
{
"phoneNumber": "<string>",
"countryCode": "<string>",
"isPrimary": True,
"isBusinessAccount": True
}
],
"telegramAccounts": [
{
"phoneNumber": "<string>",
"countryCode": "<string>",
"username": "<string>",
"isPrimary": True
}
],
"imessageAccounts": [
{
"appleId": "jsmith@example.com",
"phoneNumber": "<string>",
"isPrimary": True
}
],
"pushNotifications": [
{
"deviceToken": "<string>",
"appVersion": "<string>",
"deviceInfo": {},
"isPrimary": True
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
displayName: '<string>',
timezone: '<string>',
language: '<string>',
tags: ['<string>'],
customFields: {},
notes: '<string>',
emails: [{email: 'jsmith@example.com', isPrimary: true}],
smsNumbers: [{phoneNumber: '<string>', countryCode: '<string>', isPrimary: true}],
whatsappAccounts: [
{
phoneNumber: '<string>',
countryCode: '<string>',
isPrimary: true,
isBusinessAccount: true
}
],
telegramAccounts: [
{
phoneNumber: '<string>',
countryCode: '<string>',
username: '<string>',
isPrimary: true
}
],
imessageAccounts: [{appleId: 'jsmith@example.com', phoneNumber: '<string>', isPrimary: true}],
pushNotifications: [
{
deviceToken: '<string>',
appVersion: '<string>',
deviceInfo: {},
isPrimary: true
}
]
})
};
fetch('https://core-service.prod.brudcast.com/api/v1/user/contacts', 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://core-service.prod.brudcast.com/api/v1/user/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'firstName' => '<string>',
'lastName' => '<string>',
'displayName' => '<string>',
'timezone' => '<string>',
'language' => '<string>',
'tags' => [
'<string>'
],
'customFields' => [
],
'notes' => '<string>',
'emails' => [
[
'email' => 'jsmith@example.com',
'isPrimary' => true
]
],
'smsNumbers' => [
[
'phoneNumber' => '<string>',
'countryCode' => '<string>',
'isPrimary' => true
]
],
'whatsappAccounts' => [
[
'phoneNumber' => '<string>',
'countryCode' => '<string>',
'isPrimary' => true,
'isBusinessAccount' => true
]
],
'telegramAccounts' => [
[
'phoneNumber' => '<string>',
'countryCode' => '<string>',
'username' => '<string>',
'isPrimary' => true
]
],
'imessageAccounts' => [
[
'appleId' => 'jsmith@example.com',
'phoneNumber' => '<string>',
'isPrimary' => true
]
],
'pushNotifications' => [
[
'deviceToken' => '<string>',
'appVersion' => '<string>',
'deviceInfo' => [
],
'isPrimary' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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://core-service.prod.brudcast.com/api/v1/user/contacts"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"displayName\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"customFields\": {},\n \"notes\": \"<string>\",\n \"emails\": [\n {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n }\n ],\n \"smsNumbers\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"whatsappAccounts\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"isPrimary\": true,\n \"isBusinessAccount\": true\n }\n ],\n \"telegramAccounts\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"username\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"imessageAccounts\": [\n {\n \"appleId\": \"jsmith@example.com\",\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"pushNotifications\": [\n {\n \"deviceToken\": \"<string>\",\n \"appVersion\": \"<string>\",\n \"deviceInfo\": {},\n \"isPrimary\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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.post("https://core-service.prod.brudcast.com/api/v1/user/contacts")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"displayName\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"customFields\": {},\n \"notes\": \"<string>\",\n \"emails\": [\n {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n }\n ],\n \"smsNumbers\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"whatsappAccounts\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"isPrimary\": true,\n \"isBusinessAccount\": true\n }\n ],\n \"telegramAccounts\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"username\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"imessageAccounts\": [\n {\n \"appleId\": \"jsmith@example.com\",\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"pushNotifications\": [\n {\n \"deviceToken\": \"<string>\",\n \"appVersion\": \"<string>\",\n \"deviceInfo\": {},\n \"isPrimary\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-service.prod.brudcast.com/api/v1/user/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"displayName\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"customFields\": {},\n \"notes\": \"<string>\",\n \"emails\": [\n {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n }\n ],\n \"smsNumbers\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"whatsappAccounts\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"isPrimary\": true,\n \"isBusinessAccount\": true\n }\n ],\n \"telegramAccounts\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"username\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"imessageAccounts\": [\n {\n \"appleId\": \"jsmith@example.com\",\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"pushNotifications\": [\n {\n \"deviceToken\": \"<string>\",\n \"appVersion\": \"<string>\",\n \"deviceInfo\": {},\n \"isPrimary\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"displayName": "<string>",
"timezone": "Africa/Lagos",
"language": "en",
"status": "active",
"customFields": {},
"notes": "<string>",
"lastActivityAt": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"emails": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"status": "verified",
"isPrimary": true,
"bounceCount": 123,
"complaintCount": 123,
"verifiedAt": "2023-11-07T05:31:56Z",
"lastBouncedAt": "2023-11-07T05:31:56Z",
"lastComplainedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"smsNumbers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "+2348012345678",
"countryCode": "NG",
"status": "verified",
"isPrimary": true,
"verifiedAt": "2023-11-07T05:31:56Z",
"optedOutAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"whatsappAccounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "+2348012345678",
"countryCode": "NG",
"status": "verified",
"isPrimary": true,
"isBusinessAccount": true,
"lastSeenAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"telegramAccounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "+2348012345678",
"countryCode": "NG",
"username": "<string>",
"status": "active",
"isPrimary": true,
"lastActiveAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"imessageAccounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"appleId": "jsmith@example.com",
"phoneNumber": "+2348012345678",
"status": "verified",
"isPrimary": true,
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"pushNotifications": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deviceToken": "<string>",
"platform": "ios",
"status": "active",
"appVersion": "3.4.1",
"deviceInfo": {},
"isPrimary": true,
"lastUsedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"tagRecords": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "newsletter",
"contactCount": 42,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"listMemberships": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactListId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "subscribed",
"subscribedAt": "2023-11-07T05:31:56Z",
"unsubscribedAt": "2023-11-07T05:31:56Z",
"unsubscribeReason": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"displayName": "<string>",
"status": "active",
"tags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"emails": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"status": "verified",
"isPrimary": true,
"bounceCount": 123,
"complaintCount": 123,
"verifiedAt": "2023-11-07T05:31:56Z",
"lastBouncedAt": "2023-11-07T05:31:56Z",
"lastComplainedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
},
"contactList": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cuid": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Product announcements",
"description": "<string>",
"status": "active",
"preferredChannels": [
"email"
],
"tags": [
"<string>"
],
"isDefault": true,
"subscriberCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
]
}
}
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "The payload is invalid",
"code": "E_VALIDATION_ERROR",
"errors": [
{
"field": "emailAddress",
"rule": "email",
"message": "The emailAddress field must be a valid email address"
}
]
}{
"success": false,
"message": "Too many requests",
"code": "E_TOO_MANY_REQUESTS",
"retryAfter": 60
}Contacts
Create a contact
Creates a contact together with any email, SMS, WhatsApp, Telegram, iMessage and push records supplied, and links the tag names given, creating tags that do not exist yet. At least one contact channel is required. The contact is returned at data.contact with its channel records preloaded. Requires the contacts:write scope.
POST
/
api
/
v1
/
user
/
contacts
Create a contact
curl --request POST \
--url https://core-service.prod.brudcast.com/api/v1/user/contacts \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"displayName": "<string>",
"timezone": "<string>",
"language": "<string>",
"tags": [
"<string>"
],
"customFields": {},
"notes": "<string>",
"emails": [
{
"email": "jsmith@example.com",
"isPrimary": true
}
],
"smsNumbers": [
{
"phoneNumber": "<string>",
"countryCode": "<string>",
"isPrimary": true
}
],
"whatsappAccounts": [
{
"phoneNumber": "<string>",
"countryCode": "<string>",
"isPrimary": true,
"isBusinessAccount": true
}
],
"telegramAccounts": [
{
"phoneNumber": "<string>",
"countryCode": "<string>",
"username": "<string>",
"isPrimary": true
}
],
"imessageAccounts": [
{
"appleId": "jsmith@example.com",
"phoneNumber": "<string>",
"isPrimary": true
}
],
"pushNotifications": [
{
"deviceToken": "<string>",
"appVersion": "<string>",
"deviceInfo": {},
"isPrimary": true
}
]
}
'import requests
url = "https://core-service.prod.brudcast.com/api/v1/user/contacts"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"displayName": "<string>",
"timezone": "<string>",
"language": "<string>",
"tags": ["<string>"],
"customFields": {},
"notes": "<string>",
"emails": [
{
"email": "jsmith@example.com",
"isPrimary": True
}
],
"smsNumbers": [
{
"phoneNumber": "<string>",
"countryCode": "<string>",
"isPrimary": True
}
],
"whatsappAccounts": [
{
"phoneNumber": "<string>",
"countryCode": "<string>",
"isPrimary": True,
"isBusinessAccount": True
}
],
"telegramAccounts": [
{
"phoneNumber": "<string>",
"countryCode": "<string>",
"username": "<string>",
"isPrimary": True
}
],
"imessageAccounts": [
{
"appleId": "jsmith@example.com",
"phoneNumber": "<string>",
"isPrimary": True
}
],
"pushNotifications": [
{
"deviceToken": "<string>",
"appVersion": "<string>",
"deviceInfo": {},
"isPrimary": True
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
displayName: '<string>',
timezone: '<string>',
language: '<string>',
tags: ['<string>'],
customFields: {},
notes: '<string>',
emails: [{email: 'jsmith@example.com', isPrimary: true}],
smsNumbers: [{phoneNumber: '<string>', countryCode: '<string>', isPrimary: true}],
whatsappAccounts: [
{
phoneNumber: '<string>',
countryCode: '<string>',
isPrimary: true,
isBusinessAccount: true
}
],
telegramAccounts: [
{
phoneNumber: '<string>',
countryCode: '<string>',
username: '<string>',
isPrimary: true
}
],
imessageAccounts: [{appleId: 'jsmith@example.com', phoneNumber: '<string>', isPrimary: true}],
pushNotifications: [
{
deviceToken: '<string>',
appVersion: '<string>',
deviceInfo: {},
isPrimary: true
}
]
})
};
fetch('https://core-service.prod.brudcast.com/api/v1/user/contacts', 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://core-service.prod.brudcast.com/api/v1/user/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'firstName' => '<string>',
'lastName' => '<string>',
'displayName' => '<string>',
'timezone' => '<string>',
'language' => '<string>',
'tags' => [
'<string>'
],
'customFields' => [
],
'notes' => '<string>',
'emails' => [
[
'email' => 'jsmith@example.com',
'isPrimary' => true
]
],
'smsNumbers' => [
[
'phoneNumber' => '<string>',
'countryCode' => '<string>',
'isPrimary' => true
]
],
'whatsappAccounts' => [
[
'phoneNumber' => '<string>',
'countryCode' => '<string>',
'isPrimary' => true,
'isBusinessAccount' => true
]
],
'telegramAccounts' => [
[
'phoneNumber' => '<string>',
'countryCode' => '<string>',
'username' => '<string>',
'isPrimary' => true
]
],
'imessageAccounts' => [
[
'appleId' => 'jsmith@example.com',
'phoneNumber' => '<string>',
'isPrimary' => true
]
],
'pushNotifications' => [
[
'deviceToken' => '<string>',
'appVersion' => '<string>',
'deviceInfo' => [
],
'isPrimary' => true
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <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://core-service.prod.brudcast.com/api/v1/user/contacts"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"displayName\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"customFields\": {},\n \"notes\": \"<string>\",\n \"emails\": [\n {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n }\n ],\n \"smsNumbers\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"whatsappAccounts\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"isPrimary\": true,\n \"isBusinessAccount\": true\n }\n ],\n \"telegramAccounts\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"username\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"imessageAccounts\": [\n {\n \"appleId\": \"jsmith@example.com\",\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"pushNotifications\": [\n {\n \"deviceToken\": \"<string>\",\n \"appVersion\": \"<string>\",\n \"deviceInfo\": {},\n \"isPrimary\": true\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<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.post("https://core-service.prod.brudcast.com/api/v1/user/contacts")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"displayName\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"customFields\": {},\n \"notes\": \"<string>\",\n \"emails\": [\n {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n }\n ],\n \"smsNumbers\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"whatsappAccounts\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"isPrimary\": true,\n \"isBusinessAccount\": true\n }\n ],\n \"telegramAccounts\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"username\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"imessageAccounts\": [\n {\n \"appleId\": \"jsmith@example.com\",\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"pushNotifications\": [\n {\n \"deviceToken\": \"<string>\",\n \"appVersion\": \"<string>\",\n \"deviceInfo\": {},\n \"isPrimary\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-service.prod.brudcast.com/api/v1/user/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"displayName\": \"<string>\",\n \"timezone\": \"<string>\",\n \"language\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"customFields\": {},\n \"notes\": \"<string>\",\n \"emails\": [\n {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n }\n ],\n \"smsNumbers\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"whatsappAccounts\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"isPrimary\": true,\n \"isBusinessAccount\": true\n }\n ],\n \"telegramAccounts\": [\n {\n \"phoneNumber\": \"<string>\",\n \"countryCode\": \"<string>\",\n \"username\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"imessageAccounts\": [\n {\n \"appleId\": \"jsmith@example.com\",\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"pushNotifications\": [\n {\n \"deviceToken\": \"<string>\",\n \"appVersion\": \"<string>\",\n \"deviceInfo\": {},\n \"isPrimary\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"data": {
"contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"displayName": "<string>",
"timezone": "Africa/Lagos",
"language": "en",
"status": "active",
"customFields": {},
"notes": "<string>",
"lastActivityAt": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"emails": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"status": "verified",
"isPrimary": true,
"bounceCount": 123,
"complaintCount": 123,
"verifiedAt": "2023-11-07T05:31:56Z",
"lastBouncedAt": "2023-11-07T05:31:56Z",
"lastComplainedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"smsNumbers": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "+2348012345678",
"countryCode": "NG",
"status": "verified",
"isPrimary": true,
"verifiedAt": "2023-11-07T05:31:56Z",
"optedOutAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"whatsappAccounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "+2348012345678",
"countryCode": "NG",
"status": "verified",
"isPrimary": true,
"isBusinessAccount": true,
"lastSeenAt": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"telegramAccounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"phoneNumber": "+2348012345678",
"countryCode": "NG",
"username": "<string>",
"status": "active",
"isPrimary": true,
"lastActiveAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"imessageAccounts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"appleId": "jsmith@example.com",
"phoneNumber": "+2348012345678",
"status": "verified",
"isPrimary": true,
"verifiedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"pushNotifications": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"deviceToken": "<string>",
"platform": "ios",
"status": "active",
"appVersion": "3.4.1",
"deviceInfo": {},
"isPrimary": true,
"lastUsedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"tagRecords": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "newsletter",
"contactCount": 42,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"listMemberships": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactListId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "subscribed",
"subscribedAt": "2023-11-07T05:31:56Z",
"unsubscribedAt": "2023-11-07T05:31:56Z",
"unsubscribeReason": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"displayName": "<string>",
"status": "active",
"tags": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"emails": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"status": "verified",
"isPrimary": true,
"bounceCount": 123,
"complaintCount": 123,
"verifiedAt": "2023-11-07T05:31:56Z",
"lastBouncedAt": "2023-11-07T05:31:56Z",
"lastComplainedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
},
"contactList": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cuid": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Product announcements",
"description": "<string>",
"status": "active",
"preferredChannels": [
"email"
],
"tags": [
"<string>"
],
"isDefault": true,
"subscriberCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
]
}
}
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "Resource not found",
"code": "E_ROW_NOT_FOUND"
}{
"success": false,
"message": "The payload is invalid",
"code": "E_VALIDATION_ERROR",
"errors": [
{
"field": "emailAddress",
"rule": "email",
"message": "The emailAddress field must be a valid email address"
}
]
}{
"success": false,
"message": "Too many requests",
"code": "E_TOO_MANY_REQUESTS",
"retryAfter": 60
}Authorizations
apiKeyapiKeyBearer
An organization API key, prefixed bk_live_. Takes precedence over Authorization when both are sent. The key is bound to one organization, and the scopes it was issued with are enforced per endpoint.
Headers
Required when authenticating with an access token. Optional with an API key, whose own organization binding is authoritative; a value contradicting it is refused with 403.
Body
application/json
Required string length:
1 - 255Required string length:
1 - 255Required string length:
1 - 255Maximum string length:
50Maximum string length:
10Available options:
active, inactive, archived Show child attributes
Show child attributes
Maximum string length:
5000Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes