{"id":"pg_tz_db07aqawz","property_id":"prp_pfcr5h8cztsp","domain_id":"dom_gkgeprhezjg4wq","root_domain":"smashsend.com","locale":"en","url":"https://smashsend.com/docs/api/contact-properties","url_hash":"53c57b1d5e86378544a4cacc9ba622770462b137dd61e740f9a74ff0bba8247b","path":"/docs/api/contact-properties","depth":1,"canonical_url":"https://smashsend.com/docs/api/contact-properties","canonical_page_id":null,"page_type":"docs","page_type_guess":"docs","state":"indexed","skip_reason":null,"priority":"1.4","discovered_via":"sitemap","first_seen_at":"2026-08-28T03:07:01.092Z","last_seen_at":"2026-09-27T04:11:33.153Z","http_status":200,"content_hash":"9a28c6efe6957ed4ec59202071b4603e14ea8bcf0556a808329953af51da486e","title":"SMASHSEND Contact Properties API Reference","description":"Reference documentation for the SMASHSEND Contact Properties API endpoints - manage custom fields for advanced contact data collection.","author":null,"published_at":null,"modified_at":null,"word_count":727,"reading_time_sec":198,"lang_detected":"en","images":[],"links_out":null,"markdown_source":"readability","refresh_interval":"monthly","last_fetched_at":"2026-09-27T04:09:15.510Z","next_refresh_at":"2026-10-27T04:09:15.510Z","runs_count":2,"changes_count":0,"last_changed_at":null,"fail_count":0,"last_error":null,"created_at":"2026-08-28T03:07:01.092Z","updated_at":"2026-08-28T03:07:01.092Z","inlinks":14,"inlinks_body":0,"outlinks":40,"outlinks_external":3,"anchor_terms":[],"template_score":"0.09859154929577464789","cash":"0.324867090679999631","cash_total":"0.6689037468432432082","pagerank":"0.0206041785302624","is_orphan":false,"link_confirmed":true,"discovered_wave":0,"embedded_hash":null,"embedded_at":null,"domain_name":null,"brand_color":null,"domain_rank":null,"spam_score":null,"markdown":"1.  [\n    \n    Home\n    \n    ](https://smashsend.com/)\n\n/\n\n3.  [\n    \n    Docs\n    \n    ](https://smashsend.com/docs)\n\n/\n\n5.  [\n    \n    API Reference\n    \n    ](https://smashsend.com/docs/api)\n\n/\n\n7.  [\n    \n    Contact Properties\n    \n    ](https://smashsend.com/docs/api/contact-properties)\n\nThe Contact Properties API allows you to create and manage custom fields for contacts. This is essential for Zapier integrations and other automation platforms that need to sync additional data fields from CRMs, e-commerce platforms, and other business systems.\n\n## Overview\n\nContact properties are custom fields that extend the default contact schema. Common use cases include storing job titles, company information, lead sources, subscription preferences, and any other business-specific data.\n\n**Property Types:** STRING, TEXT, EMAIL, URL, PHONE, DATE, NUMBER, INTEGER, BOOLEAN\n\n**Base URL:** `https://api.smashsend.com`\n\n## Contact Properties Endpoints\n\n### GET/v1/contact-properties\n\nLists all contact properties for the authenticated workspace. Perfect for Zapier integrations to dynamically discover available custom fields.\n\nRequest\n\n```\ncurl \"https://api.smashsend.com/v1/contact-properties\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"\n```\n\nResponse\n\n```\n{\n  \"properties\": {\n    \"items\": [\n      {\n        \"createdAt\": \"2025-06-04T05:25:48.742Z\",\n        \"description\": \"The unique identifier of the contact\",\n        \"displayName\": \"Email\",\n        \"id\": \"email\",\n        \"isInternal\": true,\n        \"apiSlug\": \"email\",\n        \"type\": \"STRING\",\n        \"typeConfig\": {},\n        \"updatedAt\": \"2025-06-04T05:25:48.742Z\",\n        \"workspaceId\": \"wrk_ENGTK86JEXXckyDVJthKkPer\",\n        \"options\": []\n      },\n      {\n        \"id\": \"cpd_SXag0kCw5p4yCrEItHQQHoew\",\n        \"apiSlug\": \"company\",\n        \"createdAt\": \"2025-06-04T05:26:13.716Z\",\n        \"description\": \"Company name of the contact\",\n        \"displayName\": \"Company\",\n        \"isInternal\": false,\n        \"type\": \"STRING\",\n        \"typeConfig\": {},\n        \"updatedAt\": null,\n        \"workspaceId\": \"wrk_ENGTK86JEXXckyDVJthKkPer\",\n        \"options\": []\n      }\n    ],\n    \"hasMore\": false\n  }\n}\n```\n\n### GET/v1/contact-properties/{propertyId}\n\nRetrieves details of a specific contact property.\n\nRequest\n\n```\ncurl \"https://api.smashsend.com/v1/contact-properties/cpd_SXag0kCw5p4yCrEItHQQHoew\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"\n```\n\nResponse\n\n```\n{\n  \"property\": {\n    \"id\": \"cpd_SXag0kCw5p4yCrEItHQQHoew\",\n    \"apiSlug\": \"company\",\n    \"displayName\": \"Company\",\n    \"type\": \"STRING\",\n    \"description\": \"Company name of the contact\",\n    \"createdAt\": \"2025-06-04T05:26:13.716Z\",\n    \"typeConfig\": {},\n    \"updatedAt\": null,\n    \"workspaceId\": \"wrk_ENGTK86JEXXckyDVJthKkPer\",\n    \"options\": []\n  }\n}\n```\n\n### POST/v1/contact-properties\n\nCreates a new contact property. Essential for setting up custom fields before syncing data from external systems via Zapier.\n\nRequest\n\n```\ncurl -X POST \"https://api.smashsend.com/v1/contact-properties\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"displayName\": \"Lead Source\",\n    \"type\": \"STRING\",\n    \"description\": \"Where this contact was acquired from\",\n    \"typeConfig\": {}\n  }'\n```\n\nResponse\n\n```\n{\n  \"property\": {\n    \"id\": \"cpd_stu901vwx234\",\n    \"apiSlug\": \"leadSource\",\n    \"displayName\": \"Lead Source\",\n    \"type\": \"STRING\",\n    \"description\": \"Where this contact was acquired from\",\n    \"createdAt\": \"2024-03-21T14:30:00Z\",\n    \"typeConfig\": {},\n    \"updatedAt\": null,\n    \"workspaceId\": \"wrk_ENGTK86JEXXckyDVJthKkPer\",\n    \"options\": []\n  }\n}\n```\n\n### POST/v1/contact-properties/{propertyId}\n\nUpdates an existing contact property. Note that the apiSlug and type cannot be changed after creation.\n\nRequest Body Parameters\n\n`displayName` - New display name for the property (optional)\n\n`description` - New description for the property (optional)\n\n`typeConfig` - Configuration for the property type (optional)\n\nRequest\n\n```\ncurl -X POST \"https://api.smashsend.com/v1/contact-properties/cpd_SXag0kCw5p4yCrEItHQQHoew\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"displayName\": \"Company Name\",\n    \"description\": \"Full legal company name of the contact\"\n  }'\n```\n\nResponse\n\n```\n{\n  \"property\": {\n    \"id\": \"cpd_SXag0kCw5p4yCrEItHQQHoew\",\n    \"apiSlug\": \"company\",\n    \"displayName\": \"Company Name\",\n    \"type\": \"STRING\",\n    \"description\": \"Full legal company name of the contact\",\n    \"createdAt\": \"2025-06-04T05:26:13.716Z\",\n    \"typeConfig\": {},\n    \"updatedAt\": \"2024-03-21T16:45:00Z\",\n    \"workspaceId\": \"wrk_ENGTK86JEXXckyDVJthKkPer\",\n    \"options\": []\n  }\n}\n```\n\n### DELETE/v1/contact-properties/{propertyId}\n\nPermanently deletes a contact property. This will also remove all data stored in this property for all contacts. Use with extreme caution.\n\nRequest\n\n```\ncurl -X DELETE \"https://api.smashsend.com/v1/contact-properties/cpd_SXag0kCw5p4yCrEItHQQHoew\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\"\n```\n\nResponse\n\n```\n{\n  \"property\": {\n    \"id\": \"cpd_SXag0kCw5p4yCrEItHQQHoew\",\n    \"apiSlug\": \"company\",\n    \"displayName\": \"Company\",\n    \"type\": \"STRING\",\n    \"description\": \"Company name of the contact\",\n    \"createdAt\": \"2025-06-04T05:26:13.716Z\",\n    \"typeConfig\": {},\n    \"updatedAt\": null,\n    \"workspaceId\": \"wrk_ENGTK86JEXXckyDVJthKkPer\",\n    \"options\": []\n  },\n  \"isDeleted\": true\n}\n```\n\n## Property Types Reference\n\nSTRING\n\nShort text values, ideal for names, categories, statuses. Maximum 255 characters.\n\nTEXT\n\nLong text values for descriptions, notes, comments. No character limit.\n\nEMAIL\n\nEmail addresses with automatic validation.\n\nURL\n\nWebsite URLs with automatic validation.\n\nPHONE\n\nPhone numbers with flexible formatting.\n\nDATE\n\nDate values in ISO 8601 format (YYYY-MM-DD).\n\nNUMBER\n\nDecimal numbers for prices, ratings, percentages.\n\nINTEGER\n\nWhole numbers for counts, ages, quantities.\n\nBOOLEAN\n\nTrue/false values for flags, preferences, statuses.\n\n## Using Properties with Contacts API\n\nOnce you create contact properties, you can use them in the Contacts API by referencing their apiSlug in the customProperties object:\n\n```\n// Create a contact with custom properties\ncurl -X POST \"https://api.smashsend.com/v1/contacts\" \\\n  -H \"Authorization: Bearer YOUR_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"properties\": {\n      \"email\": \"john.doe@example.com\",\n      \"firstName\": \"John\",\n      \"lastName\": \"Doe\",\n      \"company\": \"ACME Corp\",\n      \"jobTitle\": \"Marketing Manager\",\n      \"leadSource\": \"website\",\n      \"isCustomer\": true\n    }\n  }'\n```\n\n## Common Integration Examples\n\nCRM Integration Properties\n\n```\n{\n  \"company\": \"STRING\",\n  \"jobTitle\": \"STRING\", \n  \"industry\": \"STRING\",\n  \"annualRevenue\": \"NUMBER\",\n  \"leadScore\": \"INTEGER\",\n  \"lastContactDate\": \"DATE\",\n  \"isQualified\": \"BOOLEAN\"\n}\n```\n\nE-commerce Integration Properties\n\n```\n{\n  \"customerSince\": \"DATE\",\n  \"totalOrders\": \"INTEGER\",\n  \"lifetimeValue\": \"NUMBER\",\n  \"preferredCategory\": \"STRING\",\n  \"isVip\": \"BOOLEAN\",\n  \"lastPurchaseDate\": \"DATE\"\n}\n```\n\nForm Integration Properties\n\n```\n{\n  \"formSource\": \"STRING\",\n  \"referralSource\": \"STRING\",\n  \"interests\": \"TEXT\",\n  \"budget\": \"STRING\",\n  \"timeline\": \"STRING\",\n  \"hasOptedInMarketing\": \"BOOLEAN\"\n}\n```\n\n## Error Handling\n\n400 - Validation Error\n\n```\n{\n  \"statusCode\": 400,\n  \"error\": \"Bad Request\",\n  \"message\": \"apiSlug must be unique and contain only lowercase letters, numbers, and underscores\"\n}\n```\n\n409 - Property Already Exists\n\n```\n{\n  \"statusCode\": 409,\n  \"error\": \"Conflict\",\n  \"message\": \"A property with this apiSlug already exists\"\n}\n```","storage":{"htmlKey":"stealpage/html/smashsend.com/pg_tz_db07aqawz/run_8cdf6et5hqs_.html.gz","markdownKey":"stealpage/md/smashsend.com/pg_tz_db07aqawz/run_8cdf6et5hqs_.md.gz"},"facets":null,"assets":[{"kind":"image","src_url":"https://smashsend.com/ogs/api-docs.jpg","r2_key":null,"alt":null,"caption":null,"width":null,"height":null,"is_hero":true,"zone":"main"},{"kind":"image","src_url":"https://smashsend.com/_next/static/media/smashsend_dark.da05b6ec.svg","r2_key":null,"alt":"SMASHSEND email marketing - The #1 Email Marketing Tool that turns emails into revenue","caption":null,"width":135,"height":30,"is_hero":false,"zone":"unknown"},{"kind":"image","src_url":"https://smashsend.com/dashboard/integrations/zapier_icon_filled.png","r2_key":null,"alt":"Zapier","caption":null,"width":20,"height":20,"is_hero":false,"zone":"nav"},{"kind":"image","src_url":"https://smashsend.com/dashboard/integrations/mailchimp_icon.png","r2_key":null,"alt":"Mailchimp","caption":null,"width":20,"height":20,"is_hero":false,"zone":"nav"},{"kind":"image","src_url":"https://smashsend.com/dashboard/integrations/webhooks_icon_gradient.png","r2_key":null,"alt":"Webhooks","caption":null,"width":20,"height":20,"is_hero":false,"zone":"nav"},{"kind":"image","src_url":"https://smashsend.com/dashboard/integrations/events.png","r2_key":null,"alt":"Events API","caption":null,"width":20,"height":20,"is_hero":false,"zone":"nav"},{"kind":"image","src_url":"https://smashsend.com/_next/image?q=75&url=%2Favatar-profile.png&w=3840","r2_key":null,"alt":"Jorge Ferreiro","caption":null,"width":null,"height":null,"is_hero":false,"zone":"nav"},{"kind":"image","src_url":"https://smashsend.com/_next/image?url=%2Favatar-profile.png&w=3840&q=75","r2_key":null,"alt":"Jorge Ferreiro","caption":null,"width":null,"height":null,"is_hero":false,"zone":"nav"},{"kind":"image","src_url":"https://smashsend.com/_next/static/media/smashsend_light.be8a3849.svg","r2_key":null,"alt":"SMASHSEND email marketing - The #1 Email Marketing Tool that turns emails into revenue","caption":null,"width":171,"height":38,"is_hero":false,"zone":"footer"},{"kind":"image","src_url":"https://smashsend.com/marketing/legal/gdpr_compliance.png","r2_key":null,"alt":"SOC2","caption":null,"width":null,"height":50,"is_hero":false,"zone":"footer"}],"shots":[{"viewport":"mobile","width":390,"height":844,"r2_key":"stealpage/shots/smashsend.com/pg_tz_db07aqawz/run_8cdf6et5hqs_-mobile.png","phash":"26d2a884c08c88a2","visual_delta":0,"captured_at":"2026-09-27T04:09:19.675Z"},{"viewport":"desktop","width":1440,"height":900,"r2_key":"stealpage/shots/smashsend.com/pg_tz_db07aqawz/run_8cdf6et5hqs_-desktop.png","phash":"86606160406040e1","visual_delta":0,"captured_at":"2026-09-27T04:09:19.461Z"},{"viewport":"mobile","width":390,"height":844,"r2_key":"stealpage/shots/smashsend.com/pg_tz_db07aqawz/run_nmhzdkaafarl-mobile.png","phash":"26d2a884c08c88a2","visual_delta":null,"captured_at":"2026-08-28T03:13:19.382Z"},{"viewport":"desktop","width":1440,"height":900,"r2_key":"stealpage/shots/smashsend.com/pg_tz_db07aqawz/run_nmhzdkaafarl-desktop.png","phash":"86606160406040e1","visual_delta":null,"captured_at":"2026-08-28T03:13:18.533Z"}],"history":[{"id":"run_8cdf6et5hqs_","started_at":"2026-09-27T04:09:15.504Z","http_status":200,"fetcher":"direct","changed":false,"diff":{"added":0,"removed":63,"similarity":null},"word_count":727},{"id":"run_nmhzdkaafarl","started_at":"2026-08-28T03:13:08.770Z","http_status":200,"fetcher":"direct","changed":false,"diff":null,"word_count":790}],"citedBy":[]}