Create or update a CRM data source

  • 1 minute(s) read
Prev Next
Put
/v1/SyncRegistry/CrmDataSource/{crmDataSourceId}

Creates a CRM data source in the SRS database or updates an existing one.

Security
API Key: Authorization
Header parameter nameAuthorization

Add an Authorization header to authenticate requests originating outside of Zilliant's internal network. Set the header to Authorization: OAuth <tokenResponseBase64>.

<tokenResponseBase64> is the Base64-encoded entire JSON response body returned by the Salesforce OAuth token endpoint. Encode the full JSON payload, not only the access_token field.

For details, read Request an access token.

Header parameters
X-Forwarded-Host
string

OAuth host for your environment. Use it for all requests that originate outside Zilliant’s internal network. For details, read X-Forwarded-Host header in Introduction.

Path parameters
crmDataSourceId
stringRequired

Unique CRM data source ID to fetch.

ExamplecrmSalesforceProd
Body parameters
Create or update a CRM data source

Example of a CRM data source details

{
  "crmDataSourceId": "123456789",
  "type": "DYNAMICS",
  "purpose": "SALESMAX"
}
object
crmDataSourceId
string

Unique CRM data source ID. Must match the `crmDataSourceId`` path parameter. When creating, enter a meaningful ID. When updating, enter an ID of that data source.

Example123456789
type
string

Type of the CRM system.

Valid values[ "SALESFORCE", "DYNAMICS" ]
ExampleDYNAMICS
purpose
string

Salesforce org against which to run the job.

Supported values:

  • ZILLIANT—Use for ZPF and ZMX
  • PRICE_CONNECT—Use for ZPL
  • SALESMAX—Use for ZSX and ZSC
  • IDENTITY_PROVIDER—Use for OAuth
Valid values[ "ZILLIANT", "PRICE_CONNECT", "SALESMAX", "IDENTITY_PROVIDER" ]
ExampleSALESMAX
Responses
204

CRM data source created or updated successfully.