Create Card

curl --request POST \
  --url https://api.example.com/cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "handle": "<string>",
  "display_name": "<string>",
  "title": "<string>",
  "company": "<string>",
  "pronouns": "<string>",
  "tagline": "<string>",
  "photo_url": "<string>",
  "company_logo_url": "<string>",
  "banner_url": "<string>",
  "theme": {
    "primary_color": "#0F172A",
    "accent_color": "#3B82F6",
    "layout": "classic",
    "font": "<string>"
  },
  "fields": [
    {
      "label": "<string>",
      "value": "",
      "icon": "<string>",
      "position": 0,
      "visibility": "public"
    }
  ],
  "is_default": false,
  "show_anyreach_branding": true,
  "notify_on_share_back": true,
  "notify_email": "<string>"
}
'

import requests

url = "https://api.example.com/cards"

payload = {
    "handle": "<string>",
    "display_name": "<string>",
    "title": "<string>",
    "company": "<string>",
    "pronouns": "<string>",
    "tagline": "<string>",
    "photo_url": "<string>",
    "company_logo_url": "<string>",
    "banner_url": "<string>",
    "theme": {
        "primary_color": "#0F172A",
        "accent_color": "#3B82F6",
        "layout": "classic",
        "font": "<string>"
    },
    "fields": [
        {
            "label": "<string>",
            "value": "",
            "icon": "<string>",
            "position": 0,
            "visibility": "public"
        }
    ],
    "is_default": False,
    "show_anyreach_branding": True,
    "notify_on_share_back": True,
    "notify_email": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    handle: '<string>',
    display_name: '<string>',
    title: '<string>',
    company: '<string>',
    pronouns: '<string>',
    tagline: '<string>',
    photo_url: '<string>',
    company_logo_url: '<string>',
    banner_url: '<string>',
    theme: {
      primary_color: '#0F172A',
      accent_color: '#3B82F6',
      layout: 'classic',
      font: '<string>'
    },
    fields: [
      {
        label: '<string>',
        value: '',
        icon: '<string>',
        position: 0,
        visibility: 'public'
      }
    ],
    is_default: false,
    show_anyreach_branding: true,
    notify_on_share_back: true,
    notify_email: '<string>'
  })
};

