ClickFunnels

App · 27 actions

Work with your ClickFunnels 2.0 account: find, create, update and remove contacts, tag them and add notes, read orders, products, funnels, form submissions and courses, and manage webhook endpoints.

Actions

ActionWhat it does
Add contact noteAdd a note to a contact's activity.
Add tag to contactPut a tag on a contact.
Create contactAdd a contact to a workspace.
Create contact tagAdd a contact tag to a workspace.
Create or update contactCreate the contact with this email address, or update them if they already exist.
Create webhook endpointHave ClickFunnels send the chosen events (contact created, order completed and so on) to an https address.
Delete contactRemove a contact from lists and filters.
Delete contact notePermanently delete a note from a contact's activity.
Delete contact tagDelete a contact tag.
Delete webhook endpointDelete a webhook endpoint so ClickFunnels stops sending to it.
Get contactGet one contact with their tags and custom attributes.
Get current userGet the ClickFunnels user the access token belongs to.
List contact notesList the notes in a contact's activity.
List contact tagsList the contact tags in a workspace, optionally by name.
List contactsList contacts in a workspace, filtered by email address, tags or status.
List coursesList the courses in a workspace.
List form submissionsList the form submissions in a workspace, optionally only a contact's.
List funnelsList the funnels in a workspace.
List ordersList orders in a workspace, filtered by contact, type or live/test mode.
List productsList the products in a workspace.
List tags on contactList the tags a contact has, with the id to remove each.
List webhook endpointsList the addresses ClickFunnels sends event notifications to.
List workspacesList the workspaces of the teams the access token belongs to, with their subdomains.
Remove tag from contactTake a tag off a contact, using the applied-tag id from 'Add tag to contact' or 'List tags on contact'.
Update contactChange a contact's details.
Update contact noteChange a note's text or the time it happened.
Update contact tagRename a contact tag or change its colour.

Add contact note

Add a note to a contact's activity.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or an earlier step.
NotecontenttextRequired
The text of the note.
When it happenedoccurred_atdate and time
When the noted event happened. Defaults to now.

Outputs

noteobject
The new note
Example output
{
  "note": {
    "contact_id": 24359,
    "content": "Called about the refund.",
    "created_at": "2026-10-12T14:03:00.000Z",
    "created_by_id": 9,
    "id": 301,
    "occurred_at": "2026-10-12T14:03:00.000Z",
    "public_id": "nTe123",
    "updated_at": "2026-10-12T14:03:00.000Z"
  }
}

Add tag to contact

Put a tag on a contact. The result holds the applied-tag id that 'Remove tag from contact' needs.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or an earlier step.
Tagtag_idtextRequired
The contact tag. Pick one, or give its id from an earlier step.

Outputs

applied_tagobject
The tag on the contact
Example output
{
  "applied_tag": {
    "contact": null,
    "contact_id": 24359,
    "created_at": "2026-10-15T09:00:00.000Z",
    "id": 5,
    "public_id": "jgqvTJ",
    "tag": {
      "color": "#00FF00",
      "id": 60,
      "name": "Newsletter",
      "public_id": "rnZVJU"
    },
    "tag_id": 60,
    "updated_at": "2026-10-15T09:00:00.000Z"
  }
}

Create contact

Add a contact to a workspace. Fails if the workspace already has a contact with that email address; use 'Create or update contact' to cover both.

Inputs

Workspaceworkspace_idtext
The workspace to use. Leave empty for the workspace at the subdomain you connected with.
Email addressemail_addresstextRequired
The contact's email address.
First namefirst_nametext
The contact's first name.
Last namelast_nametext
The contact's last name.
Phone numberphone_numbertext
The contact's phone number.
Time zonetime_zonetext
ClickFunnels' name for the time zone, such as Pacific Time (US & Canada).
Websitewebsite_urltext
The contact's website address.
Custom attributescustom_attributesobject
Your own fields on the contact, as names and values. A name that is new creates the field; one that exists changes it.
Tagstag_idslist
Put these tags on the new contact.

