---
title: "Get Salesforce account settings"
method: GET
path: "/v1/accounts/{accountId}/salesforce-settings"
tags: ["Accounts"]
---

# Get Salesforce account settings

`GET /v1/accounts/{accountId}/salesforce-settings`

## Request

- Base URL: `https://zernio.com/api`
- URL: `https://zernio.com/api/v1/accounts/{accountId}/salesforce-settings`
- Auth: HTTP bearer

Read a connected Salesforce org and what Zernio syncs to it.

## Path parameters

- `accountId` string, required

## Response `200`

Salesforce settings

- object
  - `account` SalesforceSettings
    - `_id` string, required: Zernio account ID of the Salesforce connection.
    - `platform` 'salesforce', required
    - `orgId` string, required: 18-character Salesforce organization ID.
    - `orgName` string, nullable, required: The org's name, when the connected user can read it.
    - `environment` 'production' | 'sandbox', required: Whether the org was connected through login.salesforce.com or test.salesforce.com.
    - `instanceUrl` string, uri, required: The org's API host, for example `https://acme.my.salesforce.com`.
    - `installedBy` string, nullable, required: Email or username of the Salesforce user who connected the org.
    - `syncContacts` boolean, required: Whether Zernio creates a Lead or Contact (per `createAs`) for an inbox contact that matches nobody by phone or email.
    - `logMessages` boolean, required: Whether Zernio logs inbox messages. Each person, channel and UTC day gets one completed Task (subject `WhatsApp conversation · 2026-11-17`) whose Description holds the transcript; a day past 32,000 characters continues in a Task marked "(part 2)".
    - `createAs` 'lead' | 'contact', required: What a person new to Salesforce is created as.
    - `logDeliveryStatus` boolean, required: Whether sent WhatsApp, SMS and RCS messages in the transcript are marked sent, delivered, read, played or failed.
    - `syncIssue` object, nullable, required: Set while the org refuses Zernio's writes for a reason only its admin can fix (field-level security, a validation rule, a duplicate rule); cleared by the next accepted write. The account's health shows it too.
      - `code` string, required: The Salesforce error code, such as `FIELD_CUSTOM_VALIDATION_EXCEPTION`.
      - `message` string, required
      - `at` string, date-time, required
    - `useOpportunitiesInResults` boolean, required: Whether closed-won Opportunities count as sales (Amount, in the Opportunity's or the org's currency) on the ad campaign named by their Primary Campaign Source, in campaign results and ad rules. Lost or reopened Opportunities stop counting.
    - `reportOpportunitiesToAds` boolean, required: Whether Zernio sends newly closed-won Opportunities as Purchase events (source `salesforce`) to the profile's event destinations.

## Other responses

- `400`: Invalid request
- `401`: Missing or invalid API key. `code` is `missing_credentials` when no Authorization header was sent and `invalid_credentials` when the key is unknown, revoked or expired.
- `404`: Account not found

## Changes

- **2026-11-17** `c1047366acbf`: 2 info
  - added the required property `account/reportOpportunitiesToAds` to the response with the `200` status
  - added the required property `account/useOpportunitiesInResults` to the response with the `200` status
- **2026-11-17** `716f6dff13e7`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zernio/apis/zernio-api/changes/v1/accounts/:accountId/salesforce-settings/get.md)

---

[API](https://skmtc.dev/zernio/apis/zernio-api.md) - [All operations](https://skmtc.dev/zernio/apis/zernio-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zernio/apis/zernio-api/revisions/6e9830774c82?raw)