fetch('https://api.example.com/cards', 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.example.com/cards",
  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([
    'handle' => '<string>',
    'display_name' => '<string>',
    'title' => '<string>',
    'company' => '<string>',
    'pronouns' => '<string>',
    'tagline' => '<string>',
    'photo_url' => '<string>',
    'company_logo_url' => '<string>',
    'banner_url' => '<string>',
    'theme' => [
        'primary_color' => '#0F172A',
        'accent_color' => '#3B82F6',
        'layout' => 'classic',
        'font' => '<string>'
    ],
    'fields' => [
        [
                'label' => '<string>',
                'value' => '',
                'icon' => '<string>',
                'position' => 0,
                'visibility' => 'public'
        ]
    ],
    'is_default' => false,
    'show_anyreach_branding' => true,
    'notify_on_share_back' => true,
    'notify_email' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/cards"

	payload := strings.NewReader("{\n  \"handle\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"title\": \"<string>\",\n  \"company\": \"<string>\",\n  \"pronouns\": \"<string>\",\n  \"tagline\": \"<string>\",\n  \"photo_url\": \"<string>\",\n  \"company_logo_url\": \"<string>\",\n  \"banner_url\": \"<string>\",\n  \"theme\": {\n    \"primary_color\": \"#0F172A\",\n    \"accent_color\": \"#3B82F6\",\n    \"layout\": \"classic\",\n    \"font\": \"<string>\"\n  },\n  \"fields\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"\",\n      \"icon\": \"<string>\",\n      \"position\": 0,\n      \"visibility\": \"public\"\n    }\n  ],\n  \"is_default\": false,\n  \"show_anyreach_branding\": true,\n  \"notify_on_share_back\": true,\n  \"notify_email\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.example.com/cards")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"handle\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"title\": \"<string>\",\n  \"company\": \"<string>\",\n  \"pronouns\": \"<string>\",\n  \"tagline\": \"<string>\",\n  \"photo_url\": \"<string>\",\n  \"company_logo_url\": \"<string>\",\n  \"banner_url\": \"<string>\",\n  \"theme\": {\n    \"primary_color\": \"#0F172A\",\n    \"accent_color\": \"#3B82F6\",\n    \"layout\": \"classic\",\n    \"font\": \"<string>\"\n  },\n  \"fields\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"\",\n      \"icon\": \"<string>\",\n      \"position\": 0,\n      \"visibility\": \"public\"\n    }\n  ],\n  \"is_default\": false,\n  \"show_anyreach_branding\": true,\n  \"notify_on_share_back\": true,\n  \"notify_email\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/cards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"handle\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"title\": \"<string>\",\n  \"company\": \"<string>\",\n  \"pronouns\": \"<string>\",\n  \"tagline\": \"<string>\",\n  \"photo_url\": \"<string>\",\n  \"company_logo_url\": \"<string>\",\n  \"banner_url\": \"<string>\",\n  \"theme\": {\n    \"primary_color\": \"#0F172A\",\n    \"accent_color\": \"#3B82F6\",\n    \"layout\": \"classic\",\n    \"font\": \"<string>\"\n  },\n  \"fields\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"\",\n      \"icon\": \"<string>\",\n      \"position\": 0,\n      \"visibility\": \"public\"\n    }\n  ],\n  \"is_default\": false,\n  \"show_anyreach_branding\": true,\n  \"notify_on_share_back\": true,\n  \"notify_email\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

cards

Create Card

curl --request POST \
  --url https://api.example.com/cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "handle": "<string>",
  "display_name": "<string>",
  "title": "<string>",
  "company": "<string>",
  "pronouns": "<string>",
  "tagline": "<string>",
  "photo_url": "<string>",
  "company_logo_url": "<string>",
  "banner_url": "<string>",
  "theme": {
    "primary_color": "#0F172A",
    "accent_color": "#3B82F6",
    "layout": "classic",
    "font": "<string>"
  },
  "fields": [
    {
      "label": "<string>",
      "value": "",
      "icon": "<string>",
      "position": 0,
      "visibility": "public"
    }
  ],
  "is_default": false,
  "show_anyreach_branding": true,
  "notify_on_share_back": true,
  "notify_email": "<string>"
}
'

import requests

url = "https://api.example.com/cards"

payload = {
    "handle": "<string>",
    "display_name": "<string>",
    "title": "<string>",
    "company": "<string>",
    "pronouns": "<string>",
    "tagline": "<string>",
    "photo_url": "<string>",
    "company_logo_url": "<string>",
    "banner_url": "<string>",
    "theme": {
        "primary_color": "#0F172A",
        "accent_color": "#3B82F6",
        "layout": "classic",
        "font": "<string>"
    },
    "fields": [
        {
            "label": "<string>",
            "value": "",
            "icon": "<string>",
            "position": 0,
            "visibility": "public"
        }
    ],
    "is_default": False,
    "show_anyreach_branding": True,
    "notify_on_share_back": True,
    "notify_email": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    handle: '<string>',
    display_name: '<string>',
    title: '<string>',
    company: '<string>',
    pronouns: '<string>',
    tagline: '<string>',
    photo_url: '<string>',
    company_logo_url: '<string>',
    banner_url: '<string>',
    theme: {
      primary_color: '#0F172A',
      accent_color: '#3B82F6',
      layout: 'classic',
      font: '<string>'
    },
    fields: [
      {
        label: '<string>',
        value: '',
        icon: '<string>',
        position: 0,
        visibility: 'public'
      }
    ],
    is_default: false,
    show_anyreach_branding: true,
    notify_on_share_back: true,
    notify_email: '<string>'
  })
};