Outputs

contactobject
The new contact
Example output
{
  "contact": {
    "created_at": "2026-10-15T09:00:00.000Z",
    "custom_attributes": {
      "company": "Acme"
    },
    "deleted_at": null,
    "email_address": "jo@example.com",
    "fb_url": null,
    "first_name": "Jo",
    "id": 24359,
    "instagram_url": null,
    "is_active": true,
    "last_name": "Bloggs",
    "linkedin_url": null,
    "phone_number": "+15555550100",
    "public_id": "vQxYMj",
    "tags": [],
    "time_zone": "Pacific Time (US & Canada)",
    "twitter_url": null,
    "unsubscribed_at": null,
    "updated_at": "2026-10-15T09:00:00.000Z",
    "website_url": null,
    "workspace_id": 4
  }
}

Create contact tag

Add a contact tag to a workspace.

Inputs

Workspaceworkspace_idtext
The workspace to use. Leave empty for the workspace at the subdomain you connected with.
NamenametextRequired
The tag's name.
Colorcolortext
A hex colour such as #2E7D32.

Outputs

tagobject
The new tag
Example output
{
  "tag": {
    "color": "#00FF00",
    "created_at": "2026-10-15T09:00:00.000Z",
    "id": 60,
    "name": "Newsletter",
    "public_id": "rnZVJU",
    "updated_at": "2026-10-15T09:00:00.000Z",
    "workspace_id": 4
  }
}

Create or update contact

Create the contact with this email address, or update them if they already exist. Fields left empty are not changed.

Inputs

Workspaceworkspace_idtext
The workspace to use. Leave empty for the workspace at the subdomain you connected with.
Email addressemail_addresstextRequired
The contact's email address.
First namefirst_nametext
The contact's first name. Leave empty to keep it.
Last namelast_nametext
The contact's last name. Leave empty to keep it.
Phone numberphone_numbertext
The contact's phone number. Leave empty to keep it.
Time zonetime_zonetext
ClickFunnels' name for the time zone, such as Pacific Time (US & Canada). Leave empty to keep it.
Websitewebsite_urltext
The contact's website address. Leave empty to keep it.
Custom attributescustom_attributesobject
Your own fields on the contact, as names and values. A name that is new creates the field; one that exists changes it.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "created_at": "2026-10-15T09:00:00.000Z",
    "custom_attributes": {
      "company": "Acme"
    },
    "deleted_at": null,
    "email_address": "jo@example.com",
    "fb_url": null,
    "first_name": "Jo",
    "id": 24359,
    "instagram_url": null,
    "is_active": true,
    "last_name": "Bloggs",
    "linkedin_url": null,
    "phone_number": "+15555550100",
    "public_id": "vQxYMj",
    "tags": [],
    "time_zone": "Pacific Time (US & Canada)",
    "twitter_url": null,
    "unsubscribed_at": null,
    "updated_at": "2026-10-15T09:00:00.000Z",
    "website_url": null,
    "workspace_id": 4
  }
}

Create webhook endpoint

Have ClickFunnels send the chosen events (contact created, order completed and so on) to an https address.

Inputs

Workspaceworkspace_idtext
The workspace to use. Leave empty for the workspace at the subdomain you connected with.
NamenametextRequired
A name for the endpoint, shown in ClickFunnels.
AddressurltextRequired
The https:// address to send notifications to.
Eventsevent_type_idslistRequired
The events to send.

Outputs

endpointobject
The new endpoint
Example output
{
  "endpoint": {
    "api_version": 2,
    "created_at": null,
    "event_type_ids": [
      "contact.created",
      "order.completed"
    ],
    "id": 12,
    "name": "Lodol",
    "public_id": "wHk789",
    "updated_at": null,
    "url": "https://example.com/hooks/clickfunnels",
    "webhook_secret_last_four": "a1b2",
    "workspace_id": 4
  }
}

Delete contact

