Type of a user-defined custom property on a contact.
The order mirrors the Postgres crm_property_kind_enum: TEXTAREA was
appended in 0014 (alongside MULTI_SELECT), EMAIL and MONEY in 0025, FILE
in 0065, URL in 0167, MULTI_FILE in 0186. EMAIL and URL store into
value_text (like TEXT) and MONEY into value_number (like NUMBER) —
they're presentation/validation refinements of those base columns, not new
storage shapes. FILE and MULTI_FILE both store an array of S3 file
references in value_json (see ciarem_crm.file_property); they differ
only in cardinality — FILE holds at most one file, MULTI_FILE a capped
gallery. Pre-0186, FILE meant the gallery; 0186 renamed those rows to
MULTI_FILE and repurposed FILE as the single-file kind (it was
catalogs-only, so no contact data existed). The bytes live in the
record-media bucket.
The denomination of a MONEY property definition. Active circulating
codes only — the fund/metal/testing X-codes (XAU, XDR, XTS, XXX, …)
are excluded, while the circulating X-currencies (XAF, XOF, XPF, XCD)
stay. Stored as TEXT (no Postgres enum): the set is ISO's, not ours,
and codes retire/appear with currency reforms (SLL→SLE, ZWL→ZWG) —
validation lives at the API boundary where it can evolve without a
migration.
Type of a user-defined custom property on a contact.
The order mirrors the Postgres crm_property_kind_enum: TEXTAREA was
appended in 0014 (alongside MULTI_SELECT), EMAIL and MONEY in 0025, FILE
in 0065, URL in 0167, MULTI_FILE in 0186. EMAIL and URL store into
value_text (like TEXT) and MONEY into value_number (like NUMBER) —
they're presentation/validation refinements of those base columns, not new
storage shapes. FILE and MULTI_FILE both store an array of S3 file
references in value_json (see ciarem_crm.file_property); they differ
only in cardinality — FILE holds at most one file, MULTI_FILE a capped
gallery. Pre-0186, FILE meant the gallery; 0186 renamed those rows to
MULTI_FILE and repurposed FILE as the single-file kind (it was
catalogs-only, so no contact data existed). The bytes live in the
record-media bucket.
The denomination of a MONEY property definition. Active circulating
codes only — the fund/metal/testing X-codes (XAU, XDR, XTS, XXX, …)
are excluded, while the circulating X-currencies (XAF, XOF, XPF, XCD)
stay. Stored as TEXT (no Postgres enum): the set is ISO's, not ours,
and codes retire/appear with currency reforms (SLL→SLE, ZWL→ZWG) —
validation lives at the API boundary where it can evolve without a
migration.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ciarem","description":"Ciarem help center: set up and run your AI agent across WhatsApp, Instagram, Messenger, and your website.","colors":{"primary":"#7669FC","light":"#9B8CFF","dark":"#5B4BD6"},"logo":{"light":"https://mintcdn.com/ciaremaai/FrCl9vIQUOJmXw0K/logo/ciarem-logo.svg?fit=max\u0026auto=format\u0026n=FrCl9vIQUOJmXw0K\u0026q=85\u0026s=4826d113777f270789a291ef1256cbbe","dark":"https://mintcdn.com/ciaremaai/FrCl9vIQUOJmXw0K/logo/ciarem-logo.svg?fit=max\u0026auto=format\u0026n=FrCl9vIQUOJmXw0K\u0026q=85\u0026s=4826d113777f270789a291ef1256cbbe"},"favicon":"https://mintcdn.com/ciaremaai/rrKvoMfzjsUS61Og/favicon.png?fit=max\u0026auto=format\u0026n=rrKvoMfzjsUS61Og\u0026q=85\u0026s=39e5fa47dd157989e89d46ead28399a2","appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"ciarem.ai","href":"https://www.ciarem.ai"}},"footer":{"socials":{"website":"https://www.ciarem.ai"}},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","href":"getting-started/what-is-ciarem"},{"language":"es","href":"es/getting-started/what-is-ciarem"},{"language":"pt","href":"pt/getting-started/what-is-ciarem"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ciaremaai","hasAudioNarration":false,"actualSubdomain":"ciaremaai","customDomains":["help.ciarem.ai"],"gitSource":{"type":"github","owner":"ciaremai","repo":"help-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"09136749-6548-4593-89b3-d20006830c59","liveDeploymentHistoryId":"6adfa9f24c626e3171be5150","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfa9f24c626e3171be5150"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adfa9f24c626e3171be5150","clientVersion":"0.0.3969","searchFilterCounts":[{"language":"default","tag":"API for developers","count":40},{"language":"default","tag":"API reference","count":40},{"language":"en","tag":"Channels","count":17},{"language":"es","tag":"Canales","count":17},{"language":"pt","tag":"Canais","count":17},{"language":"en","tag":"Your AI agent","count":13},{"language":"es","tag":"Tu agente de IA","count":13},{"language":"pt","tag":"Seu agente de IA","count":13},{"language":"en","tag":"WhatsApp","count":12},{"language":"es","tag":"WhatsApp","count":12},{"language":"pt","tag":"WhatsApp","count":12},{"language":"default","tag":"CRM","count":11},{"language":"en","tag":"Using Ciarem","count":10},{"language":"es","tag":"Usando Ciarem","count":10},{"language":"pt","tag":"Usando a Ciarem","count":10},{"language":"default","tag":"Webhooks","count":9},{"language":"en","tag":"API for developers","count":8},{"language":"es","tag":"API para desarrolladores","count":8},{"language":"pt","tag":"API para desenvolvedores","count":8},{"language":"en","tag":"Agent team","count":5},{"language":"en","tag":"Integrations","count":5},{"language":"es","tag":"Equipo de agentes","count":5},{"language":"es","tag":"Integraciones","count":5},{"language":"pt","tag":"Equipe de agentes","count":5},{"language":"pt","tag":"Integrações","count":5},{"language":"default","tag":"Broadcasts","count":5},{"language":"default","tag":"Contacts","count":5},{"language":"default","tag":"WhatsApp templates","count":5},{"language":"en","tag":"Mobile app","count":4},{"language":"en","tag":"Webhooks","count":4},{"language":"es","tag":"App móvil","count":4},{"language":"es","tag":"Webhooks","count":4},{"language":"pt","tag":"App móvel","count":4},{"language":"pt","tag":"Webhooks","count":4},{"language":"en","tag":"What your agent can do","count":3},{"language":"es","tag":"Qué puede hacer tu agente","count":3},{"language":"pt","tag":"O que seu agente pode fazer","count":3},{"language":"default","tag":"Conversations","count":3},{"language":"default","tag":"Account","count":1},{"language":"default","tag":"WhatsApp numbers","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/crm/create-a-custom-property","slug":"/api-reference/crm/create-a-custom-property","pageMetadata":{"title":"Create a custom property","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/properties","href":"/api-reference/crm/create-a-custom-property","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create a custom property","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/properties","href":"/api-reference/crm/create-a-custom-property","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["CRM"],"summary":"Create a custom property","operationId":"create_property_endpoint_v1_properties_post","requestBody":"81f1a690-f076-4590-8691-222d68914616","responses":{"201":"4b164034-71f5-49b4-86ac-087474d128dc","400":"3e31a353-5fa4-47ca-b44e-9e1380eb9a65","401":"37900999-cc3b-4656-9bd4-ce3e48872f00","403":"d75c168e-e838-42e9-973e-6257ad1a269a","409":"36344b3d-4e60-479a-b83c-45b41ffb802a","422":"9d2590c7-a772-418a-9635-e569a62d718f","429":"48c5110a-9574-4f0d-a2ae-d5fce7ed5980","503":"c30d2646-037b-4d84-b161-89c78f90961f"},"method":"post","type":"path","servers":["5b78e9ff-1963-4818-8c29-aa7c2f9cadbc"],"security":["c28375ca-7ae9-4d52-aa3f-f21832e5f2a6"],"path":"/v1/properties","baseUrlOptions":["https://api.ciarem.ai"],"title":"Create a custom property","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"key":{"type":"string","minLength":1,"title":"Key","isRequired":true,"uniqueKey":"key","typeLabel":"string"},"label":{"type":"string","minLength":1,"title":"Label","isRequired":true,"uniqueKey":"label","typeLabel":"string"},"kind":{"type":"string","enum":["TEXT","NUMBER","RADIO","DROPDOWN","BOOLEAN","DATE","TEXTAREA","MULTI_SELECT","EMAIL","MONEY","FILE","URL","MULTI_FILE"],"title":"CrmPropertyKind","description":"Type of a user-defined custom property on a contact.\n\nThe order mirrors the Postgres `crm_property_kind_enum`: TEXTAREA was\nappended in 0014 (alongside MULTI_SELECT), EMAIL and MONEY in 0025, FILE\nin 0065, URL in 0167, MULTI_FILE in 0186. `EMAIL` and `URL` store into\n`value_text` (like TEXT) and `MONEY` into `value_number` (like NUMBER) —\nthey're presentation/validation refinements of those base columns, not new\nstorage shapes. `FILE` and `MULTI_FILE` both store an array of S3 file\nreferences in `value_json` (see `ciarem_crm.file_property`); they differ\nonly in cardinality — FILE holds at most one file, MULTI_FILE a capped\ngallery. Pre-0186, FILE meant the gallery; 0186 renamed those rows to\nMULTI_FILE and repurposed FILE as the single-file kind (it was\ncatalogs-only, so no contact data existed). The bytes live in the\n`record-media` bucket.","isRequired":true,"uniqueKey":"kind","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"type":"string","title":"Description","maxLength":500,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"options":{"oneOf":[{"type":"array","items":{"properties":{"key":{"type":"string","minLength":1,"pattern":"^[A-Za-z][A-Za-z0-9_]*$","title":"Key","isRequired":true,"uniqueKey":"options.oneOf.0.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","minLength":1,"title":"Label","isRequired":true,"uniqueKey":"options.oneOf.0.items.[INDEX].label","typeLabel":"string"}},"type":"object","required":["key","label"],"title":"PublicPropertyOption","uniqueKey":"options.oneOf.0.items.[INDEX]","typeLabel":"PublicPropertyOption · object"},"title":"Options","uniqueKey":"options.oneOf.0","typeLabel":"PublicPropertyOption · object[]"},{"type":"null","title":"Options","uniqueKey":"options.oneOf.1","typeLabel":"null"}],"uniqueKey":"options","typeLabel":"PublicPropertyOption · object[] | null"},"currency":{"oneOf":[{"type":"string","title":"Currency","description":"ISO 4217 alpha code of a circulating currency.\n\nThe denomination of a MONEY property definition. Active circulating\ncodes only — the fund/metal/testing X-codes (XAU, XDR, XTS, XXX, …)\nare excluded, while the circulating X-currencies (XAF, XOF, XPF, XCD)\nstay. Stored as TEXT (no Postgres enum): the set is ISO's, not ours,\nand codes retire/appear with currency reforms (SLL→SLE, ZWL→ZWG) —\nvalidation lives at the API boundary where it can evolve without a\nmigration.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWG"],"uniqueKey":"currency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"currency.oneOf.1","typeLabel":"null"}],"uniqueKey":"currency","typeLabel":"enum\u003cstring> | null"},"required":{"type":"boolean","title":"Required","default":false,"uniqueKey":"required","typeLabel":"boolean"}},"additionalProperties":false,"type":"object","required":["key","label","kind"],"title":"PublicPropertyCreate","uniqueKey":"","typeLabel":"PublicPropertyCreate · object"},"examples":{"Example":{"title":"Example","value":{"key":"\u003cstring>","label":"\u003cstring>","description":"\u003cstring>","options":[{"key":"\u003cstring>","label":"\u003cstring>"}],"required":false}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"4b164034-71f5-49b4-86ac-087474d128dc":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"key":{"type":"string","title":"Key","isRequired":true,"uniqueKey":"key","typeLabel":"string"},"label":{"type":"string","title":"Label","isRequired":true,"uniqueKey":"label","typeLabel":"string"},"description":{"oneOf":[{"type":"string","title":"Description","isRequired":true,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","isRequired":true,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"description","typeLabel":"string | null"},"kind":{"type":"string","enum":["TEXT","NUMBER","RADIO","DROPDOWN","BOOLEAN","DATE","TEXTAREA","MULTI_SELECT","EMAIL","MONEY","FILE","URL","MULTI_FILE"],"title":"CrmPropertyKind","description":"Type of a user-defined custom property on a contact.\n\nThe order mirrors the Postgres `crm_property_kind_enum`: TEXTAREA was\nappended in 0014 (alongside MULTI_SELECT), EMAIL and MONEY in 0025, FILE\nin 0065, URL in 0167, MULTI_FILE in 0186. `EMAIL` and `URL` store into\n`value_text` (like TEXT) and `MONEY` into `value_number` (like NUMBER) —\nthey're presentation/validation refinements of those base columns, not new\nstorage shapes. `FILE` and `MULTI_FILE` both store an array of S3 file\nreferences in `value_json` (see `ciarem_crm.file_property`); they differ\nonly in cardinality — FILE holds at most one file, MULTI_FILE a capped\ngallery. Pre-0186, FILE meant the gallery; 0186 renamed those rows to\nMULTI_FILE and repurposed FILE as the single-file kind (it was\ncatalogs-only, so no contact data existed). The bytes live in the\n`record-media` bucket.","isRequired":true,"uniqueKey":"kind","typeLabel":"enum\u003cstring>"},"options":{"oneOf":[{"type":"array","items":{"properties":{"key":{"type":"string","minLength":1,"pattern":"^[A-Za-z][A-Za-z0-9_]*$","title":"Key","isRequired":true,"uniqueKey":"options.oneOf.0.items.[INDEX].key","typeLabel":"string"},"label":{"type":"string","minLength":1,"title":"Label","isRequired":true,"uniqueKey":"options.oneOf.0.items.[INDEX].label","typeLabel":"string"}},"type":"object","required":["key","label"],"title":"PublicPropertyOption","uniqueKey":"options.oneOf.0.items.[INDEX]","typeLabel":"PublicPropertyOption · object"},"title":"Options","isRequired":true,"uniqueKey":"options.oneOf.0","typeLabel":"PublicPropertyOption · object[]"},{"type":"null","title":"Options","isRequired":true,"uniqueKey":"options.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"options","typeLabel":"PublicPropertyOption · object[] | null"},"currency":{"oneOf":[{"type":"string","title":"Currency","description":"ISO 4217 alpha code of a circulating currency.\n\nThe denomination of a MONEY property definition. Active circulating\ncodes only — the fund/metal/testing X-codes (XAU, XDR, XTS, XXX, …)\nare excluded, while the circulating X-currencies (XAF, XOF, XPF, XCD)\nstay. Stored as TEXT (no Postgres enum): the set is ISO's, not ours,\nand codes retire/appear with currency reforms (SLL→SLE, ZWL→ZWG) —\nvalidation lives at the API boundary where it can evolve without a\nmigration.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLE","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VES","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWG"],"isRequired":true,"uniqueKey":"currency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","isRequired":true,"uniqueKey":"currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"currency","typeLabel":"enum\u003cstring> | null"},"required":{"type":"boolean","title":"Required","isRequired":true,"uniqueKey":"required","typeLabel":"boolean"},"order_idx":{"type":"integer","title":"Order Idx","isRequired":true,"uniqueKey":"order_idx","typeLabel":"integer"},"archived_at":{"oneOf":[{"type":"string","title":"Archived At","format":"date-time","isRequired":true,"uniqueKey":"archived_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","title":"Archived At","isRequired":true,"uniqueKey":"archived_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"archived_at","typeLabel":"string\u003cdate-time> | null"},"created_at":{"type":"string","format":"date-time","title":"Created At","isRequired":true,"uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","isRequired":true,"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"type":"object","required":["id","key","label","description","kind","options","currency","required","order_idx","archived_at","created_at","updated_at"],"title":"PublicProperty","uniqueKey":"","typeLabel":"PublicProperty · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","key":"\u003cstring>","label":"\u003cstring>","description":"\u003cstring>","kind":"TEXT","options":[{"key":"\u003cstring>","label":"\u003cstring>"}],"currency":"AED","required":true,"order_idx":123,"archived_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"headers":{"X-RateLimit-Limit":{"description":"Requests allowed per window, shared across the org's keys.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"When the window resets, as a Unix timestamp in seconds.","schema":{"type":"integer"}}},"exampleType":"generated"},"3e31a353-5fa4-47ca-b44e-9e1380eb9a65":{"description":"Bad Request","content":{"application/json":{"schema":{"properties":{"detail":{"properties":{"code":{"type":"string","title":"Code","isRequired":true,"uniqueKey":"detail.code","typeLabel":"string"},"key":{"oneOf":[{"type":"string","title":"Key","uniqueKey":"detail.key.oneOf.0","typeLabel":"string"},{"type":"null","title":"Key","uniqueKey":"detail.key.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail.key","typeLabel":"string | null"},"id":{"oneOf":[{"type":"string","title":"Id","uniqueKey":"detail.id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","uniqueKey":"detail.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail.id","typeLabel":"string | null"},"missing_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"detail.missing_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Missing Ids","uniqueKey":"detail.missing_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Missing Ids","uniqueKey":"detail.missing_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail.missing_ids","typeLabel":"string[] | null"}},"type":"object","required":["code"],"title":"PublicPropertyErrorDetail","description":"Machine-readable property-operation error (the `detail` of a 400/409).","isRequired":true,"uniqueKey":"detail","typeLabel":"PublicPropertyErrorDetail · object"}},"type":"object","required":["detail"],"title":"PublicPropertyError","uniqueKey":"","typeLabel":"PublicPropertyError · object"},"examples":{"Example":{"title":"Example","value":{"detail":{"code":"\u003cstring>","key":"\u003cstring>","id":"\u003cstring>","missing_ids":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"37900999-cc3b-4656-9bd4-ce3e48872f00":{"description":"No usable credential: `missing_bearer_token` (no `Authorization: Bearer`) or `invalid_api_key` (unknown or revoked key).","content":{"application/json":{"schema":{"description":"An error whose `detail` is a stable, machine-readable code.","properties":{"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"title":"PublicError","type":"object","uniqueKey":"","typeLabel":"PublicError · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d75c168e-e838-42e9-973e-6257ad1a269a":{"description":"The credential is real but not allowed here: `api_key_required` (a session token rather than an `oak_` key), `plan_upgrade_required` (the plan doesn't include API access — upgrade to Growth or Scale), `trial_expired` (the free trial ended without a card — subscribe to keep the key working), or `subscription_required` (the subscription is canceled or suspended).","content":{"application/json":{"schema":{"description":"An error whose `detail` is a stable, machine-readable code.","properties":{"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"title":"PublicError","type":"object","uniqueKey":"","typeLabel":"PublicError · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"36344b3d-4e60-479a-b83c-45b41ffb802a":{"description":"Conflict","content":{"application/json":{"schema":{"properties":{"detail":{"properties":{"code":{"type":"string","title":"Code","isRequired":true,"uniqueKey":"detail.code","typeLabel":"string"},"key":{"oneOf":[{"type":"string","title":"Key","uniqueKey":"detail.key.oneOf.0","typeLabel":"string"},{"type":"null","title":"Key","uniqueKey":"detail.key.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail.key","typeLabel":"string | null"},"id":{"oneOf":[{"type":"string","title":"Id","uniqueKey":"detail.id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Id","uniqueKey":"detail.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail.id","typeLabel":"string | null"},"missing_ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"detail.missing_ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Missing Ids","uniqueKey":"detail.missing_ids.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Missing Ids","uniqueKey":"detail.missing_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"detail.missing_ids","typeLabel":"string[] | null"}},"type":"object","required":["code"],"title":"PublicPropertyErrorDetail","description":"Machine-readable property-operation error (the `detail` of a 400/409).","isRequired":true,"uniqueKey":"detail","typeLabel":"PublicPropertyErrorDetail · object"}},"type":"object","required":["detail"],"title":"PublicPropertyError","uniqueKey":"","typeLabel":"PublicPropertyError · object"},"examples":{"Example":{"title":"Example","value":{"detail":{"code":"\u003cstring>","key":"\u003cstring>","id":"\u003cstring>","missing_ids":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"9d2590c7-a772-418a-9635-e569a62d718f":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"},"48c5110a-9574-4f0d-a2ae-d5fce7ed5980":{"description":"Over the organization's request budget (`rate_limited`); the budget depends on the plan. `Retry-After` says how many seconds to wait.","content":{"application/json":{"schema":{"description":"An error whose `detail` is a stable, machine-readable code.","properties":{"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"title":"PublicError","type":"object","uniqueKey":"","typeLabel":"PublicError · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"headers":{"Retry-After":{"description":"Seconds until the window resets.","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"Requests allowed per window, shared across the org's keys.","schema":{"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"When the window resets, as a Unix timestamp in seconds.","schema":{"type":"integer"}}},"exampleType":"generated"},"c30d2646-037b-4d84-b161-89c78f90961f":{"description":"The API is at capacity (`server_busy`). The request was not run and does not count against the budget; retry after `Retry-After` seconds.","content":{"application/json":{"schema":{"description":"An error whose `detail` is a stable, machine-readable code.","properties":{"detail":{"title":"Detail","type":"string","isRequired":true,"uniqueKey":"detail","typeLabel":"string"}},"required":["detail"],"title":"PublicError","type":"object","uniqueKey":"","typeLabel":"PublicError · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>"}}},"exampleType":"generated"}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"exampleType":"generated"}},"security":{"c28375ca-7ae9-4d52-aa3f-f21832e5f2a6":{"apiKey":{"type":"http","scheme":"bearer","description":"An org API key: `Authorization: Bearer oak_…`.","scopes":[],"schemeName":"apiKey"}}},"servers":{"5b78e9ff-1963-4818-8c29-aa7c2f9cadbc":{"url":"https://api.ciarem.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An org API key: `Authorization: Bearer oak_…`.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An org API key: `Authorization: Bearer oak_…`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"ciaremaai","siteName":"Ciarem","title":"Create a custom property - Ciarem","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/crm/create-a-custom-property","matchLevel":0},"es":{"href":"/api-reference/crm/create-a-custom-property","matchLevel":0},"pt":{"href":"/api-reference/crm/create-a-custom-property","matchLevel":0}}},"lastModified":"2026-10-26T19:29:30.832Z","originalFileLocation":"api-reference/crm/create-a-custom-property.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"Ciarem\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ciaremaai/ZgQ3esrcbcJVW0W3/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ciaremaai/ZgQ3esrcbcJVW0W3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ciaremaai/ZgQ3esrcbcJVW0W3/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ciaremaai/ZgQ3esrcbcJVW0W3/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ciaremaai/ZgQ3esrcbcJVW0W3/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ciaremaai/ZgQ3esrcbcJVW0W3/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ciaremaai/ZgQ3esrcbcJVW0W3/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ciaremaai/ZgQ3esrcbcJVW0W3/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ciaremaai/ZgQ3esrcbcJVW0W3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a custom property - Ciarem\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ciarem\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.ciarem.ai/api-reference/crm/create-a-custom-property\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ciaremaai.mintlify.app/_mintlify/api/og/v2?division=CRM\u0026amp;title=Create+a+custom+property\u0026amp;theme=3f057bbf8fb0731c095aa029\u0026amp;signature=27d769e00abe5c780c39ca82824237139d40aa5662b64e88fcfcfe8854c4acd6\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create a custom property - Ciarem\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ciaremaai.mintlify.app/_mintlify/api/og/v2?division=CRM\u0026amp;title=Create+a+custom+property\u0026amp;theme=3f057bbf8fb0731c095aa029\u0026amp;signature=27d769e00abe5c780c39ca82824237139d40aa5662b64e88fcfcfe8854c4acd6\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ciaremaai/ZgQ3esrcbcJVW0W3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ciarem\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#7669FC\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.ciarem.ai/api-reference/crm/create-a-custom-property\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/crm/create-a-custom-property.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://help.ciarem.ai/#organization\",\"name\":\"Ciarem\",\"url\":\"https://help.ciarem.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ciaremaai/FrCl9vIQUOJmXw0K/logo/ciarem-logo.svg?fit=max\u0026auto=format\u0026n=FrCl9vIQUOJmXw0K\u0026q=85\u0026s=4826d113777f270789a291ef1256cbbe\"}},{\"@type\":\"WebSite\",\"@id\":\"https://help.ciarem.ai#website\",\"name\":\"Ciarem\",\"url\":\"https://help.ciarem.ai\",\"publisher\":{\"@id\":\"https://help.ciarem.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.ciarem.ai/api-reference/crm/create-a-custom-property#webpage\",\"url\":\"https://help.ciarem.ai/api-reference/crm/create-a-custom-property\",\"name\":\"Create a custom property\",\"dateModified\":\"2026-10-26T19:29:30.832Z\",\"isPartOf\":{\"@id\":\"https://help.ciarem.ai#website\"},\"breadcrumb\":{\"@id\":\"https://help.ciarem.ai/api-reference/crm/create-a-custom-property#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.ciarem.ai/api-reference/crm/create-a-custom-property#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API for developers\",\"item\":\"https://help.ciarem.ai/api-reference/quickstart\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API reference\",\"item\":\"https://help.ciarem.ai/api-reference/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"CRM\",\"item\":\"https://help.ciarem.ai/api-reference/crm/list-custom-properties\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Create a custom property\",\"item\":\"https://help.ciarem.ai/api-reference/crm/create-a-custom-property\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://help.ciarem.ai/api-reference/crm/create-a-custom-property#apireference\",\"headline\":\"Create a custom property\",\"name\":\"Create a custom property\",\"url\":\"https://help.ciarem.ai/api-reference/crm/create-a-custom-property\",\"mainEntityOfPage\":{\"@id\":\"https://help.ciarem.ai/api-reference/crm/create-a-custom-property#webpage\"},\"dateModified\":\"2026-10-26T19:29:30.832Z\",\"publisher\":{\"@id\":\"https://help.ciarem.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://help.ciarem.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ciarem\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Ciarem","nav":{"global":null,"languages":[{"language":"en","groups":[{"group":"Getting started","pages":[{"title":"What is Ciarem?","href":"/getting-started/what-is-ciarem"},{"title":"From signup to live: the launch checklist","href":"/getting-started/launch-checklist"},{"title":"Report a problem","href":"/getting-started/report-a-problem"}]},{"group":"Channels","pages":[{"group":"WhatsApp","pages":[{"title":"Connecting WhatsApp","href":"/channels/connect-whatsapp"},{"title":"WhatsApp Coexistence explained","href":"/channels/whatsapp-coexistence"},{"title":"Creating and managing message templates","href":"/channels/message-templates"},{"title":"WhatsApp broadcasts","href":"/channels/broadcasts"},{"title":"WhatsApp forms","href":"/channels/whatsapp-forms"},{"title":"Building WhatsApp forms","href":"/channels/whatsapp-forms-builder"},{"title":"Photo and document questions","href":"/channels/whatsapp-forms-uploads"},{"title":"WhatsApp forms troubleshooting","href":"/channels/whatsapp-forms-troubleshooting"},{"title":"WhatsApp marketing opt-out","href":"/channels/whatsapp-marketing-opt-out"},{"title":"WhatsApp voice calls","href":"/channels/whatsapp-calling"},{"title":"Calls in the Inbox","href":"/channels/whatsapp-calling-inbox"},{"title":"WhatsApp connection troubleshooting","href":"/channels/whatsapp-troubleshooting"}]},{"group":"Instagram","pages":[{"title":"Instagram","sidebarTitle":"Connecting Instagram","href":"/channels/connect-instagram"},{"title":"Instagram comment-to-DM automations","href":"/channels/instagram-comment-automations"}]},{"group":"Messenger","pages":[{"title":"Facebook Messenger","sidebarTitle":"Connecting Messenger","href":"/channels/connect-messenger"},{"title":"Facebook comment-to-DM automations","href":"/channels/facebook-comment-automations"}]},{"title":"Website chat","href":"/channels/website-chat"}]},{"group":"Your AI agent","pages":[{"title":"Is my agent working correctly?","sidebarTitle":"Control center: is my agent working?","href":"/ai-agent/agent-health"},{"group":"Agent team","pages":[{"title":"Basic configuration: how your agent communicates","sidebarTitle":"Basic configuration","href":"/ai-agent/basic-configuration"},{"title":"The first message and personalization","href":"/ai-agent/first-message"},{"title":"Your AI agent team: types and per-agent settings","sidebarTitle":"Agent types and settings","href":"/ai-agent/agent-team"},{"title":"Proactive follow-ups","href":"/ai-agent/follow-ups"},{"title":"Human handoff and transfer rules","href":"/ai-agent/human-handoff-and-escalation"}]},{"group":"Knowledge bases","pages":[{"title":"Knowledge bases: what your agent knows","sidebarTitle":"Knowledge bases","href":"/ai-agent/knowledge-bases"},{"title":"Website sources: index your whole site","href":"/ai-agent/website-sources"}]},{"group":"Training and evaluation","pages":[{"title":"The playground: test and train your agent","sidebarTitle":"The playground","href":"/ai-agent/playground"},{"title":"The Evaluation center: reviewing real replies","href":"/ai-agent/evaluation-center"}]},{"group":"What your agent can do","pages":[{"title":"Booking meetings: calendars and AI scheduling","href":"/ai-agent/booking-and-calendars"},{"title":"WhatsApp forms in your AI agents","sidebarTitle":"WhatsApp forms","href":"/ai-agent/whatsapp-forms-for-agents"},{"title":"Taking orders in chat: the checkout module","href":"/ai-agent/taking-orders"}]}]},{"group":"Using Ciarem","pages":[{"title":"Working the Inbox","href":"/using-ciarem/inbox"},{"title":"After the handoff: getting to a waiting customer","href":"/using-ciarem/after-the-handoff"},{"title":"Contacts and funnel stages","href":"/using-ciarem/contacts-and-stages"},{"title":"Tasks: follow-ups your team owes a contact","sidebarTitle":"Tasks","href":"/using-ciarem/tasks"},{"title":"Catalogs: your products, services, and prices","href":"/using-ciarem/catalogs"},{"title":"Teams and tags","href":"/using-ciarem/teams-and-tags"},{"title":"Team roles and what each can see","href":"/using-ciarem/roles-and-permissions"},{"title":"Reports and CSV exports","href":"/using-ciarem/reports-and-exports"},{"title":"Satisfaction surveys (CSAT and NPS)","href":"/using-ciarem/satisfaction-surveys"},{"title":"Recommended actions","href":"/using-ciarem/recommended-actions"}]},{"group":"Integrations","pages":[{"group":"HubSpot","pages":[{"title":"HubSpot","sidebarTitle":"Connect and sync","href":"/integrations/hubspot"},{"title":"Send WhatsApp from a HubSpot record","sidebarTitle":"Send from a record","href":"/integrations/hubspot/record-card"}]},{"title":"Meta Lead Ads","href":"/integrations/meta-lead-ads"},{"title":"Meta Conversions","href":"/integrations/meta-conversions"},{"title":"AI assistants (MCP)","href":"/integrations/ai-assistants"}]},{"group":"Mobile app","pages":[{"title":"Get the Ciarem app","href":"/mobile/get-the-app"},{"title":"Inbox on mobile","href":"/mobile/inbox-on-mobile"},{"title":"Contacts on mobile","href":"/mobile/contacts-on-mobile"},{"title":"Notifications and settings","href":"/mobile/notifications-and-settings"}]},{"group":"Billing","pages":[{"title":"Plans, messages, and how your bill is built","href":"/billing/plans-and-billing"},{"title":"WhatsApp costs and the 24-hour window","href":"/billing/whatsapp-costs-and-templates"}]},{"group":"API for developers","pages":[{"title":"API quickstart","href":"/api-reference/quickstart"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors, limits, and pagination","href":"/api-reference/errors-limits-pagination"},{"title":"Changelog","href":"/api-reference/changelog"},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/webhooks/overview"},{"title":"Event catalog","href":"/webhooks/events"},{"title":"Verify signatures","href":"/webhooks/signatures"},{"title":"Deliveries and retries","href":"/webhooks/deliveries"}]},{"group":"API reference","root":{"title":"API reference","href":"/api-reference/overview"},"pages":[{"group":"Account","pages":[{"title":"Get the current organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/me","href":"/api-reference/account/get-the-current-organization"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/{contact_id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contacts/{contact_id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/contacts/{contact_id}","href":"/api-reference/contacts/update-a-contact"}]},{"group":"CRM","pages":[{"title":"List custom properties","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/properties","href":"/api-reference/crm/list-custom-properties"},{"title":"Create a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/properties","href":"/api-reference/crm/create-a-custom-property"},{"title":"Delete a custom property","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/properties/{property_id}","href":"/api-reference/crm/delete-a-custom-property"},{"title":"Update a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/properties/{property_id}","href":"/api-reference/crm/update-a-custom-property"},{"title":"Reorder custom properties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/properties/reorder","href":"/api-reference/crm/reorder-custom-properties"},{"title":"List funnel stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/funnel-stages","href":"/api-reference/crm/list-funnel-stages"},{"title":"Create a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages","href":"/api-reference/crm/create-a-funnel-stage"},{"title":"Delete a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/funnel-stages/{stage_id}","href":"/api-reference/crm/delete-a-funnel-stage"},{"title":"Update a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/funnel-stages/{stage_id}","href":"/api-reference/crm/update-a-funnel-stage"},{"title":"Reorder funnel stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages/reorder","href":"/api-reference/crm/reorder-funnel-stages"},{"title":"Set the initial funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages/{stage_id}/set-initial","href":"/api-reference/crm/set-the-initial-funnel-stage"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"List a conversation's messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/messages","href":"/api-reference/conversations/list-a-conversations-messages"}]},{"group":"WhatsApp templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Create and submit a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates","href":"/api-reference/whatsapp-templates/create-and-submit-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}","href":"/api-reference/whatsapp-templates/get-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/templates/{template_id}","href":"/api-reference/whatsapp-templates/delete-a-template"},{"title":"Get a template's send requirements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}/send-requirements","href":"/api-reference/whatsapp-templates/get-a-templates-send-requirements"}]},{"group":"WhatsApp numbers","pages":[{"title":"List WhatsApp numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/channels/whatsapp/phones","href":"/api-reference/whatsapp-numbers/list-whatsapp-numbers"}]},{"group":"Broadcasts","pages":[{"title":"Send a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates/{template_id}/send","href":"/api-reference/broadcasts/send-a-template"},{"title":"List broadcasts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts","href":"/api-reference/broadcasts/list-broadcasts"},{"title":"Get a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts/{broadcast_id}","href":"/api-reference/broadcasts/get-a-broadcast"},{"title":"List a broadcast's recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts/{broadcast_id}/recipients","href":"/api-reference/broadcasts/list-a-broadcasts-recipients"},{"title":"Cancel a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/broadcasts/{broadcast_id}/cancel","href":"/api-reference/broadcasts/cancel-a-broadcast"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-endpoints/{endpoint_id}/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List sample events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-event-samples","href":"/api-reference/webhooks/list-sample-events"},{"title":"List an endpoint's deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints/{endpoint_id}/deliveries","href":"/api-reference/webhooks/list-an-endpoints-deliveries"},{"title":"Redeliver an event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-deliveries/{delivery_id}/redeliver","href":"/api-reference/webhooks/redeliver-an-event"}]}]}]}]},{"language":"es","groups":[{"group":"Primeros pasos","pages":[{"title":"¿Qué es Ciarem?","href":"/es/getting-started/what-is-ciarem"},{"title":"Del registro a estar en vivo: la lista de lanzamiento","href":"/es/getting-started/launch-checklist"},{"title":"Reportar un problema","href":"/es/getting-started/report-a-problem"}]},{"group":"Canales","pages":[{"group":"WhatsApp","pages":[{"title":"Conectar WhatsApp","href":"/es/channels/connect-whatsapp"},{"title":"WhatsApp Coexistence explicado","href":"/es/channels/whatsapp-coexistence"},{"title":"Crear y gestionar plantillas de mensajes","href":"/es/channels/message-templates"},{"title":"Envíos masivos de WhatsApp","href":"/es/channels/broadcasts"},{"title":"Formularios de WhatsApp","href":"/es/channels/whatsapp-forms"},{"title":"Crear formularios de WhatsApp","href":"/es/channels/whatsapp-forms-builder"},{"title":"Preguntas de fotos y documentos","href":"/es/channels/whatsapp-forms-uploads"},{"title":"Solución de problemas de formularios de WhatsApp","href":"/es/channels/whatsapp-forms-troubleshooting"},{"title":"Baja de marketing por WhatsApp","href":"/es/channels/whatsapp-marketing-opt-out"},{"title":"Llamadas de voz por WhatsApp","href":"/es/channels/whatsapp-calling"},{"title":"Llamadas en la Bandeja de entrada","href":"/es/channels/whatsapp-calling-inbox"},{"title":"Solución de problemas de conexión de WhatsApp","href":"/es/channels/whatsapp-troubleshooting"}]},{"group":"Instagram","pages":[{"title":"Instagram","sidebarTitle":"Conectar Instagram","href":"/es/channels/connect-instagram"},{"title":"Automatizaciones de comentarios en Instagram (comment-to-DM)","href":"/es/channels/instagram-comment-automations"}]},{"group":"Messenger","pages":[{"title":"Facebook Messenger","sidebarTitle":"Conectar Messenger","href":"/es/channels/connect-messenger"},{"title":"Automatizaciones de comentarios en Facebook (comment-to-DM)","href":"/es/channels/facebook-comment-automations"}]},{"title":"Chat del sitio web","href":"/es/channels/website-chat"}]},{"group":"Tu agente de IA","pages":[{"title":"¿Mi agente está funcionando correctamente?","sidebarTitle":"Centro de control: ¿mi agente funciona?","href":"/es/ai-agent/agent-health"},{"group":"Equipo de agentes","pages":[{"title":"Configuración básica: cómo se comunica tu agente","sidebarTitle":"Configuración básica","href":"/es/ai-agent/basic-configuration"},{"title":"El primer mensaje y la personalización","href":"/es/ai-agent/first-message"},{"title":"Tu equipo de agentes IA: tipos y configuración de cada agente","sidebarTitle":"Tipos de agente y configuración","href":"/es/ai-agent/agent-team"},{"title":"Seguimientos proactivos","href":"/es/ai-agent/follow-ups"},{"title":"Transferencia a una persona y reglas de transferencia","href":"/es/ai-agent/human-handoff-and-escalation"}]},{"group":"Bases de conocimiento","pages":[{"title":"Bases de conocimiento: lo que sabe tu agente","sidebarTitle":"Bases de conocimiento","href":"/es/ai-agent/knowledge-bases"},{"title":"Fuentes de sitio web: indexa todo tu sitio","href":"/es/ai-agent/website-sources"}]},{"group":"Entrenamiento y evaluación","pages":[{"title":"El playground: prueba y entrena a tu agente","sidebarTitle":"El playground","href":"/es/ai-agent/playground"},{"title":"El Centro de evaluación: revisar respuestas reales","href":"/es/ai-agent/evaluation-center"}]},{"group":"Qué puede hacer tu agente","pages":[{"title":"Agendar reuniones: calendarios y programación con IA","href":"/es/ai-agent/booking-and-calendars"},{"title":"Formularios de WhatsApp en tus agentes de IA","sidebarTitle":"Formularios de WhatsApp","href":"/es/ai-agent/whatsapp-forms-for-agents"},{"title":"Tomar pedidos en el chat: el módulo de checkout","href":"/es/ai-agent/taking-orders"}]}]},{"group":"Usando Ciarem","pages":[{"title":"Trabajar la Bandeja de entrada","href":"/es/using-ciarem/inbox"},{"title":"Después de la transferencia: llegar a un cliente que espera","href":"/es/using-ciarem/after-the-handoff"},{"title":"Contactos y etapas del embudo","href":"/es/using-ciarem/contacts-and-stages"},{"title":"Tareas: los pendientes de tu equipo con un contacto","sidebarTitle":"Tareas","href":"/es/using-ciarem/tasks"},{"title":"Catálogos: tus productos, servicios y precios","href":"/es/using-ciarem/catalogs"},{"title":"Equipos y etiquetas","href":"/es/using-ciarem/teams-and-tags"},{"title":"Roles del equipo y qué puede ver cada uno","href":"/es/using-ciarem/roles-and-permissions"},{"title":"Reportes y exportaciones CSV","href":"/es/using-ciarem/reports-and-exports"},{"title":"Encuestas de satisfacción (CSAT y NPS)","href":"/es/using-ciarem/satisfaction-surveys"},{"title":"Acciones recomendadas","href":"/es/using-ciarem/recommended-actions"}]},{"group":"Integraciones","pages":[{"group":"HubSpot","pages":[{"title":"HubSpot","sidebarTitle":"Conectar y sincronizar","href":"/es/integrations/hubspot"},{"title":"Enviar WhatsApp desde un registro de HubSpot","sidebarTitle":"Enviar desde un registro","href":"/es/integrations/hubspot/record-card"}]},{"title":"Meta Lead Ads","href":"/es/integrations/meta-lead-ads"},{"title":"Conversiones de Meta","href":"/es/integrations/meta-conversions"},{"title":"Asistentes de IA (MCP)","href":"/es/integrations/ai-assistants"}]},{"group":"App móvil","pages":[{"title":"Descarga la app de Ciarem","href":"/es/mobile/get-the-app"},{"title":"Bandeja de entrada en el móvil","href":"/es/mobile/inbox-on-mobile"},{"title":"Contactos en el móvil","href":"/es/mobile/contacts-on-mobile"},{"title":"Notificaciones y ajustes","href":"/es/mobile/notifications-and-settings"}]},{"group":"Facturación","pages":[{"title":"Planes, mensajes y cómo se arma tu factura","href":"/es/billing/plans-and-billing"},{"title":"Costos de WhatsApp y la ventana de 24 horas","href":"/es/billing/whatsapp-costs-and-templates"}]},{"group":"API para desarrolladores","pages":[{"title":"Inicio rápido de la API","href":"/es/api-reference/quickstart"},{"title":"Autenticación","href":"/es/api-reference/authentication"},{"title":"Errores, límites y paginación","href":"/es/api-reference/errors-limits-pagination"},{"title":"Changelog","href":"/es/api-reference/changelog"},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/es/webhooks/overview"},{"title":"Catálogo de eventos","href":"/es/webhooks/events"},{"title":"Verificar firmas","href":"/es/webhooks/signatures"},{"title":"Entregas y reintentos","href":"/es/webhooks/deliveries"}]},{"group":"Referencia de la API","root":{"title":"Referencia de la API","href":"/es/api-reference/overview"},"pages":[{"group":"Account","pages":[{"title":"Get the current organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/me","href":"/api-reference/account/get-the-current-organization"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/{contact_id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contacts/{contact_id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/contacts/{contact_id}","href":"/api-reference/contacts/update-a-contact"}]},{"group":"CRM","pages":[{"title":"List custom properties","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/properties","href":"/api-reference/crm/list-custom-properties"},{"title":"Create a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/properties","href":"/api-reference/crm/create-a-custom-property"},{"title":"Delete a custom property","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/properties/{property_id}","href":"/api-reference/crm/delete-a-custom-property"},{"title":"Update a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/properties/{property_id}","href":"/api-reference/crm/update-a-custom-property"},{"title":"Reorder custom properties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/properties/reorder","href":"/api-reference/crm/reorder-custom-properties"},{"title":"List funnel stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/funnel-stages","href":"/api-reference/crm/list-funnel-stages"},{"title":"Create a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages","href":"/api-reference/crm/create-a-funnel-stage"},{"title":"Delete a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/funnel-stages/{stage_id}","href":"/api-reference/crm/delete-a-funnel-stage"},{"title":"Update a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/funnel-stages/{stage_id}","href":"/api-reference/crm/update-a-funnel-stage"},{"title":"Reorder funnel stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages/reorder","href":"/api-reference/crm/reorder-funnel-stages"},{"title":"Set the initial funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages/{stage_id}/set-initial","href":"/api-reference/crm/set-the-initial-funnel-stage"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"List a conversation's messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/messages","href":"/api-reference/conversations/list-a-conversations-messages"}]},{"group":"WhatsApp templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Create and submit a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates","href":"/api-reference/whatsapp-templates/create-and-submit-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}","href":"/api-reference/whatsapp-templates/get-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/templates/{template_id}","href":"/api-reference/whatsapp-templates/delete-a-template"},{"title":"Get a template's send requirements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}/send-requirements","href":"/api-reference/whatsapp-templates/get-a-templates-send-requirements"}]},{"group":"WhatsApp numbers","pages":[{"title":"List WhatsApp numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/channels/whatsapp/phones","href":"/api-reference/whatsapp-numbers/list-whatsapp-numbers"}]},{"group":"Broadcasts","pages":[{"title":"Send a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates/{template_id}/send","href":"/api-reference/broadcasts/send-a-template"},{"title":"List broadcasts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts","href":"/api-reference/broadcasts/list-broadcasts"},{"title":"Get a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts/{broadcast_id}","href":"/api-reference/broadcasts/get-a-broadcast"},{"title":"List a broadcast's recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts/{broadcast_id}/recipients","href":"/api-reference/broadcasts/list-a-broadcasts-recipients"},{"title":"Cancel a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/broadcasts/{broadcast_id}/cancel","href":"/api-reference/broadcasts/cancel-a-broadcast"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-endpoints/{endpoint_id}/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List sample events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-event-samples","href":"/api-reference/webhooks/list-sample-events"},{"title":"List an endpoint's deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints/{endpoint_id}/deliveries","href":"/api-reference/webhooks/list-an-endpoints-deliveries"},{"title":"Redeliver an event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-deliveries/{delivery_id}/redeliver","href":"/api-reference/webhooks/redeliver-an-event"}]}]}]}]},{"language":"pt","groups":[{"group":"Primeiros passos","pages":[{"title":"O que é a Ciarem?","href":"/pt/getting-started/what-is-ciarem"},{"title":"Do cadastro ao ar: a lista de lançamento","href":"/pt/getting-started/launch-checklist"},{"title":"Relatar um problema","href":"/pt/getting-started/report-a-problem"}]},{"group":"Canais","pages":[{"group":"WhatsApp","pages":[{"title":"Conectar o WhatsApp","href":"/pt/channels/connect-whatsapp"},{"title":"WhatsApp Coexistência explicada","href":"/pt/channels/whatsapp-coexistence"},{"title":"Criar e gerenciar modelos de mensagem","href":"/pt/channels/message-templates"},{"title":"Transmissões de WhatsApp","href":"/pt/channels/broadcasts"},{"title":"Formulários do WhatsApp","href":"/pt/channels/whatsapp-forms"},{"title":"Criar formulários do WhatsApp","href":"/pt/channels/whatsapp-forms-builder"},{"title":"Perguntas de fotos e documentos","href":"/pt/channels/whatsapp-forms-uploads"},{"title":"Solução de problemas dos formulários do WhatsApp","href":"/pt/channels/whatsapp-forms-troubleshooting"},{"title":"Descadastro de marketing por WhatsApp","href":"/pt/channels/whatsapp-marketing-opt-out"},{"title":"Chamadas de voz pelo WhatsApp","href":"/pt/channels/whatsapp-calling"},{"title":"Chamadas na Caixa de entrada","href":"/pt/channels/whatsapp-calling-inbox"},{"title":"Solução de problemas de conexão do WhatsApp","href":"/pt/channels/whatsapp-troubleshooting"}]},{"group":"Instagram","pages":[{"title":"Instagram","sidebarTitle":"Conectar o Instagram","href":"/pt/channels/connect-instagram"},{"title":"Automações de comentários no Instagram (comment-to-DM)","href":"/pt/channels/instagram-comment-automations"}]},{"group":"Messenger","pages":[{"title":"Facebook Messenger","sidebarTitle":"Conectar o Messenger","href":"/pt/channels/connect-messenger"},{"title":"Automações de comentários no Facebook (comment-to-DM)","href":"/pt/channels/facebook-comment-automations"}]},{"title":"Chat do site","href":"/pt/channels/website-chat"}]},{"group":"Seu agente de IA","pages":[{"title":"Meu agente está funcionando corretamente?","sidebarTitle":"Central de controle: meu agente funciona?","href":"/pt/ai-agent/agent-health"},{"group":"Equipe de agentes","pages":[{"title":"Configuração básica: como seu agente se comunica","sidebarTitle":"Configuração básica","href":"/pt/ai-agent/basic-configuration"},{"title":"A primeira mensagem e a personalização","href":"/pt/ai-agent/first-message"},{"title":"Sua equipe de agentes de IA: tipos e configuração de cada agente","sidebarTitle":"Tipos de agente e configuração","href":"/pt/ai-agent/agent-team"},{"title":"Acompanhamentos proativos","href":"/pt/ai-agent/follow-ups"},{"title":"Transferência para uma pessoa e regras de transferência","href":"/pt/ai-agent/human-handoff-and-escalation"}]},{"group":"Bases de conhecimento","pages":[{"title":"Bases de conhecimento: o que seu agente sabe","sidebarTitle":"Bases de conhecimento","href":"/pt/ai-agent/knowledge-bases"},{"title":"Fontes de site: indexe o seu site inteiro","href":"/pt/ai-agent/website-sources"}]},{"group":"Treinamento e avaliação","pages":[{"title":"O playground: teste e treine seu agente","sidebarTitle":"O playground","href":"/pt/ai-agent/playground"},{"title":"O Centro de avaliação: revisar respostas reais","href":"/pt/ai-agent/evaluation-center"}]},{"group":"O que seu agente pode fazer","pages":[{"title":"Agendar reuniões: calendários e agendamento com IA","href":"/pt/ai-agent/booking-and-calendars"},{"title":"Formulários do WhatsApp nos seus agentes de IA","sidebarTitle":"Formulários do WhatsApp","href":"/pt/ai-agent/whatsapp-forms-for-agents"},{"title":"Receber pedidos no chat: o módulo de checkout","href":"/pt/ai-agent/taking-orders"}]}]},{"group":"Usando a Ciarem","pages":[{"title":"Trabalhar na Caixa de entrada","href":"/pt/using-ciarem/inbox"},{"title":"Depois da transferência: chegar a um cliente que espera","href":"/pt/using-ciarem/after-the-handoff"},{"title":"Contatos e etapas do funil","href":"/pt/using-ciarem/contacts-and-stages"},{"title":"Tarefas: as pendências da sua equipe com um contato","sidebarTitle":"Tarefas","href":"/pt/using-ciarem/tasks"},{"title":"Catálogos: seus produtos, serviços e preços","href":"/pt/using-ciarem/catalogs"},{"title":"Equipes e etiquetas","href":"/pt/using-ciarem/teams-and-tags"},{"title":"Funções da equipe e o que cada uma pode ver","href":"/pt/using-ciarem/roles-and-permissions"},{"title":"Relatórios e exportações CSV","href":"/pt/using-ciarem/reports-and-exports"},{"title":"Pesquisas de satisfação (CSAT e NPS)","href":"/pt/using-ciarem/satisfaction-surveys"},{"title":"Ações recomendadas","href":"/pt/using-ciarem/recommended-actions"}]},{"group":"Integrações","pages":[{"group":"HubSpot","pages":[{"title":"HubSpot","sidebarTitle":"Conectar e sincronizar","href":"/pt/integrations/hubspot"},{"title":"Enviar WhatsApp a partir de um registro do HubSpot","sidebarTitle":"Enviar a partir de um registro","href":"/pt/integrations/hubspot/record-card"}]},{"title":"Meta Lead Ads","href":"/pt/integrations/meta-lead-ads"},{"title":"Conversões da Meta","href":"/pt/integrations/meta-conversions"},{"title":"Assistentes de IA (MCP)","href":"/pt/integrations/ai-assistants"}]},{"group":"App móvel","pages":[{"title":"Baixe o app da Ciarem","href":"/pt/mobile/get-the-app"},{"title":"Caixa de entrada no celular","href":"/pt/mobile/inbox-on-mobile"},{"title":"Contatos no celular","href":"/pt/mobile/contacts-on-mobile"},{"title":"Notificações e configurações","href":"/pt/mobile/notifications-and-settings"}]},{"group":"Faturamento","pages":[{"title":"Planos, mensagens e como sua fatura é montada","href":"/pt/billing/plans-and-billing"},{"title":"Custos do WhatsApp e a janela de 24 horas","href":"/pt/billing/whatsapp-costs-and-templates"}]},{"group":"API para desenvolvedores","pages":[{"title":"Início rápido da API","href":"/pt/api-reference/quickstart"},{"title":"Autenticação","href":"/pt/api-reference/authentication"},{"title":"Erros, limites e paginação","href":"/pt/api-reference/errors-limits-pagination"},{"title":"Changelog","href":"/pt/api-reference/changelog"},{"group":"Webhooks","pages":[{"title":"Webhooks","href":"/pt/webhooks/overview"},{"title":"Catálogo de eventos","href":"/pt/webhooks/events"},{"title":"Verificar assinaturas","href":"/pt/webhooks/signatures"},{"title":"Entregas e novas tentativas","href":"/pt/webhooks/deliveries"}]},{"group":"Referência da API","root":{"title":"Referência da API","href":"/pt/api-reference/overview"},"pages":[{"group":"Account","pages":[{"title":"Get the current organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/me","href":"/api-reference/account/get-the-current-organization"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/contacts/{contact_id}","href":"/api-reference/contacts/get-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/contacts/{contact_id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/contacts/{contact_id}","href":"/api-reference/contacts/update-a-contact"}]},{"group":"CRM","pages":[{"title":"List custom properties","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/properties","href":"/api-reference/crm/list-custom-properties"},{"title":"Create a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/properties","href":"/api-reference/crm/create-a-custom-property"},{"title":"Delete a custom property","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/properties/{property_id}","href":"/api-reference/crm/delete-a-custom-property"},{"title":"Update a custom property","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/properties/{property_id}","href":"/api-reference/crm/update-a-custom-property"},{"title":"Reorder custom properties","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/properties/reorder","href":"/api-reference/crm/reorder-custom-properties"},{"title":"List funnel stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/funnel-stages","href":"/api-reference/crm/list-funnel-stages"},{"title":"Create a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages","href":"/api-reference/crm/create-a-funnel-stage"},{"title":"Delete a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/funnel-stages/{stage_id}","href":"/api-reference/crm/delete-a-funnel-stage"},{"title":"Update a funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/funnel-stages/{stage_id}","href":"/api-reference/crm/update-a-funnel-stage"},{"title":"Reorder funnel stages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages/reorder","href":"/api-reference/crm/reorder-funnel-stages"},{"title":"Set the initial funnel stage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/funnel-stages/{stage_id}/set-initial","href":"/api-reference/crm/set-the-initial-funnel-stage"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations","href":"/api-reference/conversations/list-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}","href":"/api-reference/conversations/get-a-conversation"},{"title":"List a conversation's messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/conversations/{conversation_id}/messages","href":"/api-reference/conversations/list-a-conversations-messages"}]},{"group":"WhatsApp templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates","href":"/api-reference/whatsapp-templates/list-templates"},{"title":"Create and submit a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates","href":"/api-reference/whatsapp-templates/create-and-submit-a-template"},{"title":"Get a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}","href":"/api-reference/whatsapp-templates/get-a-template"},{"title":"Delete a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/templates/{template_id}","href":"/api-reference/whatsapp-templates/delete-a-template"},{"title":"Get a template's send requirements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/templates/{template_id}/send-requirements","href":"/api-reference/whatsapp-templates/get-a-templates-send-requirements"}]},{"group":"WhatsApp numbers","pages":[{"title":"List WhatsApp numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/channels/whatsapp/phones","href":"/api-reference/whatsapp-numbers/list-whatsapp-numbers"}]},{"group":"Broadcasts","pages":[{"title":"Send a template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/templates/{template_id}/send","href":"/api-reference/broadcasts/send-a-template"},{"title":"List broadcasts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts","href":"/api-reference/broadcasts/list-broadcasts"},{"title":"Get a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts/{broadcast_id}","href":"/api-reference/broadcasts/get-a-broadcast"},{"title":"List a broadcast's recipients","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/broadcasts/{broadcast_id}/recipients","href":"/api-reference/broadcasts/list-a-broadcasts-recipients"},{"title":"Cancel a broadcast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/broadcasts/{broadcast_id}/cancel","href":"/api-reference/broadcasts/cancel-a-broadcast"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/webhook-endpoints/{endpoint_id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Send a test event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-endpoints/{endpoint_id}/test","href":"/api-reference/webhooks/send-a-test-event"},{"title":"List sample events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-event-samples","href":"/api-reference/webhooks/list-sample-events"},{"title":"List an endpoint's deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/webhook-endpoints/{endpoint_id}/deliveries","href":"/api-reference/webhooks/list-an-endpoints-deliveries"},{"title":"Redeliver an event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/webhook-deliveries/{delivery_id}/redeliver","href":"/api-reference/webhooks/redeliver-an-event"}]}]}]}]}]},"title":"Create a custom property - Ciarem","buildId":"dpl_G8u2B2Ji9qJYF9umedjv293TxycS","deploymentId":"dpl_G8u2B2Ji9qJYF9umedjv293TxycS","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-S3ptrr-V.js","utils-CUxEJy9u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DavhVrxy.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B1sOUY6E.js","snippetPresets-C-RLYOrF.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Duz18EdI.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DPsbCc6D.js","shallow-B1dlhlOw.js","getApiPlaygroundDisplay-DvOu-BhE.js","CodeSnippet-By8wd64X.js","CodeSnippets-BxVv6TjI.js","Page-BGh0lBck.js","getPastedJson-DOAt9xJn.js","icon-BYg-qtQ2.js","MethodPill-Dtah8ZSz.js","DuplicateIcon-guWfDmh1.js","createIcon-pTGhj_hk.js","DynamicMarkdown-DpsHMHVL.js","SectionHeading-BbutQCjq.js","axios-vUo_bRtp.js","Markdown-DZ-stgDu.js","clsx-Dfme4k4V.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CPNs0ebX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-3JVAA-i3.js"]}