> For the complete documentation index, see [llms.txt](https://docs.hos.accessacloud.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hos.accessacloud.com/atreemo-api/api-reference/atreemo-api-reference/communication-preference.md). # Communication Preference Api Methods for CommunicationPreference ## Get > Get the communication preferences of the requested customer\ > \ > The public collection lists 2 variants of this request: \`?customerid\`; \`?customerid\&BrandID\`. ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"CommunicationPreference","description":"Api Methods for CommunicationPreference"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"CommsPreferenceOutput":{"type":"object","properties":{"EmailOptin":{"type":"boolean","nullable":true,"description":"True if would receive an Email"},"MailOptin":{"type":"boolean","nullable":true,"description":"True if would receive a mail"},"PhoneOptin":{"type":"boolean","nullable":true,"description":"True if would receive a call"},"SmsOptin":{"type":"boolean","nullable":true,"description":"True if would receive an Sms"},"WebPushNotificationOptin":{"type":"boolean","nullable":true,"description":"True if would receive a Web notification"}}}}},"paths":{"/api/CommunicationPreference/Get":{"get":{"operationId":"CommunicationPreferenceGet","summary":"Get","tags":["CommunicationPreference"],"description":"Get the communication preferences of the requested customer\n\nThe public collection lists 2 variants of this request: `?customerid`; `?customerid&BrandID`.","parameters":[{"name":"customerid","in":"query","schema":{"type":"integer","format":"int32"},"description":"Native query parameter. CLR int customerid in the pinned controller signature.","required":true},{"name":"BrandID","in":"query","schema":{"type":"integer","format":"int32"},"description":"Native query parameter. CLR int BrandID in the pinned controller signature. Optional across the two published overload variants (customerid only, or customerid with BrandID).","required":false}],"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommsPreferenceOutput"}}}}}}}}} ``` ## Post > Set the communication preferences of the requested customer ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"CommunicationPreference","description":"Api Methods for CommunicationPreference"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"CommsPreferenceInput":{"type":"object","properties":{"BrandID":{"type":"integer","format":"int32","nullable":true,"description":"The brand ID where the change should be applied"},"ChangeDate":{"type":"string","format":"date-time","nullable":true,"description":"Change date (current date if empty)"},"CustomerID":{"type":"integer","format":"int32","description":"The unique identifier of the customer in CRM side (CtcID)."},"EmailOptin":{"type":"boolean","nullable":true,"description":"True if would receive an email"},"MailOptin":{"type":"boolean","nullable":true,"description":"True if would receive a mail"},"PhoneOptin":{"type":"boolean","nullable":true,"description":"True if would receive a call"},"PushNotificationOptin":{"type":"boolean","nullable":true,"description":"True if would receive a mobile app push notification"},"SmsOptin":{"type":"boolean","nullable":true,"description":"True if would receive an Sms"},"SupInfo":{"type":"array","items":{"$ref":"#/components/schemas/SupInfo"},"description":"Collection of contact supplementary information"},"WebPushNotificationOptin":{"type":"boolean","nullable":true,"description":"True if would receive a mobile app push notification"}},"required":["CustomerID"]},"SupInfo":{"type":"object","nullable":true,"properties":{"FieldContent":{"type":"string","nullable":true,"description":"Field value"},"FieldName":{"type":"string","nullable":true,"description":"Field name"}}},"ApiOutput":{"type":"object","properties":{"Error":{"type":"string","description":"Error description"},"Response":{"type":"boolean","description":"The status call"}}}}},"paths":{"/api/CommunicationPreference/Post":{"post":{"operationId":"CommunicationPreferencePost","summary":"Post","tags":["CommunicationPreference"],"description":"Set the communication preferences of the requested customer","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommsPreferenceInput"}}}},"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiOutput"}}}}}}}}} ``` ## PostEmailOptin > Post preferences of know contact ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"CommunicationPreference","description":"Api Methods for CommunicationPreference"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"PostEmailOptinInput":{"type":"object","properties":{"Brand":{"type":"string","description":"Brand name"},"ChangeDate":{"type":"string","format":"date-time","nullable":true,"description":"Change date (current date if empty)"},"Email":{"type":"string","description":"The unique identifier of the customer in CRM side."},"EmailOptin":{"type":"boolean","nullable":true,"description":"True if would receive an email"},"IsHardBounce":{"type":"boolean","description":"if the value is true the EmailOptin field will be ignored."},"SourceID":{"type":"string","description":"The source of the change"}},"required":["Email"]},"ApiOutput":{"type":"object","properties":{"Error":{"type":"string","description":"Error description"},"Response":{"type":"boolean","description":"The status call"}}}}},"paths":{"/api/CommunicationPreference/PostEmailOptin":{"post":{"operationId":"CommunicationPreferencePostEmailOptin","summary":"PostEmailOptin","tags":["CommunicationPreference"],"description":"Post preferences of know contact","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostEmailOptinInput"}}}},"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiOutput"}}}}}}}}} ``` ## PostSmsOptin > Validates MobileNumber, resolves source/brand preference settings, and queues SMS opt-in processing on a worker thread. The action sets Response=true after queueing; this is not confirmation that the asynchronous preference update completed. It is a consent-related mutation, not evidence of lawful consent or a new asynchronous status-polling capability. Inspect Response and Error and agree outcome/retry handling. ```json {"openapi":"3.0.3","info":{"title":"Atreemo API","version":"0.1.0"},"tags":[{"name":"CommunicationPreference","description":"Api Methods for CommunicationPreference"}],"servers":[{"url":"https://apim-hospitality-dev-uksouth.azure-api.net/atreemo-api","description":"Local DEV APIM import draft only; not a deployed endpoint announcement."}],"security":[{"AtreemoBearer":[]}],"components":{"securitySchemes":{"AtreemoBearer":{"type":"http","scheme":"bearer","description":"Atreemo access token obtained by the caller from the Atreemo instance `POST /token` endpoint (OAuth2 password grant) and sent as `Authorization: Bearer `. See the Authorisation guide."}},"schemas":{"PostSmsOptinInput":{"type":"object","properties":{"Brand":{"type":"string","description":"Brand ID"},"ChangeDate":{"type":"string","format":"date-time","nullable":true,"description":"Change date (current date if empty)"},"MobileNumber":{"type":"string","description":"The unique identifier of the customer in CRM side."},"SmsOptin":{"type":"boolean","nullable":true,"description":"True if would receive an SMS"},"SourceID":{"type":"string","description":"The source of the change"}},"required":["MobileNumber"]},"ApiOutput":{"type":"object","properties":{"Error":{"type":"string","description":"Error description"},"Response":{"type":"boolean","description":"The status call"}}}}},"paths":{"/api/CommunicationPreference/PostSmsOptin":{"post":{"operationId":"CommunicationPreferencePostSmsOptin","summary":"PostSmsOptin","tags":["CommunicationPreference"],"description":"Validates MobileNumber, resolves source/brand preference settings, and queues SMS opt-in processing on a worker thread. The action sets Response=true after queueing; this is not confirmation that the asynchronous preference update completed. It is a consent-related mutation, not evidence of lawful consent or a new asynchronous status-polling capability. Inspect Response and Error and agree outcome/retry handling.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostSmsOptinInput"}}}},"responses":{"200":{"description":"OK (sample status in the public collection).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiOutput"}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.hos.accessacloud.com/atreemo-api/api-reference/atreemo-api-reference/communication-preference.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.