Remove a contact from lists and filters. ClickFunnels keeps the record readable by id, marked deleted. Refused for a contact with an active subscription or course enrolments.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or an earlier step.

Outputs

contact_idtext
The id of the contact deleted
deletedtrue/false
Always true once deleted
Example output
{
  "contact_id": "24359",
  "deleted": true
}

Delete contact note

Permanently delete a note from a contact's activity.

Inputs

Note IDnote_idtextRequired
The note's id, from 'List contact notes' or 'Add contact note'.

Outputs

deletedtrue/false
Always true once deleted
note_idtext
The id of the note deleted
Example output
{
  "deleted": true,
  "note_id": "301"
}

Delete contact tag

Delete a contact tag. Contacts that had it lose it.

Inputs

Tagtag_idtextRequired
The contact tag. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
tag_idtext
The id of the tag deleted
Example output
{
  "deleted": true,
  "tag_id": "60"
}

Delete webhook endpoint

Delete a webhook endpoint so ClickFunnels stops sending to it.

Inputs

Webhook endpointendpoint_idtextRequired
The endpoint. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
Always true once deleted
endpoint_idtext
The id of the webhook endpoint deleted
Example output
{
  "deleted": true,
  "endpoint_id": "12"
}

Get contact

Get one contact with their tags and custom attributes.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or an earlier step.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "created_at": "2026-10-15T09:00:00.000Z",
    "custom_attributes": {
      "company": "Acme"
    },
    "deleted_at": null,
    "email_address": "jo@example.com",
    "fb_url": null,
    "first_name": "Jo",
    "id": 24359,
    "instagram_url": null,
    "is_active": true,
    "last_name": "Bloggs",
    "linkedin_url": null,
    "phone_number": "+15555550100",
    "public_id": "vQxYMj",
    "tags": [],
    "time_zone": "Pacific Time (US & Canada)",
    "twitter_url": null,
    "unsubscribed_at": null,
    "updated_at": "2026-10-15T09:00:00.000Z",
    "website_url": null,
    "workspace_id": 4
  }
}

Get current user

Get the ClickFunnels user the access token belongs to.

Inputs

None.

Outputs

userobject
The connected user
Example output
{
  "user": {
    "created_at": null,
    "email": "jo@example.com",
    "first_name": "Jo",
    "id": 9,
    "last_name": "Bloggs",
    "locale": "en",
    "public_id": "uSr001",
    "time_zone": "Pacific Time (US & Canada)",
    "updated_at": null
  }
}

List contact notes

List the notes in a contact's activity.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or an earlier step.
Orderdirectiontext
Sort order. Defaults to oldest first.One of: asc (Oldest first (default)), desc (Newest first).
Page sizelimitnumber
How many to return, 1 to 100. ClickFunnels' default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
noteslist
The notes
Example output
{
  "count": 1,
  "next_cursor": "",
  "notes": [
    {
      "contact_id": 24359,
      "content": "Called about the refund.",
      "created_at": "2026-10-12T14:03:00.000Z",
      "created_by_id": 9,
      "id": 301,
      "occurred_at": "2026-10-12T14:03:00.000Z",
      "public_id": "nTe123",
      "updated_at": "2026-10-12T14:03:00.000Z"
    }
  ]
}

List contact tags

List the contact tags in a workspace, optionally by name.

Inputs

Workspaceworkspace_idtext
The workspace to use. Leave empty for the workspace at the subdomain you connected with.
Namenametext
Only tags with this name.
Page sizelimitnumber
How many to return, 1 to 100. ClickFunnels' default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
tagslist
The tags
Example output
{
  "count": 1,
  "next_cursor": "",
  "tags": [
    {
      "color": "#00FF00",
      "created_at": "2026-10-15T09:00:00.000Z",
      "id": 60,
      "name": "Newsletter",
      "public_id": "rnZVJU",
      "updated_at": "2026-10-15T09:00:00.000Z",
      "workspace_id": 4
    }
  ]
}

List contacts

