Documentation on Creating source via API

If we would like to create a source like Flat File or Web Services via API, do we have sample JSON for the same ?

One way to learn how to create a source via API is to first create the source using the UI and then getting the source using /v3/sources. The response object for a source should map very closely to the expected request body for creating a source. From there, you can modify values accordingly to create new sources.

Dear Colin,

Appreciate your response.

  • When we tried there is a difference between the manually created source through UI, and API created source.
  • Need to understand the attributes and values so that we can do the right things
  • Sometime the API error response would be complex to interpret to fix the issue as it would say “The server did not find a current representation for the target resource.”

Its getting difficult to identify the appropriate attributes to use.


I understand that out current API docs for sources are lacking, and it’s hard to understand how to create one via the API. I’m working with the product team to improve these docs so it’s much clearer for you and others on how to use this API.

In the meantime, do you mind sharing with us your use case for using the API to create sources rather than the UI? We’d like to understand how you plan on using the API to better improve your experience.

@colin_mckibben I noticed in the example request body for creating the source, the object is an Identity for several of the Objects rather than the correct type.

For example, the account correlation is an Identity, where on an existing source in our tenant the type is ACCOUNT_CORRELATION_CONFIG

“accountCorrelationConfig”: {

"type": "IDENTITY",
"id": "2c91808568c529c60168cca6f90c1313",
"name": "William Wilson"


@ethompson , we apologize for the confusion that issues like this cause. Our reference objects all use the same base schema in the API spec, which uses an Identity as the example value and assumes a wide range of possible types in the enum. Unfortunately, this means that a lot of our API schemas have incorrect specifications for these reference objects, as you have pointed out. We have it in our backlog to comb through the existing specs and fix issues like these.

1 Like