Upsert a Contact

post https://{subdomain}.myclickfunnels.com/api/v2/workspaces/{workspace_id}/contacts/upsert

Creates or updates a Contact, matching on the email address. If the Contact does not exist, it will be created. If the Contact does exist, it will be updated. It is not possible to delete a Contact via this endpoint. It is not possible to reset properties of a Contact by passing empty values. E.g. passing null for first_name or an empty array for tag_ids won't update previous values. To do that you would instead need to use the Update Contact endpoint.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

array of objects

object

integer

required

Contact ID

public_id

string | null

Contact public ID

workspace_id

integer

required

Workspace ID

anonymous

string | null

Anonymous

email_address

string | null

Email address

first_name

string | null

First name

last_name

string | null

Last name

phone_number

string | null

Phone number

time_zone

string | null

The human-readable time zone, usually set dynamically by the app for the contact, for example, during opt-in.
Read more about time zones and how to map them back to the TZ standard in our Time Zones guide..

uuid

string

required

UUID

unsubscribed_at

string | null

Unsubscribed

last_notification_email_sent_at

string | null

Last notification email sent

fb_url

string | null

Facebook URL

twitter_url

string | null

Twitter URL

instagram_url

string | null

Instagram URL

linkedin_url

string | null

Linkedin URL

website_url

string | null

Website URL

created_at

date-time | null

Date added

updated_at

date-time | null

Last updated

tags

object

integer

required

Tag ID

public_id

string | null

Tag public ID

name

string

required

Name

color

string

required

Color

applied_at

string | null

The datetime the tag was applied by creating a Contacts::AppliedTag that maps the tag to the contact.

custom_attributes

object

A dynamic key-value pair object where both the key and value are strings. Custom attributes are usually added to the contact when they submit forms that contain custom contact attributes. But you can also add them via the API using the modifying endpoints like Create/Update/Upsert Contact.

Has additional fields

avatar_image

object

Avatar Image

Has additional fields

422

Unprocessable Entity

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://myworkspace.myclickfunnels.com/api/v2/workspaces/workspace_id/contacts/upsert \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
33
}
1
{
2
  "id": 40,
3
  "public_id": "bILzeA",
4
  "workspace_id": 42000,
5
  "anonymous": null,
6
  "email_address": "test-370f0bb329bc18fede8f@example.com",
7
  "first_name": "Adan",
8
  "last_name": "Cronin",
9
  "phone_number": "605-736-5090 x9156",
10
  "time_zone": "Pacific Time (US & Canada)",
11
  "uuid": "c787edfc-c953-41b4-99c4-0b0005672730",
12
  "unsubscribed_at": null,
13
  "last_notification_email_sent_at": null,
14
  "fb_url": "https://www.facebook.com/example",
15
  "twitter_url": "https://twitter.com/example",
16
  "instagram_url": null,
17
  "linkedin_url": "https://www.linkedin.com/in/example",
18
  "website_url": "https://example.com",
19
  "created_at": "2025-02-05T12:39:45.005Z",
20
  "updated_at": "2025-02-05T12:39:45.006Z",
21
  "tags": [
22
    {
23
      "id": 42,
24
      "public_id": "oOXkqy",
25
      "name": "Example Tag",

200OK

201Created