List contacts in a workspace, filtered by email address, tags or status. Gets one page; to see more, run it again with the next page cursor it gives.

Inputs

Workspaceworkspace_idtext
The workspace to use. Leave empty for the workspace at the subdomain you connected with.
Email addressemail_addresstext
Only contacts with this address. Several can be given, separated by commas.
Tagstag_idslist
Only contacts that have these tags.
Statusactivetext
Whether to include active or inactive contacts.One of: any (Active and inactive (default)), active (Active only), inactive (Inactive only).
Sort bysort_bytext
What to sort by. Defaults to when created.One of: id (When created (default)), updated_at (When last changed).
Orderdirectiontext
Sort order. Defaults to oldest first.One of: asc (Oldest first (default)), desc (Newest first).
Page sizelimitnumber
How many to return, 1 to 100. ClickFunnels' default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

contactslist
The contacts
countnumber
How many on this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
Example output
{
  "contacts": [
    {
      "created_at": "2026-10-15T09:00:00.000Z",
      "custom_attributes": {
        "company": "Acme"
      },
      "deleted_at": null,
      "email_address": "jo@example.com",
      "fb_url": null,
      "first_name": "Jo",
      "id": 24359,
      "instagram_url": null,
      "is_active": true,
      "last_name": "Bloggs",
      "linkedin_url": null,
      "phone_number": "+15555550100",
      "public_id": "vQxYMj",
      "tags": [],
      "time_zone": "Pacific Time (US & Canada)",
      "twitter_url": null,
      "unsubscribed_at": null,
      "updated_at": "2026-10-15T09:00:00.000Z",
      "website_url": null,
      "workspace_id": 4
    }
  ],
  "count": 1,
  "next_cursor": ""
}

List courses

List the courses in a workspace.

Inputs

Workspaceworkspace_idtext
The workspace to use. Leave empty for the workspace at the subdomain you connected with.
Page sizelimitnumber
How many to return, 1 to 100. ClickFunnels' default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
courseslist
The courses
next_cursortext
Pass as 'after' for the next page; empty on the last one
Example output
{
  "count": 1,
  "courses": [
    {
      "created_at": null,
      "current_path": null,
      "description": "A short course.",
      "id": 14,
      "public_id": "cRs001",
      "published_at": "2026-10-01T09:00:00.000Z",
      "title": "Getting started",
      "updated_at": null
    }
  ],
  "next_cursor": ""
}

List form submissions

List the form submissions in a workspace, optionally only a contact's.

Inputs

Workspaceworkspace_idtext
The workspace to use. Leave empty for the workspace at the subdomain you connected with.
Contact IDcontact_idtext
Only this contact's submissions.
Orderdirectiontext
Sort order. Defaults to oldest first.One of: asc (Oldest first (default)), desc (Newest first).
Page sizelimitnumber
How many to return, 1 to 100. ClickFunnels' default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
submissionslist
The submissions
Example output
{
  "count": 1,
  "next_cursor": "",
  "submissions": [
    {
      "contact_id": 24359,
      "created_at": null,
      "data": {
        "email": "jo@example.com"
      },
      "id": 501,
      "page_id": 62,
      "public_id": "sUb001",
      "updated_at": null,
      "workspace_id": 4
    }
  ]
}

List funnels

List the funnels in a workspace.

Inputs

Workspaceworkspace_idtext
The workspace to use. Leave empty for the workspace at the subdomain you connected with.
Page sizelimitnumber
How many to return, 1 to 100. ClickFunnels' default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
funnelslist
The funnels
next_cursortext
Pass as 'after' for the next page; empty on the last one
Example output
{
  "count": 1,
  "funnels": [
    {
      "archived": false,
      "created_at": null,
      "current_path": "/webinar",
      "id": 31,
      "live_mode": true,
      "name": "Webinar funnel",
      "public_id": "fUn001",
      "tags": null,
      "updated_at": null,
      "workspace_id": 4
    }
  ],
  "next_cursor": ""
}

List orders