fetch('https://api.example.com/cards', 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.example.com/cards",
  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([
    'handle' => '<string>',
    'display_name' => '<string>',
    'title' => '<string>',
    'company' => '<string>',
    'pronouns' => '<string>',
    'tagline' => '<string>',
    'photo_url' => '<string>',
    'company_logo_url' => '<string>',
    'banner_url' => '<string>',
    'theme' => [
        'primary_color' => '#0F172A',
        'accent_color' => '#3B82F6',
        'layout' => 'classic',
        'font' => '<string>'
    ],
    'fields' => [
        [
                'label' => '<string>',
                'value' => '',
                'icon' => '<string>',
                'position' => 0,
                'visibility' => 'public'
        ]
    ],
    'is_default' => false,
    'show_anyreach_branding' => true,
    'notify_on_share_back' => true,
    'notify_email' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/cards"

	payload := strings.NewReader("{\n  \"handle\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"title\": \"<string>\",\n  \"company\": \"<string>\",\n  \"pronouns\": \"<string>\",\n  \"tagline\": \"<string>\",\n  \"photo_url\": \"<string>\",\n  \"company_logo_url\": \"<string>\",\n  \"banner_url\": \"<string>\",\n  \"theme\": {\n    \"primary_color\": \"#0F172A\",\n    \"accent_color\": \"#3B82F6\",\n    \"layout\": \"classic\",\n    \"font\": \"<string>\"\n  },\n  \"fields\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"\",\n      \"icon\": \"<string>\",\n      \"position\": 0,\n      \"visibility\": \"public\"\n    }\n  ],\n  \"is_default\": false,\n  \"show_anyreach_branding\": true,\n  \"notify_on_share_back\": true,\n  \"notify_email\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.example.com/cards")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"handle\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"title\": \"<string>\",\n  \"company\": \"<string>\",\n  \"pronouns\": \"<string>\",\n  \"tagline\": \"<string>\",\n  \"photo_url\": \"<string>\",\n  \"company_logo_url\": \"<string>\",\n  \"banner_url\": \"<string>\",\n  \"theme\": {\n    \"primary_color\": \"#0F172A\",\n    \"accent_color\": \"#3B82F6\",\n    \"layout\": \"classic\",\n    \"font\": \"<string>\"\n  },\n  \"fields\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"\",\n      \"icon\": \"<string>\",\n      \"position\": 0,\n      \"visibility\": \"public\"\n    }\n  ],\n  \"is_default\": false,\n  \"show_anyreach_branding\": true,\n  \"notify_on_share_back\": true,\n  \"notify_email\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/cards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"handle\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"title\": \"<string>\",\n  \"company\": \"<string>\",\n  \"pronouns\": \"<string>\",\n  \"tagline\": \"<string>\",\n  \"photo_url\": \"<string>\",\n  \"company_logo_url\": \"<string>\",\n  \"banner_url\": \"<string>\",\n  \"theme\": {\n    \"primary_color\": \"#0F172A\",\n    \"accent_color\": \"#3B82F6\",\n    \"layout\": \"classic\",\n    \"font\": \"<string>\"\n  },\n  \"fields\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"\",\n      \"icon\": \"<string>\",\n      \"position\": 0,\n      \"visibility\": \"public\"\n    }\n  ],\n  \"is_default\": false,\n  \"show_anyreach_branding\": true,\n  \"notify_on_share_back\": true,\n  \"notify_email\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

handle

string

required

Required string length: 3 - 40

Pattern: ^[a-z0-9][a-z0-9-]{1,38}[a-z0-9]$

display_name

string

required

Required string length: 1 - 200

title

string | null

company

string | null

pronouns

string | null

tagline

string | null

Maximum string length: 280

photo_url

string | null

company_logo_url

string | null

banner_url

string | null

theme

CardThemeBody · object

Show child attributes

fields

CardFieldBody · object[]

Show child attributes

is_default

boolean

default:false

show_anyreach_branding

boolean

default:true

notify_email

string | null

Maximum string length: 320

Response

Successful Response

The response is of type Response Create Card Route Cards Post · object.

Contacts

Deals

Accounts

Activities

Tags

Files

Folders

Notifications

Reports

PATs

Integrations

AI

Analytics Assistant

Feedback

Customer Intelligence

Outreach

AnyCard

AnyCard Events

AnyCard Share Links

Public Media

Account Readiness

Service Health

Create Card

Authorizations

Body

Response