List orders in a workspace, filtered by contact, type or live/test mode. Live orders only unless you choose otherwise.

Inputs

Workspaceworkspace_idtext
The workspace to use. Leave empty for the workspace at the subdomain you connected with.
Contact IDcontact_idtext
Only this contact's orders.
Typeorder_typetext
One-time orders or subscriptions.One of: any (All orders (default)), one-time-order (One-time orders), subscription-order (Subscriptions).
Live or testlive_modetext
Real orders or test orders. Defaults to live.One of: live (Live orders (default)), test (Test orders), any (Live and test orders).
Orderdirectiontext
Sort order. Defaults to oldest first.One of: asc (Oldest first (default)), desc (Newest first).
Page sizelimitnumber
How many to return, 1 to 100. ClickFunnels' default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
orderslist
The orders
Example output
{
  "count": 1,
  "next_cursor": "",
  "orders": [
    {
      "billing_status": "paid",
      "contact": null,
      "contact_id": 24359,
      "created_at": "2026-10-15T09:00:00.000Z",
      "currency": "USD",
      "funnel_name": null,
      "id": 22642,
      "line_items": [],
      "live_mode": true,
      "order_number": "#2146",
      "order_type": "one-time-order",
      "page_name": null,
      "public_id": "JmRRyN",
      "service_status": "active",
      "tax_amount": null,
      "total_amount": "396.00",
      "updated_at": null,
      "workspace_id": 4
    }
  ]
}

List products

List the products in a workspace. Archived ones are left out unless asked for.

Inputs

Workspaceworkspace_idtext
The workspace to use. Leave empty for the workspace at the subdomain you connected with.
Archivedarchivedtext
Whether to include archived products.One of: active (Not archived (default)), archived, any (Archived and not).
Page sizelimitnumber
How many to return, 1 to 100. ClickFunnels' default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
productslist
The products
Example output
{
  "count": 1,
  "next_cursor": "",
  "products": [
    {
      "archived": false,
      "created_at": "2026-10-01T09:00:00.000Z",
      "current_path": null,
      "default_variant_id": 88,
      "id": 77,
      "name": "Starter course",
      "price_ids": null,
      "public_id": "pRd456",
      "updated_at": null,
      "variant_ids": null,
      "visible_in_customer_center": null,
      "visible_in_store": true,
      "workspace_id": 4
    }
  ]
}

List tags on contact

List the tags a contact has, with the id to remove each.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or an earlier step.
Page sizelimitnumber
How many to return, 1 to 100. ClickFunnels' default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

applied_tagslist
The tags on the contact
countnumber
How many on this page
next_cursortext
Pass as 'after' for the next page; empty on the last one
Example output
{
  "applied_tags": [
    {
      "contact": null,
      "contact_id": 24359,
      "created_at": "2026-10-15T09:00:00.000Z",
      "id": 5,
      "public_id": "jgqvTJ",
      "tag": {
        "color": "#00FF00",
        "id": 60,
        "name": "Newsletter",
        "public_id": "rnZVJU"
      },
      "tag_id": 60,
      "updated_at": "2026-10-15T09:00:00.000Z"
    }
  ],
  "count": 1,
  "next_cursor": ""
}

List webhook endpoints

List the addresses ClickFunnels sends event notifications to.

Inputs

Workspaceworkspace_idtext
The workspace to use. Leave empty for the workspace at the subdomain you connected with.
Page sizelimitnumber
How many to return, 1 to 100. ClickFunnels' default is 20.From 1 to 100.
Next page cursoraftertext
The 'next_cursor' from an earlier page, to get the page after it.

Outputs

countnumber
How many on this page
endpointslist
The endpoints
next_cursortext
Pass as 'after' for the next page; empty on the last one
Example output
{
  "count": 1,
  "endpoints": [
    {
      "api_version": 2,
      "created_at": null,
      "event_type_ids": [
        "contact.created",
        "order.completed"
      ],
      "id": 12,
      "name": "Lodol",
      "public_id": "wHk789",
      "updated_at": null,
      "url": "https://example.com/hooks/clickfunnels",
      "webhook_secret_last_four": "a1b2",
      "workspace_id": 4
    }
  ],
  "next_cursor": ""
}

List workspaces

List the workspaces of the teams the access token belongs to, with their subdomains.

Inputs

None.

Outputs

countnumber
How many
workspaceslist
The workspaces
Example output
{
  "count": 1,
  "workspaces": [
    {
      "created_at": null,
      "id": 4,
      "name": "Acme Sales",
      "public_id": "wSp001",
      "subdomain": "acme",
      "team_id": 2,
      "team_name": "Acme",
      "updated_at": null
    }
  ]
}

Remove tag from contact

Take a tag off a contact, using the applied-tag id from 'Add tag to contact' or 'List tags on contact'.

Inputs

Applied tag IDapplied_tag_idtextRequired
The id of the tag on the contact (not the tag's own id).

Outputs

applied_tag_idtext
The id of the applied tag deleted
deletedtrue/false
Always true once deleted
Example output
{
  "applied_tag_id": "5",
  "deleted": true
}

Update contact

Change a contact's details. Only the fields given change; to change their tags use 'Add tag to contact' and 'Remove tag from contact'.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or an earlier step.
Email addressemail_addresstext
A new email address. Leave empty to keep it.
First namefirst_nametext
The contact's first name. Leave empty to keep it.
Last namelast_nametext
The contact's last name. Leave empty to keep it.
Phone numberphone_numbertext
The contact's phone number. Leave empty to keep it.
Time zonetime_zonetext
ClickFunnels' name for the time zone, such as Pacific Time (US & Canada). Leave empty to keep it.
Websitewebsite_urltext
The contact's website address. Leave empty to keep it.
Custom attributescustom_attributesobject
Your own fields on the contact, as names and values. A name that is new creates the field; one that exists changes it.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "created_at": "2026-10-15T09:00:00.000Z",
    "custom_attributes": {
      "company": "Acme"
    },
    "deleted_at": null,
    "email_address": "jo@example.com",
    "fb_url": null,
    "first_name": "Joanne",
    "id": 24359,
    "instagram_url": null,
    "is_active": true,
    "last_name": "Bloggs",
    "linkedin_url": null,
    "phone_number": "+15555550100",
    "public_id": "vQxYMj",
    "tags": [],
    "time_zone": "Pacific Time (US & Canada)",
    "twitter_url": null,
    "unsubscribed_at": null,
    "updated_at": "2026-10-15T09:00:00.000Z",
    "website_url": null,
    "workspace_id": 4
  }
}

Update contact note

Change a note's text or the time it happened.

Inputs

Note IDnote_idtextRequired
The note's id, from 'List contact notes' or 'Add contact note'.
Notecontenttext
The new text. Leave empty to keep it.
When it happenedoccurred_atdate and time
A new time. Leave empty to keep it.

Outputs

noteobject
The note
Example output
{
  "note": {
    "contact_id": 24359,
    "content": "Called back.",
    "created_at": "2026-10-12T14:03:00.000Z",
    "created_by_id": 9,
    "id": 301,
    "occurred_at": "2026-10-12T14:03:00.000Z",
    "public_id": "nTe123",
    "updated_at": "2026-10-12T14:03:00.000Z"
  }
}

Update contact tag

Rename a contact tag or change its colour.

Inputs

Tagtag_idtextRequired
The contact tag. Pick one, or give its id from an earlier step.
Namenametext
A new name. Leave empty to keep it.
Colorcolortext
A new hex colour such as #2E7D32. Leave empty to keep it.

Outputs

tagobject
The tag
Example output
{
  "tag": {
    "color": "#00FF00",
    "created_at": "2026-10-15T09:00:00.000Z",
    "id": 60,
    "name": "Newsletter (old)",
    "public_id": "rnZVJU",
    "updated_at": "2026-10-15T09:00:00.000Z",
    "workspace_id": 4
  }
}

On this page