diff --git a/.yarn/versions/2feb9c56.yml b/.yarn/versions/2feb9c56.yml new file mode 100644 index 000000000..690b9e718 --- /dev/null +++ b/.yarn/versions/2feb9c56.yml @@ -0,0 +1,12 @@ +undecided: + - supaglue + - api + - mgmt-ui + - salesforce-pub-sub + - sync-worker + - "@supaglue/core" + - "@supaglue/db" + - "@supaglue/schemas" + - "@supaglue/sync-workflows" + - "@supaglue/types" + - "@supaglue/utils" diff --git a/README.md b/README.md index 7bc274dee..f5d280b19 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ https://github.com/supaglue-labs/supaglue/assets/1925713/8cc42b76-0118-40fb-950c ### Run Supaglue locally ```shell -git clone -b v0.14.11 https://github.com/supaglue-labs/supaglue.git && cd supaglue +git clone -b v0.14.12 https://github.com/supaglue-labs/supaglue.git && cd supaglue ./scripts/create_quickstart_env.sh docker compose up ``` diff --git a/apps/api/package.json b/apps/api/package.json index d4d9e5269..fa8352d24 100644 --- a/apps/api/package.json +++ b/apps/api/package.json @@ -1,6 +1,6 @@ { "name": "api", - "version": "0.14.11", + "version": "0.14.12", "private": true, "packageManager": "yarn@3.4.1", "type": "commonjs", diff --git a/apps/mgmt-ui/package.json b/apps/mgmt-ui/package.json index 315d583f2..7b65b52b9 100644 --- a/apps/mgmt-ui/package.json +++ b/apps/mgmt-ui/package.json @@ -1,6 +1,6 @@ { "name": "mgmt-ui", - "version": "0.14.11", + "version": "0.14.12", "private": true, "scripts": { "dev": "next dev", diff --git a/apps/salesforce-pub-sub/package.json b/apps/salesforce-pub-sub/package.json index bc733cf99..bdcac1846 100644 --- a/apps/salesforce-pub-sub/package.json +++ b/apps/salesforce-pub-sub/package.json @@ -1,6 +1,6 @@ { "name": "salesforce-pub-sub", - "version": "0.14.11", + "version": "0.14.12", "private": true, "packageManager": "yarn@3.4.1", "dependencies": { diff --git a/apps/sync-worker/package.json b/apps/sync-worker/package.json index e9b02257c..6c5af7877 100644 --- a/apps/sync-worker/package.json +++ b/apps/sync-worker/package.json @@ -1,6 +1,6 @@ { "name": "sync-worker", - "version": "0.14.11", + "version": "0.14.12", "private": true, "packageManager": "yarn@3.4.1", "dependencies": { diff --git a/docker-compose.yml b/docker-compose.yml index fedc1fedb..b54e34c3d 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -42,7 +42,7 @@ services: POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-supaglue} api: - image: supaglue/api:0.14.11 + image: supaglue/api:0.14.12 ports: - '8080:8080' depends_on: @@ -61,7 +61,7 @@ services: restart: on-failure sync-worker: - image: supaglue/sync-worker:0.14.11 + image: supaglue/sync-worker:0.14.12 depends_on: postgres: condition: service_started @@ -74,7 +74,7 @@ services: restart: on-failure mgmt-ui: - image: supaglue/mgmt-ui:0.14.11 + image: supaglue/mgmt-ui:0.14.12 ports: - '3000:3000' depends_on: @@ -108,7 +108,7 @@ services: - temporalitedata:/data salesforce-pub-sub: - image: supaglue/salesforce-pub-sub:0.14.11 + image: supaglue/salesforce-pub-sub:0.14.12 environment: <<: *common-env restart: on-failure @@ -119,7 +119,7 @@ services: condition: service_completed_successfully init: - image: supaglue/api:0.14.11 + image: supaglue/api:0.14.12 environment: <<: *common-env SUPAGLUE_QUICKSTART_API_KEY: ${SUPAGLUE_QUICKSTART_API_KEY:-some-api-key} diff --git a/docs/docs/api/v2/actions/actions-api.info.mdx b/docs/docs/api/v2/actions/actions-api.info.mdx index 5d85dfd8d..7a16f9b35 100644 --- a/docs/docs/api/v2/actions/actions-api.info.mdx +++ b/docs/docs/api/v2/actions/actions-api.info.mdx @@ -13,7 +13,7 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 0.14.11 +Version: 0.14.12 diff --git a/docs/docs/api/v2/actions/get-list-view-membership.api.mdx b/docs/docs/api/v2/actions/get-list-view-membership.api.mdx index 4b5f2661a..1c61c6064 100644 --- a/docs/docs/api/v2/actions/get-list-view-membership.api.mdx +++ b/docs/docs/api/v2/actions/get-list-view-membership.api.mdx @@ -5,7 +5,7 @@ description: "Get list view membership" sidebar_label: "Get list view membership" hide_title: true hide_table_of_contents: true -api: {"operationId":"getListViewMembership","tags":["Salesforce"],"security":[{"x-api-key":[]}],"parameters":[{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"object_type","in":"path","required":true,"schema":{"type":"string","enum":["contact","account","lead","opportunity"]}},{"name":"list_view_id","in":"path","required":true,"schema":{"type":"string","example":"220e715a-0cbc-4d2d-8420-cd729f12f094"}}],"responses":{"200":{"description":"List Views","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for a member of this list view."},"raw_data":{"type":"object","additionalProperties":true,"description":"The raw data for this list view membership.","example":{"columns":[{"fieldNameOrPath":"Id","value":"0012800000bbzSAAAY"},{"fieldNameOrPath":"Email","value":"jdoe@example.com"},{"fieldNameOrPath":"FirstName","value":"John"},{"fieldNameOrPath":"LastName","value":"Doe"},{"fieldNameOrPath":"CreatedDate","value":"Fri Aug 01 21:15:46 GMT 2014"},{"fieldNameOrPath":"LastModifiedDate","value":"Fri Aug 01 21:15:46 GMT 2014"},{"fieldNameOrPath":"SystemModstamp","value":"Fri Aug 01 21:15:46 GMT 2014"}]}}},"required":["id","raw_data"],"title":"salesforce_list_view_membership"}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":12345,"description":"The unique identifier for this list view."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"my-list","description":"The developer name of this list view."},"label":{"type":"string","example":"My List","description":"The label for this list view."},"raw_data":{"type":"object","description":"The raw data for this list view.","additionalProperties":true,"example":{"describeUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/describe","developerName":"NewThisWeek","id":"00BD0000005WcBeMAK","label":"New This Week","resultsUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/results","soqlCompatible":true,"url":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK"}}},"required":["id","name","label","raw_data"],"title":"salesforce_list_view_metadata"}},"required":["pagination","records"]}}}}},"description":"Get list view membership","method":"get","path":"/salesforce/list_views/{object_type}/{list_id}","servers":[{"url":"https://api.supaglue.io/actions/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Actions API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Actions API documentation. Actions are helpful APIs scoped to Providers. They range from handling CRUD operations on objects to performing multi-step workflows.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/actions/v2\n```\n"},"postman":{"name":"Get list view membership","description":{"type":"text/plain"},"url":{"path":["salesforce","list_views",":object_type",":list_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_type"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"list_view_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getListViewMembership","tags":["Salesforce"],"security":[{"x-api-key":[]}],"parameters":[{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"object_type","in":"path","required":true,"schema":{"type":"string","enum":["contact","account","lead","opportunity"]}},{"name":"list_view_id","in":"path","required":true,"schema":{"type":"string","example":"220e715a-0cbc-4d2d-8420-cd729f12f094"}}],"responses":{"200":{"description":"List Views","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for a member of this list view."},"raw_data":{"type":"object","additionalProperties":true,"description":"The raw data for this list view membership.","example":{"columns":[{"fieldNameOrPath":"Id","value":"0012800000bbzSAAAY"},{"fieldNameOrPath":"Email","value":"jdoe@example.com"},{"fieldNameOrPath":"FirstName","value":"John"},{"fieldNameOrPath":"LastName","value":"Doe"},{"fieldNameOrPath":"CreatedDate","value":"Fri Aug 01 21:15:46 GMT 2014"},{"fieldNameOrPath":"LastModifiedDate","value":"Fri Aug 01 21:15:46 GMT 2014"},{"fieldNameOrPath":"SystemModstamp","value":"Fri Aug 01 21:15:46 GMT 2014"}]}}},"required":["id","raw_data"],"title":"salesforce_list_view_membership"}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":12345,"description":"The unique identifier for this list view."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"my-list","description":"The developer name of this list view."},"label":{"type":"string","example":"My List","description":"The label for this list view."},"raw_data":{"type":"object","description":"The raw data for this list view.","additionalProperties":true,"example":{"describeUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/describe","developerName":"NewThisWeek","id":"00BD0000005WcBeMAK","label":"New This Week","resultsUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/results","soqlCompatible":true,"url":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK"}}},"required":["id","name","label","raw_data"],"title":"salesforce_list_view_metadata"}},"required":["pagination","records"]}}}}},"description":"Get list view membership","method":"get","path":"/salesforce/list_views/{object_type}/{list_id}","servers":[{"url":"https://api.supaglue.io/actions/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Actions API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Actions API documentation. Actions are helpful APIs scoped to Providers. They range from handling CRUD operations on objects to performing multi-step workflows.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/actions/v2\n```\n"},"postman":{"name":"Get list view membership","description":{"type":"text/plain"},"url":{"path":["salesforce","list_views",":object_type",":list_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_type"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"list_view_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/actions/actions-api custom_edit_url: null diff --git a/docs/docs/api/v2/actions/list-list-viewss.api.mdx b/docs/docs/api/v2/actions/list-list-viewss.api.mdx index 401ef7546..fb5a8892c 100644 --- a/docs/docs/api/v2/actions/list-list-viewss.api.mdx +++ b/docs/docs/api/v2/actions/list-list-viewss.api.mdx @@ -5,7 +5,7 @@ description: "List list views" sidebar_label: "List list views" hide_title: true hide_table_of_contents: true -api: {"operationId":"listListViewss","tags":["Salesforce"],"security":[{"x-api-key":[]}],"parameters":[{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"object_type","in":"path","required":true,"schema":{"type":"string","enum":["contact","account","lead","opportunity"]}}],"responses":{"200":{"description":"List Views","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":12345,"description":"The unique identifier for this list view."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"my-list","description":"The developer name of this list view."},"label":{"type":"string","example":"My List","description":"The label for this list view."},"raw_data":{"type":"object","description":"The raw data for this list view.","additionalProperties":true,"example":{"describeUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/describe","developerName":"NewThisWeek","id":"00BD0000005WcBeMAK","label":"New This Week","resultsUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/results","soqlCompatible":true,"url":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK"}}},"required":["id","name","label","raw_data"],"title":"salesforce_list_view_metadata"}}},"required":["pagination","records"]}}}}},"description":"List list views","method":"get","path":"/salesforce/list_views/{object_type}","servers":[{"url":"https://api.supaglue.io/actions/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Actions API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Actions API documentation. Actions are helpful APIs scoped to Providers. They range from handling CRUD operations on objects to performing multi-step workflows.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/actions/v2\n```\n"},"postman":{"name":"List list views","description":{"type":"text/plain"},"url":{"path":["salesforce","list_views",":object_type"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_type"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listListViewss","tags":["Salesforce"],"security":[{"x-api-key":[]}],"parameters":[{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"object_type","in":"path","required":true,"schema":{"type":"string","enum":["contact","account","lead","opportunity"]}}],"responses":{"200":{"description":"List Views","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":12345,"description":"The unique identifier for this list view."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"my-list","description":"The developer name of this list view."},"label":{"type":"string","example":"My List","description":"The label for this list view."},"raw_data":{"type":"object","description":"The raw data for this list view.","additionalProperties":true,"example":{"describeUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/describe","developerName":"NewThisWeek","id":"00BD0000005WcBeMAK","label":"New This Week","resultsUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/results","soqlCompatible":true,"url":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK"}}},"required":["id","name","label","raw_data"],"title":"salesforce_list_view_metadata"}}},"required":["pagination","records"]}}}}},"description":"List list views","method":"get","path":"/salesforce/list_views/{object_type}","servers":[{"url":"https://api.supaglue.io/actions/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Actions API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Actions API documentation. Actions are helpful APIs scoped to Providers. They range from handling CRUD operations on objects to performing multi-step workflows.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/actions/v2\n```\n"},"postman":{"name":"List list views","description":{"type":"text/plain"},"url":{"path":["salesforce","list_views",":object_type"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_type"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/actions/actions-api custom_edit_url: null diff --git a/docs/docs/api/v2/actions/send-passthrough-request.api.mdx b/docs/docs/api/v2/actions/send-passthrough-request.api.mdx index b6149ab8a..7d019d9c6 100644 --- a/docs/docs/api/v2/actions/send-passthrough-request.api.mdx +++ b/docs/docs/api/v2/actions/send-passthrough-request.api.mdx @@ -5,7 +5,7 @@ description: "Send request directly to a provider" sidebar_label: "Send passthrough request" hide_title: true hide_table_of_contents: true -api: {"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["path","method"],"example":{"path":"/crm/v3/schemas","method":"GET"}}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customcrm.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://api.hubapi.com/crm/v3/schemas","status":200,"headers":{"x-hubspot-ratelimit-remaining":99},"body":{"results":[{"labels":{"singular":"Contract","plural":"Contracts"},"requiredProperties":["name","description"]}]}}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/actions/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"/crm/v3/schemas","method":"GET"},"info":{"version":"0.14.11","title":"Actions API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Actions API documentation. Actions are helpful APIs scoped to Providers. They range from handling CRUD operations on objects to performing multi-step workflows.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/actions/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["path","method"],"example":{"path":"/crm/v3/schemas","method":"GET"}}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customcrm.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://api.hubapi.com/crm/v3/schemas","status":200,"headers":{"x-hubspot-ratelimit-remaining":99},"body":{"results":[{"labels":{"singular":"Contract","plural":"Contracts"},"requiredProperties":["name","description"]}]}}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/actions/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"/crm/v3/schemas","method":"GET"},"info":{"version":"0.14.12","title":"Actions API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Actions API documentation. Actions are helpful APIs scoped to Providers. They range from handling CRUD operations on objects to performing multi-step workflows.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/actions/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/actions/actions-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/create-account.api.mdx b/docs/docs/api/v2/crm/create-account.api.mdx index b3b37538e..05c8177c7 100644 --- a/docs/docs/api/v2/crm/create-account.api.mdx +++ b/docs/docs/api/v2/crm/create-account.api.mdx @@ -5,7 +5,7 @@ description: "Create account" sidebar_label: "Create account" hide_title: true hide_table_of_contents: true -api: {"operationId":"createAccount","tags":["Accounts"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"}},"required":["record"]}}}},"responses":{"201":{"description":"Account created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create account","method":"post","path":"/accounts","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create account","description":{"type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createAccount","tags":["Accounts"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"}},"required":["record"]}}}},"responses":{"201":{"description":"Account created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create account","method":"post","path":"/accounts","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create account","description":{"type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/create-contact.api.mdx b/docs/docs/api/v2/crm/create-contact.api.mdx index 949569ab4..a15d6a7fd 100644 --- a/docs/docs/api/v2/crm/create-contact.api.mdx +++ b/docs/docs/api/v2/crm/create-contact.api.mdx @@ -5,7 +5,7 @@ description: "Create contact" sidebar_label: "Create contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"createContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"}},"required":["record"]},"example":{"record":{"first_name":"George","last_activity_at":"2022-02-10T00:00:00Z","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"}}}}},"responses":{"201":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create contact","method":"post","path":"/contacts","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create contact","description":{"type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"}},"required":["record"]},"example":{"record":{"first_name":"George","last_activity_at":"2022-02-10T00:00:00Z","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"}}}}},"responses":{"201":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create contact","method":"post","path":"/contacts","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create contact","description":{"type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/create-lead.api.mdx b/docs/docs/api/v2/crm/create-lead.api.mdx index 42360edc8..21e636b68 100644 --- a/docs/docs/api/v2/crm/create-lead.api.mdx +++ b/docs/docs/api/v2/crm/create-lead.api.mdx @@ -5,7 +5,7 @@ description: "Create lead" sidebar_label: "Create lead" hide_title: true hide_table_of_contents: true -api: {"operationId":"createLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"company":{"type":"string","nullable":true,"example":"Supaglue"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"title":{"type":"string","example":"Co-Founder"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"converted_contact_id":{"type":"string","nullable":true,"example":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b"},"converted_account_id":{"type":"string","nullable":true,"example":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_lead"}},"required":["record"]},"example":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder"}}}}},"responses":{"201":{"description":"Lead created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create lead","method":"post","path":"/leads","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder","email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","converted_contact_id":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b","converted_account_id":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd","custom_fields":{}}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create lead","description":{"type":"text/plain"},"url":{"path":["leads"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"company":{"type":"string","nullable":true,"example":"Supaglue"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"title":{"type":"string","example":"Co-Founder"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"converted_contact_id":{"type":"string","nullable":true,"example":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b"},"converted_account_id":{"type":"string","nullable":true,"example":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_lead"}},"required":["record"]},"example":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder"}}}}},"responses":{"201":{"description":"Lead created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create lead","method":"post","path":"/leads","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder","email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","converted_contact_id":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b","converted_account_id":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create lead","description":{"type":"text/plain"},"url":{"path":["leads"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/create-opportunity.api.mdx b/docs/docs/api/v2/crm/create-opportunity.api.mdx index 247931838..ab2a3a384 100644 --- a/docs/docs/api/v2/crm/create-opportunity.api.mdx +++ b/docs/docs/api/v2/crm/create-opportunity.api.mdx @@ -5,7 +5,7 @@ description: "Create opportunity" sidebar_label: "Create opportunity" hide_title: true hide_table_of_contents: true -api: {"operationId":"createOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"example":"2022-02-10T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"name":{"type":"string","nullable":true,"example":"Needs Integrations"},"stage":{"type":"string","example":"Closed Won"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"pipeline":{"type":"string","nullable":true},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_opportunity"}},"required":["record"]},"example":{"record":{"amount":100000,"close_date":"2023-02-27T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"109c88c0-7bf4-4cd8-afbc-b51f9432ca0b"}}}}},"responses":{"201":{"description":"Opportunity created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create opportunity","method":"post","path":"/opportunities","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"amount":100000,"close_date":"2022-02-10T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","pipeline":"string","custom_fields":{}}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"example":"2022-02-10T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"name":{"type":"string","nullable":true,"example":"Needs Integrations"},"stage":{"type":"string","example":"Closed Won"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"pipeline":{"type":"string","nullable":true},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_opportunity"}},"required":["record"]},"example":{"record":{"amount":100000,"close_date":"2023-02-27T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"109c88c0-7bf4-4cd8-afbc-b51f9432ca0b"}}}}},"responses":{"201":{"description":"Opportunity created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create opportunity","method":"post","path":"/opportunities","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"amount":100000,"close_date":"2022-02-10T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","pipeline":"string","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/get-account.api.mdx b/docs/docs/api/v2/crm/get-account.api.mdx index 0b5505374..e3f40833f 100644 --- a/docs/docs/api/v2/crm/get-account.api.mdx +++ b/docs/docs/api/v2/crm/get-account.api.mdx @@ -5,7 +5,7 @@ description: "Get account" sidebar_label: "Get account" hide_title: true hide_table_of_contents: true -api: {"operationId":"getAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Account","content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"examples":{"Example":{"value":{"addresses":[{"address_type":"BILLING","city":"San Francisco","country":"CX","postal_code":"94107","state":"CA","street1":"525 Brannan","street2":null},{"address_type":"BILLING","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street1":"525 Brannan","street2":null}],"description":"Integration API","id":1234,"industry":"API's","last_activity_at":"2022-02-10T00:00:00Z","name":"Supaglue","number_of_employees":276000,"owner_id":"9377fd4d-d420-4e0b-93ea-789078a3eab4","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z","website":"https://supaglue.com/"}}}}}}},"description":"Get account","method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Account","content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"examples":{"Example":{"value":{"addresses":[{"address_type":"BILLING","city":"San Francisco","country":"CX","postal_code":"94107","state":"CA","street1":"525 Brannan","street2":null},{"address_type":"BILLING","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street1":"525 Brannan","street2":null}],"description":"Integration API","id":1234,"industry":"API's","last_activity_at":"2022-02-10T00:00:00Z","name":"Supaglue","number_of_employees":276000,"owner_id":"9377fd4d-d420-4e0b-93ea-789078a3eab4","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z","website":"https://supaglue.com/"}}}}}}},"description":"Get account","method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/get-contact.api.mdx b/docs/docs/api/v2/crm/get-contact.api.mdx index 03dae0273..efc85f86e 100644 --- a/docs/docs/api/v2/crm/get-contact.api.mdx +++ b/docs/docs/api/v2/crm/get-contact.api.mdx @@ -5,7 +5,7 @@ description: "Get contact" sidebar_label: "Get contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"getContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"}}}}},"description":"Get contact","method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"}}}}},"description":"Get contact","method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/get-lead.api.mdx b/docs/docs/api/v2/crm/get-lead.api.mdx index ea82d7f17..879c22a1d 100644 --- a/docs/docs/api/v2/crm/get-lead.api.mdx +++ b/docs/docs/api/v2/crm/get-lead.api.mdx @@ -5,7 +5,7 @@ description: "Get lead" sidebar_label: "Get lead" hide_title: true hide_table_of_contents: true -api: {"operationId":"getLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","example":"82de27cb-6f8c-4278-b783-82d1d916eddc"}}],"responses":{"200":{"description":"Lead","content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"company":{"type":"string","nullable":true,"example":"Supaglue"},"converted_account_id":{"type":"string","nullable":true,"example":"88cc44ca-7a34-4e8b-b0da-51c3aae34daf"},"converted_account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"converted_contact_id":{"type":"string","nullable":true,"example":"8c8de778-a219-4d6c-848c-1d57b52149f6"},"converted_contact":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"},"converted_date":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"owner_id":{"type":"string","nullable":true,"example":"62e5e0f7-becd-4ae2-be82-8b4e1d5ed8a2"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"title":{"type":"string","nullable":true,"example":"Co-Founder"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-10T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-10T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","company","converted_account_id","converted_contact_id","converted_date","id","last_name","lead_source","owner_id","phone_numbers","title","created_at","updated_at","is_deleted","last_modified_at"],"title":"lead"}}}}},"description":"Get lead","method":"get","path":"/leads/{lead_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get lead","description":{"type":"text/plain"},"url":{"path":["leads",":lead_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"lead_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","example":"82de27cb-6f8c-4278-b783-82d1d916eddc"}}],"responses":{"200":{"description":"Lead","content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"company":{"type":"string","nullable":true,"example":"Supaglue"},"converted_account_id":{"type":"string","nullable":true,"example":"88cc44ca-7a34-4e8b-b0da-51c3aae34daf"},"converted_account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"converted_contact_id":{"type":"string","nullable":true,"example":"8c8de778-a219-4d6c-848c-1d57b52149f6"},"converted_contact":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"},"converted_date":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"owner_id":{"type":"string","nullable":true,"example":"62e5e0f7-becd-4ae2-be82-8b4e1d5ed8a2"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"title":{"type":"string","nullable":true,"example":"Co-Founder"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-10T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-10T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","company","converted_account_id","converted_contact_id","converted_date","id","last_name","lead_source","owner_id","phone_numbers","title","created_at","updated_at","is_deleted","last_modified_at"],"title":"lead"}}}}},"description":"Get lead","method":"get","path":"/leads/{lead_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get lead","description":{"type":"text/plain"},"url":{"path":["leads",":lead_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"lead_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/get-opportunity.api.mdx b/docs/docs/api/v2/crm/get-opportunity.api.mdx index beffb9f90..38ff0d1b3 100644 --- a/docs/docs/api/v2/crm/get-opportunity.api.mdx +++ b/docs/docs/api/v2/crm/get-opportunity.api.mdx @@ -5,7 +5,7 @@ description: "Get opportunity" sidebar_label: "Get opportunity" hide_title: true hide_table_of_contents: true -api: {"operationId":"getOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"opportunity_id","in":"path","required":true,"schema":{"type":"string","example":"c9f58083-a370-47b5-ad02-99160ea20372"}}],"responses":{"200":{"description":"Opportunity","content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Needs third-party integrations"},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"pipeline":{"type":"string","nullable":true},"stage":{"type":"string","nullable":true,"example":"Closed Won"},"status":{"type":"string","nullable":true,"example":"OPEN"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["account_id","amount","description","id","last_activity_at","name","owner_id","stage","status","pipeline","created_at","updated_at","is_deleted","last_modified_at"],"title":"opportunity"},"examples":{"Example":{"value":{"account":{"id":"a329053d-bf86-4b82-8356-9e897aa7dacc"},"amount":100000,"close_date":"2023-02-27T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","id":1234,"last_activity_at":"2023-02-27T00:00:00Z","name":"Needs third-party integrations","owner":"93b0c2b5-26a8-4b92-b4e5-05d764eb1119","created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z","stage":"Closed Won"}}}}}}},"description":"Get opportunity","method":"get","path":"/opportunities/{opportunity_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities",":opportunity_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"opportunity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"opportunity_id","in":"path","required":true,"schema":{"type":"string","example":"c9f58083-a370-47b5-ad02-99160ea20372"}}],"responses":{"200":{"description":"Opportunity","content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Needs third-party integrations"},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"pipeline":{"type":"string","nullable":true},"stage":{"type":"string","nullable":true,"example":"Closed Won"},"status":{"type":"string","nullable":true,"example":"OPEN"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["account_id","amount","description","id","last_activity_at","name","owner_id","stage","status","pipeline","created_at","updated_at","is_deleted","last_modified_at"],"title":"opportunity"},"examples":{"Example":{"value":{"account":{"id":"a329053d-bf86-4b82-8356-9e897aa7dacc"},"amount":100000,"close_date":"2023-02-27T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","id":1234,"last_activity_at":"2023-02-27T00:00:00Z","name":"Needs third-party integrations","owner":"93b0c2b5-26a8-4b92-b4e5-05d764eb1119","created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z","stage":"Closed Won"}}}}}}},"description":"Get opportunity","method":"get","path":"/opportunities/{opportunity_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities",":opportunity_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"opportunity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/get-user.api.mdx b/docs/docs/api/v2/crm/get-user.api.mdx index 3f3a4eefa..bf37a9d3a 100644 --- a/docs/docs/api/v2/crm/get-user.api.mdx +++ b/docs/docs/api/v2/crm/get-user.api.mdx @@ -5,7 +5,7 @@ description: "Get user" sidebar_label: "Get user" hide_title: true hide_table_of_contents: true -api: {"operationId":"getUser","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"}}}}},"description":"Get user","method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get user","description":{"type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getUser","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"}}}}},"description":"Get user","method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get user","description":{"type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/send-passthrough-request.api.mdx b/docs/docs/api/v2/crm/send-passthrough-request.api.mdx index 1e749476b..d5059a02c 100644 --- a/docs/docs/api/v2/crm/send-passthrough-request.api.mdx +++ b/docs/docs/api/v2/crm/send-passthrough-request.api.mdx @@ -5,7 +5,7 @@ description: "Send request directly to a provider" sidebar_label: "Send passthrough request" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["path","method"]}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customcrm.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://customcrm.com/api/cars","status":200,"headers":{"x-requests-limit":96},"body":[]}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"string","method":"GET","headers":{},"query":{},"body":"string"},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["path","method"]}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customcrm.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://customcrm.com/api/cars","status":200,"headers":{"x-requests-limit":96},"body":[]}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"string","method":"GET","headers":{},"query":{},"body":"string"},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/unified-crm-api.info.mdx b/docs/docs/api/v2/crm/unified-crm-api.info.mdx index de72a7b8f..c7440b649 100644 --- a/docs/docs/api/v2/crm/unified-crm-api.info.mdx +++ b/docs/docs/api/v2/crm/unified-crm-api.info.mdx @@ -13,7 +13,7 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 0.14.11 +Version: 0.14.12 diff --git a/docs/docs/api/v2/crm/update-account.api.mdx b/docs/docs/api/v2/crm/update-account.api.mdx index 360da49b2..08bceba46 100644 --- a/docs/docs/api/v2/crm/update-account.api.mdx +++ b/docs/docs/api/v2/crm/update-account.api.mdx @@ -5,7 +5,7 @@ description: "Update account" sidebar_label: "Update account" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"}},"required":["record"]}}}},"responses":{"200":{"description":"Account updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update account","method":"patch","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"updateAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"}},"required":["record"]}}}},"responses":{"200":{"description":"Account updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update account","method":"patch","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/update-contact.api.mdx b/docs/docs/api/v2/crm/update-contact.api.mdx index f1ce108ec..53cf95dd4 100644 --- a/docs/docs/api/v2/crm/update-contact.api.mdx +++ b/docs/docs/api/v2/crm/update-contact.api.mdx @@ -5,7 +5,7 @@ description: "Update contact" sidebar_label: "Update contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"first_name":"George","last_name":"Xing","account_id":"0ce05511-adbc-4144-a049-6631c7ea3b04"}}}}}}},"responses":{"200":{"description":"Contact updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update contact","method":"patch","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"updateContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"first_name":"George","last_name":"Xing","account_id":"0ce05511-adbc-4144-a049-6631c7ea3b04"}}}}}}},"responses":{"200":{"description":"Contact updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update contact","method":"patch","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/update-lead.api.mdx b/docs/docs/api/v2/crm/update-lead.api.mdx index 34cd574fc..6ea65e9df 100644 --- a/docs/docs/api/v2/crm/update-lead.api.mdx +++ b/docs/docs/api/v2/crm/update-lead.api.mdx @@ -5,7 +5,7 @@ description: "Update lead" sidebar_label: "Update lead" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","example":"82de27cb-6f8c-4278-b783-82d1d916eddc"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"company":{"type":"string","nullable":true,"example":"Supaglue"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"title":{"type":"string","example":"Co-Founder"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"converted_contact_id":{"type":"string","nullable":true,"example":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b"},"converted_account_id":{"type":"string","nullable":true,"example":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_lead"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder"}}}}}}},"responses":{"200":{"description":"Lead updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update lead","method":"patch","path":"/leads/{lead_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder","email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","converted_contact_id":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b","converted_account_id":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd","custom_fields":{}}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update lead","description":{"type":"text/plain"},"url":{"path":["leads",":lead_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"lead_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"updateLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","example":"82de27cb-6f8c-4278-b783-82d1d916eddc"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"company":{"type":"string","nullable":true,"example":"Supaglue"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"title":{"type":"string","example":"Co-Founder"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"converted_contact_id":{"type":"string","nullable":true,"example":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b"},"converted_account_id":{"type":"string","nullable":true,"example":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_lead"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder"}}}}}}},"responses":{"200":{"description":"Lead updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update lead","method":"patch","path":"/leads/{lead_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder","email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","converted_contact_id":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b","converted_account_id":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update lead","description":{"type":"text/plain"},"url":{"path":["leads",":lead_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"lead_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/update-opportunity.api.mdx b/docs/docs/api/v2/crm/update-opportunity.api.mdx index 646e5d7ef..8523cb4a9 100644 --- a/docs/docs/api/v2/crm/update-opportunity.api.mdx +++ b/docs/docs/api/v2/crm/update-opportunity.api.mdx @@ -5,7 +5,7 @@ description: "Update opportunity" sidebar_label: "Update opportunity" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"opportunity_id","in":"path","required":true,"schema":{"type":"string","example":"c9f58083-a370-47b5-ad02-99160ea20372"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"example":"2022-02-10T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"name":{"type":"string","nullable":true,"example":"Needs Integrations"},"stage":{"type":"string","example":"Closed Won"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"pipeline":{"type":"string","nullable":true},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_opportunity"}},"required":["record"]}}}},"responses":{"200":{"description":"Opportunity updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update opportunity","method":"patch","path":"/opportunities/{opportunity_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"amount":100000,"close_date":"2022-02-10T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","pipeline":"string","custom_fields":{}}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities",":opportunity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"opportunity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"updateOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"opportunity_id","in":"path","required":true,"schema":{"type":"string","example":"c9f58083-a370-47b5-ad02-99160ea20372"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"example":"2022-02-10T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"name":{"type":"string","nullable":true,"example":"Needs Integrations"},"stage":{"type":"string","example":"Closed Won"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"pipeline":{"type":"string","nullable":true},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_opportunity"}},"required":["record"]}}}},"responses":{"200":{"description":"Opportunity updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update opportunity","method":"patch","path":"/opportunities/{opportunity_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"amount":100000,"close_date":"2022-02-10T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","pipeline":"string","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities",":opportunity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"opportunity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/upsert-account.api.mdx b/docs/docs/api/v2/crm/upsert-account.api.mdx index 7106508f9..4c255a5db 100644 --- a/docs/docs/api/v2/crm/upsert-account.api.mdx +++ b/docs/docs/api/v2/crm/upsert-account.api.mdx @@ -5,7 +5,7 @@ description: "Upsert account" sidebar_label: "Upsert account" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertAccount","tags":["Accounts"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["domain"]},"values":{"type":"array","items":{"type":"string","example":"mydomain.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"responses":{"201":{"description":"Account upserted","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Upsert account","method":"post","path":"/accounts/_upsert","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}},"upsert_on":{"key":"domain","values":["mydomain.com"]}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Upsert account","description":{"type":"text/plain"},"url":{"path":["accounts","_upsert"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"upsertAccount","tags":["Accounts"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["domain"]},"values":{"type":"array","items":{"type":"string","example":"mydomain.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"responses":{"201":{"description":"Account upserted","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Upsert account","method":"post","path":"/accounts/_upsert","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}},"upsert_on":{"key":"domain","values":["mydomain.com"]}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Upsert account","description":{"type":"text/plain"},"url":{"path":["accounts","_upsert"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/upsert-contact.api.mdx b/docs/docs/api/v2/crm/upsert-contact.api.mdx index 77bac4872..d80a2e970 100644 --- a/docs/docs/api/v2/crm/upsert-contact.api.mdx +++ b/docs/docs/api/v2/crm/upsert-contact.api.mdx @@ -5,7 +5,7 @@ description: "Upsert contact" sidebar_label: "Upsert contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["email"]},"values":{"type":"array","items":{"type":"string","example":"hello@example.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"responses":{"201":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Upsert contact","method":"post","path":"/contacts/_upsert","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}},"upsert_on":{"key":"email","values":["hello@example.com"]}},"info":{"version":"0.14.11","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Upsert contact","description":{"type":"text/plain"},"url":{"path":["contacts","_upsert"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"upsertContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["email"]},"values":{"type":"array","items":{"type":"string","example":"hello@example.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"responses":{"201":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Upsert contact","method":"post","path":"/contacts/_upsert","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}},"upsert_on":{"key":"email","values":["hello@example.com"]}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Upsert contact","description":{"type":"text/plain"},"url":{"path":["contacts","_upsert"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/engagement/create-account.api.mdx b/docs/docs/api/v2/engagement/create-account.api.mdx index a41f8a624..04ed67a1d 100644 --- a/docs/docs/api/v2/engagement/create-account.api.mdx +++ b/docs/docs/api/v2/engagement/create-account.api.mdx @@ -5,7 +5,7 @@ description: "Create account" sidebar_label: "Create account" hide_title: true hide_table_of_contents: true -api: {"operationId":"createAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_account"}},"required":["record"]},"example":{"record":{"id":1234,"name":"My Company","domain":"mycompany.com","created_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Account created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create account","method":"post","path":"/accounts","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"My Company","domain":"mycompany.com","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.11","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create account","description":{"type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_account"}},"required":["record"]},"example":{"record":{"id":1234,"name":"My Company","domain":"mycompany.com","created_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Account created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create account","method":"post","path":"/accounts","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"My Company","domain":"mycompany.com","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create account","description":{"type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/docs/api/v2/engagement/create-contact.api.mdx b/docs/docs/api/v2/engagement/create-contact.api.mdx index 7f645aad6..747259697 100644 --- a/docs/docs/api/v2/engagement/create-contact.api.mdx +++ b/docs/docs/api/v2/engagement/create-contact.api.mdx @@ -5,7 +5,7 @@ description: "Create contact" sidebar_label: "Create contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"createContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_contact"}},"required":["record"]},"example":{"record":{"id":1234,"address":{"city":"San Francisco","country":"USA","street_1":"525 Brannan St","street_2":null,"postalCode":"94107","state":"CA"},"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"workline2"}],"first_name":"George","last_name":"Xing","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create contact","method":"post","path":"/contacts","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","job_title":"CEO","address":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.11","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create contact","description":{"type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_contact"}},"required":["record"]},"example":{"record":{"id":1234,"address":{"city":"San Francisco","country":"USA","street_1":"525 Brannan St","street_2":null,"postalCode":"94107","state":"CA"},"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"workline2"}],"first_name":"George","last_name":"Xing","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create contact","method":"post","path":"/contacts","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","job_title":"CEO","address":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create contact","description":{"type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/docs/api/v2/engagement/create-sequence-state.api.mdx b/docs/docs/api/v2/engagement/create-sequence-state.api.mdx index 93a3a5405..f71876069 100644 --- a/docs/docs/api/v2/engagement/create-sequence-state.api.mdx +++ b/docs/docs/api/v2/engagement/create-sequence-state.api.mdx @@ -5,7 +5,7 @@ description: "Create sequence state" sidebar_label: "Create sequence state" hide_title: true hide_table_of_contents: true -api: {"operationId":"createSequenceState","tags":["Sequence States"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"contact_id":{"type":"string","example":"c590dc63-8e43-48a4-8154-1fbb00ac936b"},"mailbox_id":{"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d","description":"The ID of the mailbox to use for the sequence. Required for Apollo and Outreach. Unused for Salesloft."},"sequence_id":{"type":"string","example":"b854e510-1c40-4ef6-ade4-8eb35f49d331"},"user_id":{"type":"string","description":"The ID of the user who is performing the action. Required for Salesloft, optional for Apollo, unused for Outreach."}},"required":["contact_id","sequence_id"],"title":"create_sequence_state"}},"required":["record"]},"example":{"record":{"id":"355843a5-c536-4e82-b497-05160bfb7d78","state":"active","mailbox_id":"a7e860b5-cb8b-400b-812d-921fa526140c","contact_id":"6bdcebc2-f886-4de3-88ed-0b9eb420f7b1","sequence_id":"45e07817-fd59-4ec8-a727-066d2db27c9b","created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Sequence state created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create sequence state","method":"post","path":"/sequence_states","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"contact_id":"c590dc63-8e43-48a4-8154-1fbb00ac936b","mailbox_id":"39fd1fe0-094b-4a61-b47f-3e3ac033203d","sequence_id":"b854e510-1c40-4ef6-ade4-8eb35f49d331","user_id":"string"}},"info":{"version":"0.14.11","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence state","description":{"type":"text/plain"},"url":{"path":["sequence_states"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createSequenceState","tags":["Sequence States"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"contact_id":{"type":"string","example":"c590dc63-8e43-48a4-8154-1fbb00ac936b"},"mailbox_id":{"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d","description":"The ID of the mailbox to use for the sequence. Required for Apollo and Outreach. Unused for Salesloft."},"sequence_id":{"type":"string","example":"b854e510-1c40-4ef6-ade4-8eb35f49d331"},"user_id":{"type":"string","description":"The ID of the user who is performing the action. Required for Salesloft, optional for Apollo, unused for Outreach."}},"required":["contact_id","sequence_id"],"title":"create_sequence_state"}},"required":["record"]},"example":{"record":{"id":"355843a5-c536-4e82-b497-05160bfb7d78","state":"active","mailbox_id":"a7e860b5-cb8b-400b-812d-921fa526140c","contact_id":"6bdcebc2-f886-4de3-88ed-0b9eb420f7b1","sequence_id":"45e07817-fd59-4ec8-a727-066d2db27c9b","created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Sequence state created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create sequence state","method":"post","path":"/sequence_states","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"contact_id":"c590dc63-8e43-48a4-8154-1fbb00ac936b","mailbox_id":"39fd1fe0-094b-4a61-b47f-3e3ac033203d","sequence_id":"b854e510-1c40-4ef6-ade4-8eb35f49d331","user_id":"string"}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence state","description":{"type":"text/plain"},"url":{"path":["sequence_states"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/docs/api/v2/engagement/create-sequence-step.api.mdx b/docs/docs/api/v2/engagement/create-sequence-step.api.mdx index 05a0c1621..fc3f6d6e3 100644 --- a/docs/docs/api/v2/engagement/create-sequence-step.api.mdx +++ b/docs/docs/api/v2/engagement/create-sequence-step.api.mdx @@ -5,7 +5,7 @@ description: "Create sequence step" sidebar_label: "Create sequence step" hide_title: true hide_table_of_contents: true -api: {"operationId":"createSequenceStep","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_id","in":"path","required":true,"description":"The ID of the sequence.","schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"interval_seconds":{"type":"number","description":"The interval (in seconds) until this step will activate; only applicable to interval-based sequences."},"date":{"type":"string","example":"2023-01-01","description":"The date this step will activate; only applicable to date-based sequences."},"template":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"The ID of the template to use for this step."}},"required":["id"]},{"type":"object","properties":{"body":{"type":"string","description":"The body of the email (HTML)."},"subject":{"type":"string","description":"The subject of the email."},"name":{"type":"string","description":"The name of the template."},"to":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"to\" field","items":{"type":"string"}},"cc":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"cc\" field","items":{"type":"string"}},"bcc":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"bcc\" field","items":{"type":"string"}},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["body","subject","name"]}]},"is_reply":{"type":"boolean","description":"If true, this step will be sent as a reply to the previous step."},"order":{"type":"number","description":"The step's display order within its sequence."},"type":{"type":"string","enum":["auto","manual"]},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["template","is_reply","order","type"],"title":"create_sequence_step"}},"required":["record"]}}}},"responses":{"201":{"description":"Sequence step created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create sequence step","method":"post","path":"/sequences/{sequence_id}/sequence_steps","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"interval_seconds":0,"date":"2023-01-01","template":{"id":"string"},"is_reply":true,"order":0,"type":"auto","custom_fields":{}}},"info":{"version":"0.14.11","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence step","description":{"type":"text/plain"},"url":{"path":["sequences",":sequence_id","sequence_steps"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the sequence.","type":"text/plain"},"type":"any","value":"","key":"sequence_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createSequenceStep","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_id","in":"path","required":true,"description":"The ID of the sequence.","schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"interval_seconds":{"type":"number","description":"The interval (in seconds) until this step will activate; only applicable to interval-based sequences."},"date":{"type":"string","example":"2023-01-01","description":"The date this step will activate; only applicable to date-based sequences."},"template":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"The ID of the template to use for this step."}},"required":["id"]},{"type":"object","properties":{"body":{"type":"string","description":"The body of the email (HTML)."},"subject":{"type":"string","description":"The subject of the email."},"name":{"type":"string","description":"The name of the template."},"to":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"to\" field","items":{"type":"string"}},"cc":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"cc\" field","items":{"type":"string"}},"bcc":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"bcc\" field","items":{"type":"string"}},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["body","subject","name"]}]},"is_reply":{"type":"boolean","description":"If true, this step will be sent as a reply to the previous step."},"order":{"type":"number","description":"The step's display order within its sequence."},"type":{"type":"string","enum":["auto","manual"]},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["template","is_reply","order","type"],"title":"create_sequence_step"}},"required":["record"]}}}},"responses":{"201":{"description":"Sequence step created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create sequence step","method":"post","path":"/sequences/{sequence_id}/sequence_steps","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"interval_seconds":0,"date":"2023-01-01","template":{"id":"string"},"is_reply":true,"order":0,"type":"auto","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence step","description":{"type":"text/plain"},"url":{"path":["sequences",":sequence_id","sequence_steps"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the sequence.","type":"text/plain"},"type":"any","value":"","key":"sequence_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/docs/api/v2/engagement/create-sequence.api.mdx b/docs/docs/api/v2/engagement/create-sequence.api.mdx index 4fab00b19..530b5658d 100644 --- a/docs/docs/api/v2/engagement/create-sequence.api.mdx +++ b/docs/docs/api/v2/engagement/create-sequence.api.mdx @@ -5,7 +5,7 @@ description: "Create sequence" sidebar_label: "Create sequence" hide_title: true hide_table_of_contents: true -api: {"operationId":"createSequence","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"type":{"type":"string","description":"The share type of the sequence. Setting to `team` will share with the whole team. `private` will only share with the owner.","enum":["team","private"]},"owner_id":{"type":"string"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["name","type"],"title":"create_sequence"}},"required":["record"]}}}},"responses":{"201":{"description":"Sequence created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create sequence","method":"post","path":"/sequences","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"string","tags":["string"],"type":"team","owner_id":"string","custom_fields":{}}},"info":{"version":"0.14.11","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence","description":{"type":"text/plain"},"url":{"path":["sequences"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createSequence","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"type":{"type":"string","description":"The share type of the sequence. Setting to `team` will share with the whole team. `private` will only share with the owner.","enum":["team","private"]},"owner_id":{"type":"string"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["name","type"],"title":"create_sequence"}},"required":["record"]}}}},"responses":{"201":{"description":"Sequence created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create sequence","method":"post","path":"/sequences","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"string","tags":["string"],"type":"team","owner_id":"string","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence","description":{"type":"text/plain"},"url":{"path":["sequences"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/docs/api/v2/engagement/get-account.api.mdx b/docs/docs/api/v2/engagement/get-account.api.mdx index 134f28908..b1a8e0675 100644 --- a/docs/docs/api/v2/engagement/get-account.api.mdx +++ b/docs/docs/api/v2/engagement/get-account.api.mdx @@ -5,7 +5,7 @@ description: "Get account" sidebar_label: "Get account" hide_title: true hide_table_of_contents: true -api: {"operationId":"getAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Account","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["id","owner_id","name","domain","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"}}}}},"description":"Get account","method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Account","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["id","owner_id","name","domain","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"}}}}},"description":"Get account","method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/docs/api/v2/engagement/get-contact.api.mdx b/docs/docs/api/v2/engagement/get-contact.api.mdx index de4f020da..543db5d62 100644 --- a/docs/docs/api/v2/engagement/get-contact.api.mdx +++ b/docs/docs/api/v2/engagement/get-contact.api.mdx @@ -5,7 +5,7 @@ description: "Get contact" sidebar_label: "Get contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"getContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"account_id":{"type":"string","nullable":true,"example":"45edea5a-0b9a-44ff-bd45-4452014eb4fa"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","nullable":true,"enum":["primary","work","home","mobile","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"work"}]},"open_count":{"type":"number"},"click_count":{"type":"number"},"reply_count":{"type":"number"},"bounced_count":{"type":"number"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["id","owner_id","first_name","last_name","job_title","address","email_addresses","phone_numbers","open_count","click_count","reply_count","bounced_count","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"}}}}},"description":"Get contact","method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"account_id":{"type":"string","nullable":true,"example":"45edea5a-0b9a-44ff-bd45-4452014eb4fa"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","nullable":true,"enum":["primary","work","home","mobile","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"work"}]},"open_count":{"type":"number"},"click_count":{"type":"number"},"reply_count":{"type":"number"},"bounced_count":{"type":"number"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["id","owner_id","first_name","last_name","job_title","address","email_addresses","phone_numbers","open_count","click_count","reply_count","bounced_count","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"}}}}},"description":"Get contact","method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/docs/api/v2/engagement/get-mailbox.api.mdx b/docs/docs/api/v2/engagement/get-mailbox.api.mdx index f97fe4b34..47962127b 100644 --- a/docs/docs/api/v2/engagement/get-mailbox.api.mdx +++ b/docs/docs/api/v2/engagement/get-mailbox.api.mdx @@ -5,7 +5,7 @@ description: "Get mailbox" sidebar_label: "Get mailbox" hide_title: true hide_table_of_contents: true -api: {"operationId":"getMailbox","tags":["Mailboxes"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"mailbox_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Mailbox","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"email":{"type":"string","nullable":true,"example":null},"user_id":{"nullable":true,"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","email","user_id","created_at","updated_at","is_deleted","last_modified_at"],"title":"mailbox"}}}}},"description":"Get mailbox","method":"get","path":"/mailboxes/{mailbox_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get mailbox","description":{"type":"text/plain"},"url":{"path":["mailboxes",":mailbox_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"mailbox_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getMailbox","tags":["Mailboxes"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"mailbox_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Mailbox","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"email":{"type":"string","nullable":true,"example":null},"user_id":{"nullable":true,"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","email","user_id","created_at","updated_at","is_deleted","last_modified_at"],"title":"mailbox"}}}}},"description":"Get mailbox","method":"get","path":"/mailboxes/{mailbox_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get mailbox","description":{"type":"text/plain"},"url":{"path":["mailboxes",":mailbox_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"mailbox_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/docs/api/v2/engagement/get-sequence-state.api.mdx b/docs/docs/api/v2/engagement/get-sequence-state.api.mdx index 86fdc3091..12dc86c1f 100644 --- a/docs/docs/api/v2/engagement/get-sequence-state.api.mdx +++ b/docs/docs/api/v2/engagement/get-sequence-state.api.mdx @@ -5,7 +5,7 @@ description: "Get sequence state" sidebar_label: "Get sequence state" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSequenceState","tags":["Sequence States"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_state_id","in":"path","required":true,"schema":{"type":"string","example":"ffb62704-addd-454e-bb86-ed0799703dc6"}}],"responses":{"200":{"description":"Sequence State","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"state":{"type":"string","nullable":true,"example":"active"},"contact_id":{"type":"string","nullable":true,"example":"c590dc63-8e43-48a4-8154-1fbb00ac936b"},"mailbox_id":{"nullable":true,"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d"},"user_id":{"nullable":true,"type":"string","example":"ab0530ef-61dd-4a99-b26b-6b5a61c7c62e"},"sequence_id":{"nullable":true,"type":"string","example":"b854e510-1c40-4ef6-ade4-8eb35f49d331"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","state","mailbox_id","user_id","contact_id","sequence_id","created_at","updated_at","is_deleted","last_modified_at"],"title":"sequence_state"}}}}},"description":"Get sequence state","method":"get","path":"/sequence_states/{sequence_state_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get sequence state","description":{"type":"text/plain"},"url":{"path":["sequence_states",":sequence_state_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sequence_state_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSequenceState","tags":["Sequence States"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_state_id","in":"path","required":true,"schema":{"type":"string","example":"ffb62704-addd-454e-bb86-ed0799703dc6"}}],"responses":{"200":{"description":"Sequence State","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"state":{"type":"string","nullable":true,"example":"active"},"contact_id":{"type":"string","nullable":true,"example":"c590dc63-8e43-48a4-8154-1fbb00ac936b"},"mailbox_id":{"nullable":true,"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d"},"user_id":{"nullable":true,"type":"string","example":"ab0530ef-61dd-4a99-b26b-6b5a61c7c62e"},"sequence_id":{"nullable":true,"type":"string","example":"b854e510-1c40-4ef6-ade4-8eb35f49d331"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","state","mailbox_id","user_id","contact_id","sequence_id","created_at","updated_at","is_deleted","last_modified_at"],"title":"sequence_state"}}}}},"description":"Get sequence state","method":"get","path":"/sequence_states/{sequence_state_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get sequence state","description":{"type":"text/plain"},"url":{"path":["sequence_states",":sequence_state_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sequence_state_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/docs/api/v2/engagement/get-sequence.api.mdx b/docs/docs/api/v2/engagement/get-sequence.api.mdx index 3118decce..cbeacc98d 100644 --- a/docs/docs/api/v2/engagement/get-sequence.api.mdx +++ b/docs/docs/api/v2/engagement/get-sequence.api.mdx @@ -5,7 +5,7 @@ description: "Get sequence" sidebar_label: "Get sequence" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSequence","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Sequence","content":{"application/json":{"schema":{"type":"object","properties":{"owner_id":{"type":"string","nullable":true,"example":"95fe0d29-e8cc-48ac-9afd-e02d8037a597"},"id":{"type":"string","example":54312},"is_enabled":{"type":"boolean","example":true},"name":{"nullable":true,"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"num_steps":{"type":"number"},"metrics":{"type":"object","additionalProperties":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","is_enabled","name","tags","num_steps","metrics","created_at","updated_at","last_modified_at"],"title":"sequence"}}}}},"description":"Get sequence","method":"get","path":"/sequences/{sequence_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get sequence","description":{"type":"text/plain"},"url":{"path":["sequences",":sequence_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sequence_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSequence","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Sequence","content":{"application/json":{"schema":{"type":"object","properties":{"owner_id":{"type":"string","nullable":true,"example":"95fe0d29-e8cc-48ac-9afd-e02d8037a597"},"id":{"type":"string","example":54312},"is_enabled":{"type":"boolean","example":true},"name":{"nullable":true,"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"num_steps":{"type":"number"},"metrics":{"type":"object","additionalProperties":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","is_enabled","name","tags","num_steps","metrics","created_at","updated_at","last_modified_at"],"title":"sequence"}}}}},"description":"Get sequence","method":"get","path":"/sequences/{sequence_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get sequence","description":{"type":"text/plain"},"url":{"path":["sequences",":sequence_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sequence_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/docs/api/v2/engagement/get-user.api.mdx b/docs/docs/api/v2/engagement/get-user.api.mdx index 2fcbe35aa..5548546ad 100644 --- a/docs/docs/api/v2/engagement/get-user.api.mdx +++ b/docs/docs/api/v2/engagement/get-user.api.mdx @@ -5,7 +5,7 @@ description: "Get user" sidebar_label: "Get user" hide_title: true hide_table_of_contents: true -api: {"operationId":"getUser","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","first_name","last_name","email","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"}}}}},"description":"Get user","method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get user","description":{"type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getUser","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","first_name","last_name","email","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"}}}}},"description":"Get user","method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get user","description":{"type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/docs/api/v2/engagement/send-passthrough-request.api.mdx b/docs/docs/api/v2/engagement/send-passthrough-request.api.mdx index a7e5d4de5..93de41bf6 100644 --- a/docs/docs/api/v2/engagement/send-passthrough-request.api.mdx +++ b/docs/docs/api/v2/engagement/send-passthrough-request.api.mdx @@ -5,7 +5,7 @@ description: "Send request directly to a provider" sidebar_label: "Send passthrough request" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["path","method"]}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customengagement.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://customengagement.com/api/cars","status":200,"headers":{"x-requests-limit":96},"body":[]}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"string","method":"GET","headers":{},"query":{},"body":"string"},"info":{"version":"0.14.11","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["path","method"]}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customengagement.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://customengagement.com/api/cars","status":200,"headers":{"x-requests-limit":96},"body":[]}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"string","method":"GET","headers":{},"query":{},"body":"string"},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/docs/api/v2/engagement/unified-engagement-api.info.mdx b/docs/docs/api/v2/engagement/unified-engagement-api.info.mdx index 1348a654e..a8e0aa27c 100644 --- a/docs/docs/api/v2/engagement/unified-engagement-api.info.mdx +++ b/docs/docs/api/v2/engagement/unified-engagement-api.info.mdx @@ -13,7 +13,7 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 0.14.11 +Version: 0.14.12 diff --git a/docs/docs/api/v2/engagement/update-account.api.mdx b/docs/docs/api/v2/engagement/update-account.api.mdx index 62bd2aeaa..58153ddad 100644 --- a/docs/docs/api/v2/engagement/update-account.api.mdx +++ b/docs/docs/api/v2/engagement/update-account.api.mdx @@ -5,7 +5,7 @@ description: "Update account" sidebar_label: "Update account" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_account"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"id":1234,"name":"My Company","domain":"mycompany.com","created_at":"2023-02-27T00:00:00Z"}}}}}}},"responses":{"200":{"description":"Account updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update account","method":"patch","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"My Company","domain":"mycompany.com","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.11","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Update account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"updateAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_account"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"id":1234,"name":"My Company","domain":"mycompany.com","created_at":"2023-02-27T00:00:00Z"}}}}}}},"responses":{"200":{"description":"Account updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update account","method":"patch","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"My Company","domain":"mycompany.com","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Update account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/docs/api/v2/engagement/update-contact.api.mdx b/docs/docs/api/v2/engagement/update-contact.api.mdx index 82bf7f4b8..cc06c9e56 100644 --- a/docs/docs/api/v2/engagement/update-contact.api.mdx +++ b/docs/docs/api/v2/engagement/update-contact.api.mdx @@ -5,7 +5,7 @@ description: "Update contact" sidebar_label: "Update contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_contact"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"id":1234,"address":{"city":"San Francisco","country":"USA","street_1":"525 Brannan St","street_2":null,"postalCode":"94107","state":"CA"},"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"workline2"}],"first_name":"George","last_name":"Xing","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z"}}}}}}},"responses":{"200":{"description":"Contact updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update contact","method":"patch","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","job_title":"CEO","address":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.11","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Update contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"updateContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_contact"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"id":1234,"address":{"city":"San Francisco","country":"USA","street_1":"525 Brannan St","street_2":null,"postalCode":"94107","state":"CA"},"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"workline2"}],"first_name":"George","last_name":"Xing","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z"}}}}}}},"responses":{"200":{"description":"Contact updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update contact","method":"patch","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","job_title":"CEO","address":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Update contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/docs/api/v2/enrichment/enrich-person.api.mdx b/docs/docs/api/v2/enrichment/enrich-person.api.mdx index fb4a02eee..28ec53a07 100644 --- a/docs/docs/api/v2/enrichment/enrich-person.api.mdx +++ b/docs/docs/api/v2/enrichment/enrich-person.api.mdx @@ -5,7 +5,7 @@ description: "Enrich person" sidebar_label: "Enrich person" hide_title: true hide_table_of_contents: true -api: {"operationId":"enrichPerson","tags":["Persons"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"PersonEnrichmentData","content":{"application/json":{"schema":{"type":"object","properties":{"company":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"6sense"},"industry":{"type":"string","nullable":true,"example":"Software and Technology"},"annual_revenue":{"type":"number","nullable":true,"example":104000000},"domain":{"type":"string","nullable":true,"example":"6sense.com"},"employee_count":{"type":"number","nullable":true,"example":1192}},"required":["name","industry","annual_revenue","domain","employee_count"],"title":"enriched_company"}},"required":["company"]}}}}},"description":"Enrich person","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"email","in":"query","required":true,"schema":{"type":"string","example":"alicesmith@gmail.com"}}],"method":"get","path":"/persons","servers":[{"url":"https://api.supaglue.io/enrichment/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Enrichment API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Enrichment) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Enrichment](https://docs.supaglue.com/platform/common-schemas/enrichment)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/enrichment/v2\n```\n"},"postman":{"name":"Enrich person","description":{"type":"text/plain"},"url":{"path":["persons"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"email","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"enrichPerson","tags":["Persons"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"PersonEnrichmentData","content":{"application/json":{"schema":{"type":"object","properties":{"company":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"6sense"},"industry":{"type":"string","nullable":true,"example":"Software and Technology"},"annual_revenue":{"type":"number","nullable":true,"example":104000000},"domain":{"type":"string","nullable":true,"example":"6sense.com"},"employee_count":{"type":"number","nullable":true,"example":1192}},"required":["name","industry","annual_revenue","domain","employee_count"],"title":"enriched_company"}},"required":["company"]}}}}},"description":"Enrich person","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"email","in":"query","required":true,"schema":{"type":"string","example":"alicesmith@gmail.com"}}],"method":"get","path":"/persons","servers":[{"url":"https://api.supaglue.io/enrichment/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Enrichment API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Enrichment) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Enrichment](https://docs.supaglue.com/platform/common-schemas/enrichment)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/enrichment/v2\n```\n"},"postman":{"name":"Enrich person","description":{"type":"text/plain"},"url":{"path":["persons"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"email","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/enrichment/unified-enrichment-api custom_edit_url: null diff --git a/docs/docs/api/v2/enrichment/unified-enrichment-api.info.mdx b/docs/docs/api/v2/enrichment/unified-enrichment-api.info.mdx index 9ebc2239c..00e58e27d 100644 --- a/docs/docs/api/v2/enrichment/unified-enrichment-api.info.mdx +++ b/docs/docs/api/v2/enrichment/unified-enrichment-api.info.mdx @@ -13,7 +13,7 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 0.14.11 +Version: 0.14.12 diff --git a/docs/docs/api/v2/mgmt/connection-created.api.mdx b/docs/docs/api/v2/mgmt/connection-created.api.mdx index 2fb21fbe6..ae1730548 100644 --- a/docs/docs/api/v2/mgmt/connection-created.api.mdx +++ b/docs/docs/api/v2/mgmt/connection-created.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the creation of a connection for a customer" sidebar_label: "Customer connection created" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of the creation of a connection for a customer","operationId":"connectionCreated","x-event-type":"connection.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"connection.created","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"salesforce","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["connection.created"],"example":"connection.created"},"customer_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"provider_id":{"type":"string","example":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]}},"required":["webhook_event_type","customer_id","provider_id","category","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"connection.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"connection.created","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"hubspot","result":"SUCCESS"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of the creation of a connection for a customer","operationId":"connectionCreated","x-event-type":"connection.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"connection.created","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"salesforce","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["connection.created"],"example":"connection.created"},"customer_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"provider_id":{"type":"string","example":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]}},"required":["webhook_event_type","customer_id","provider_id","category","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"connection.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"connection.created","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"hubspot","result":"SUCCESS"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/connection-deleted.api.mdx b/docs/docs/api/v2/mgmt/connection-deleted.api.mdx index 2a50cb13b..cf334332b 100644 --- a/docs/docs/api/v2/mgmt/connection-deleted.api.mdx +++ b/docs/docs/api/v2/mgmt/connection-deleted.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the deletion of a connection for a customer" sidebar_label: "Customer connection deleted" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of the deletion of a connection for a customer","operationId":"connectionDeleted","x-event-type":"connection.deleted","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"connection.deleted","connection_id":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"salesforce","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["connection.deleted"],"example":"connection.deleted"},"connection_id":{"type":"string","example":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b"},"customer_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"provider_id":{"type":"string","example":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]}},"required":["webhook_event_type","connection_id","customer_id","provider_id","category","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"connection.deleted"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"connection.deleted","connection_id":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"hubspot","result":"SUCCESS"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of the deletion of a connection for a customer","operationId":"connectionDeleted","x-event-type":"connection.deleted","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"connection.deleted","connection_id":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"salesforce","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["connection.deleted"],"example":"connection.deleted"},"connection_id":{"type":"string","example":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b"},"customer_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"provider_id":{"type":"string","example":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]}},"required":["webhook_event_type","connection_id","customer_id","provider_id","category","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"connection.deleted"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"connection.deleted","connection_id":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"hubspot","result":"SUCCESS"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/create-connection.api.mdx b/docs/docs/api/v2/mgmt/create-connection.api.mdx index 224ba9f7d..766b9b979 100644 --- a/docs/docs/api/v2/mgmt/create-connection.api.mdx +++ b/docs/docs/api/v2/mgmt/create-connection.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint is for providers that use API key or access key for sidebar_label: "Create a connection" hide_title: true hide_table_of_contents: true -api: {"operationId":"createConnection","description":"This endpoint is for providers that use API key or access key for authentication. Please use [Embedded Links](https://docs.supaglue.com/platform/managed-auth#oauth-20) for providers that support Oauth2 for authentication.","tags":["Connections"],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"apollo","properties":{"provider_name":{"type":"string","enum":["apollo"],"example":"apollo"},"type":{"type":"string","enum":["api_key"],"example":"api_key"},"api_key":{"type":"string","description":"API key for the connected customer.","example":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"}},"required":["provider_name","type","api_key"]},{"type":"object","title":"gong","properties":{"provider_name":{"type":"string","enum":["gong"],"example":"gong"},"type":{"type":"string","enum":["access_key_secret"],"example":"access_key_secret"},"access_key":{"type":"string","description":"Access key for the connected customer.","example":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"},"access_key_secret":{"type":"string","description":"Access key secret for the connected customer.","example":"258a80aa-2e9b-40b0-8d7a-28f858a856f3"}},"required":["provider_name","type","access_key","access_key_secret"]},{"type":"object","title":"salesforce","properties":{"provider_name":{"type":"string","enum":["salesforce"],"example":"salesforce"},"type":{"type":"string","enum":["oauth2"],"example":"oauth2"},"refresh_token":{"type":"string"},"instance_url":{"type":"string"},"login_url":{"type":"string"}},"required":["provider_name","type","refresh_token","instance_url"]},{"type":"object","title":"hubspot","properties":{"provider_name":{"type":"string","enum":["hubspot"],"example":"hubspot"},"type":{"type":"string","enum":["oauth2"],"example":"oauth2"},"refresh_token":{"type":"string"}},"required":["provider_name","type","refresh_token"]}]}}}},"responses":{"200":{"description":"Connection created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}}}},"method":"post","path":"/customers/{customer_id}/connections","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"provider_name":"apollo","type":"api_key","api_key":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create a connection","description":{"content":"This endpoint is for providers that use API key or access key for authentication. Please use [Embedded Links](https://docs.supaglue.com/platform/managed-auth#oauth-20) for providers that support Oauth2 for authentication.","type":"text/plain"},"url":{"path":["customers",":customer_id","connections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createConnection","description":"This endpoint is for providers that use API key or access key for authentication. Please use [Embedded Links](https://docs.supaglue.com/platform/managed-auth#oauth-20) for providers that support Oauth2 for authentication.","tags":["Connections"],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"apollo","properties":{"provider_name":{"type":"string","enum":["apollo"],"example":"apollo"},"type":{"type":"string","enum":["api_key"],"example":"api_key"},"api_key":{"type":"string","description":"API key for the connected customer.","example":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"}},"required":["provider_name","type","api_key"]},{"type":"object","title":"gong","properties":{"provider_name":{"type":"string","enum":["gong"],"example":"gong"},"type":{"type":"string","enum":["access_key_secret"],"example":"access_key_secret"},"access_key":{"type":"string","description":"Access key for the connected customer.","example":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"},"access_key_secret":{"type":"string","description":"Access key secret for the connected customer.","example":"258a80aa-2e9b-40b0-8d7a-28f858a856f3"}},"required":["provider_name","type","access_key","access_key_secret"]},{"type":"object","title":"salesforce","properties":{"provider_name":{"type":"string","enum":["salesforce"],"example":"salesforce"},"type":{"type":"string","enum":["oauth2"],"example":"oauth2"},"refresh_token":{"type":"string"},"instance_url":{"type":"string"},"login_url":{"type":"string"}},"required":["provider_name","type","refresh_token","instance_url"]},{"type":"object","title":"hubspot","properties":{"provider_name":{"type":"string","enum":["hubspot"],"example":"hubspot"},"type":{"type":"string","enum":["oauth2"],"example":"oauth2"},"refresh_token":{"type":"string"}},"required":["provider_name","type","refresh_token"]}]}}}},"responses":{"200":{"description":"Connection created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}}}},"method":"post","path":"/customers/{customer_id}/connections","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"provider_name":"apollo","type":"api_key","api_key":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create a connection","description":{"content":"This endpoint is for providers that use API key or access key for authentication. Please use [Embedded Links](https://docs.supaglue.com/platform/managed-auth#oauth-20) for providers that support Oauth2 for authentication.","type":"text/plain"},"url":{"path":["customers",":customer_id","connections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/create-destination.api.mdx b/docs/docs/api/v2/mgmt/create-destination.api.mdx index 5ad708c95..1e2798b4f 100644 --- a/docs/docs/api/v2/mgmt/create-destination.api.mdx +++ b/docs/docs/api/v2/mgmt/create-destination.api.mdx @@ -5,7 +5,7 @@ description: "Create destination" sidebar_label: "Create destination" hide_title: true hide_table_of_contents: true -api: {"operationId":"createDestination","tags":["Destinations"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"postgres","properties":{"type":{"type":"string","enum":["supaglue"],"example":"supaglue"}},"required":["type"]},{"type":"object","title":"postgres","properties":{"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","port","database","schema","user","password"],"title":"postgres_config_unsafe"}},"required":["name","type","config"]},{"type":"object","title":"s3","properties":{"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"},"secret_access_key":{"type":"string","example":"A1lciPB09K2iqNHTLAftxTHy0SKGxNcO4QecAsZS"}},"required":["region","bucket","access_key_id","secret_access_key"],"title":"s3_config_unsafe"}},"required":["name","type","config"]},{"type":"object","title":"bigquery","properties":{"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"},"private_key":{"type":"string","example":"-----BEGIN PRIVATE KEY-----\\nMII..."}},"required":["client_email","private_key"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_unsafe"}},"required":["name","type","config"]},{"type":"object","title":"mongodb","properties":{"name":{"type":"string","example":"My MongoDB Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","database","user","password"],"title":"mongodb_config_unsafe"}},"required":["name","type","config"]}],"title":"create_destination"}}}},"responses":{"201":{"description":"Destination created","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Create destination","method":"post","path":"/destinations","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"type":"supaglue"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create destination","description":{"type":"text/plain"},"url":{"path":["destinations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createDestination","tags":["Destinations"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"postgres","properties":{"type":{"type":"string","enum":["supaglue"],"example":"supaglue"}},"required":["type"]},{"type":"object","title":"postgres","properties":{"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","port","database","schema","user","password"],"title":"postgres_config_unsafe"}},"required":["name","type","config"]},{"type":"object","title":"s3","properties":{"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"},"secret_access_key":{"type":"string","example":"A1lciPB09K2iqNHTLAftxTHy0SKGxNcO4QecAsZS"}},"required":["region","bucket","access_key_id","secret_access_key"],"title":"s3_config_unsafe"}},"required":["name","type","config"]},{"type":"object","title":"bigquery","properties":{"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"},"private_key":{"type":"string","example":"-----BEGIN PRIVATE KEY-----\\nMII..."}},"required":["client_email","private_key"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_unsafe"}},"required":["name","type","config"]},{"type":"object","title":"mongodb","properties":{"name":{"type":"string","example":"My MongoDB Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","database","user","password"],"title":"mongodb_config_unsafe"}},"required":["name","type","config"]}],"title":"create_destination"}}}},"responses":{"201":{"description":"Destination created","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Create destination","method":"post","path":"/destinations","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"type":"supaglue"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create destination","description":{"type":"text/plain"},"url":{"path":["destinations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/create-entity.api.mdx b/docs/docs/api/v2/mgmt/create-entity.api.mdx index 9dc765da8..21d4f7999 100644 --- a/docs/docs/api/v2/mgmt/create-entity.api.mdx +++ b/docs/docs/api/v2/mgmt/create-entity.api.mdx @@ -5,7 +5,7 @@ description: "Create entity" sidebar_label: "Create entity" hide_title: true hide_table_of_contents: true -api: {"operationId":"createEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["name","config"],"title":"create_update_entity"}}}},"responses":{"201":{"description":"Entity created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Create entity","method":"post","path":"/entities","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-entity","config":{"fields":[{"name":"apolla_first_name"}],"allow_additional_field_mappings":true}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create entity","description":{"type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["name","config"],"title":"create_update_entity"}}}},"responses":{"201":{"description":"Entity created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Create entity","method":"post","path":"/entities","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-entity","config":{"fields":[{"name":"apolla_first_name"}],"allow_additional_field_mappings":true}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create entity","description":{"type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/create-magic-link.api.mdx b/docs/docs/api/v2/mgmt/create-magic-link.api.mdx index 4b7e71ed6..e08552501 100644 --- a/docs/docs/api/v2/mgmt/create-magic-link.api.mdx +++ b/docs/docs/api/v2/mgmt/create-magic-link.api.mdx @@ -5,7 +5,7 @@ description: "Create magic link" sidebar_label: "Create magic link" hide_title: true hide_table_of_contents: true -api: {"operationId":"createMagicLink","tags":["Magic Links"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expiration_secs":{"type":"number","example":18000}},"required":["customer_id","provider_name","expiration_secs","return_url"],"title":"create_magic_link"}}}},"responses":{"201":{"description":"Entity created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"ec208408-db29-4705-b39e-4d33070b4ef6"},"status":{"type":"string","example":"created"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"url":{"type":"string","description":"The magic link URL.","example":"https://app.hubspot.com/contacts/123456"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expires_at":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00Z"}},"required":["id","status","application_id","customer_id","provider_id","provider_name","expires_at","url","return_url"],"title":"magic_link"}}}}},"description":"Create magic link","method":"post","path":"/magic_links","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"customer_id":"my-customer-1","provider_name":"hubspot","return_url":"https://app.myapp.com/connections/123456","expiration_secs":18000},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create magic link","description":{"type":"text/plain"},"url":{"path":["magic_links"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createMagicLink","tags":["Magic Links"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expiration_secs":{"type":"number","example":18000}},"required":["customer_id","provider_name","expiration_secs","return_url"],"title":"create_magic_link"}}}},"responses":{"201":{"description":"Entity created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"ec208408-db29-4705-b39e-4d33070b4ef6"},"status":{"type":"string","example":"created"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"url":{"type":"string","description":"The magic link URL.","example":"https://app.hubspot.com/contacts/123456"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expires_at":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00Z"}},"required":["id","status","application_id","customer_id","provider_id","provider_name","expires_at","url","return_url"],"title":"magic_link"}}}}},"description":"Create magic link","method":"post","path":"/magic_links","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"customer_id":"my-customer-1","provider_name":"hubspot","return_url":"https://app.myapp.com/connections/123456","expiration_secs":18000},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create magic link","description":{"type":"text/plain"},"url":{"path":["magic_links"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/create-provider.api.mdx b/docs/docs/api/v2/mgmt/create-provider.api.mdx index 4d55efc82..f4e92f4b8 100644 --- a/docs/docs/api/v2/mgmt/create-provider.api.mdx +++ b/docs/docs/api/v2/mgmt/create-provider.api.mdx @@ -5,7 +5,7 @@ description: "Create provider" sidebar_label: "Create provider" hide_title: true hide_table_of_contents: true -api: {"operationId":"createProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"crm","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"category":{"type":"string","enum":["crm"]},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule"],"title":"provider_name_crm"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"engagement","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"category":{"type":"string","enum":["engagement"]},"name":{"type":"string","enum":["outreach","apollo","salesloft"],"title":"provider_name_engagement"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"no category","properties":{"auth_type":{"type":"string","enum":["api_key"]},"category":{"type":"string","enum":["no_category"]},"name":{"type":"string","enum":["intercom","gong","linear"],"title":"provider_name_no_category"}},"required":["auth_type"]}],"title":"create_provider"}}}},"responses":{"201":{"description":"Provider created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Create provider","method":"post","path":"/providers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"auth_type":"oauth2","config":{"provider_app_id":"my_app_id","use_managed_oauth":true,"oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"objects":{"common":[{"name":"account","schema_id":"328a8cb3-8345-4b02-b661-ee13b4f76806"}],"standard":[{"name":"Account","schema_id":"777ea826-5776-4347-9ece-47bbb17ccdd4"}]},"category":"crm","name":"hubspot"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create provider","description":{"type":"text/plain"},"url":{"path":["providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"crm","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"category":{"type":"string","enum":["crm"]},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule"],"title":"provider_name_crm"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"engagement","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"category":{"type":"string","enum":["engagement"]},"name":{"type":"string","enum":["outreach","apollo","salesloft"],"title":"provider_name_engagement"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"no category","properties":{"auth_type":{"type":"string","enum":["api_key"]},"category":{"type":"string","enum":["no_category"]},"name":{"type":"string","enum":["intercom","gong","linear"],"title":"provider_name_no_category"}},"required":["auth_type"]}],"title":"create_provider"}}}},"responses":{"201":{"description":"Provider created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Create provider","method":"post","path":"/providers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"auth_type":"oauth2","config":{"provider_app_id":"my_app_id","use_managed_oauth":true,"oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"objects":{"common":[{"name":"account","schema_id":"328a8cb3-8345-4b02-b661-ee13b4f76806"}],"standard":[{"name":"Account","schema_id":"777ea826-5776-4347-9ece-47bbb17ccdd4"}]},"category":"crm","name":"hubspot"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create provider","description":{"type":"text/plain"},"url":{"path":["providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/create-schema.api.mdx b/docs/docs/api/v2/mgmt/create-schema.api.mdx index 5817df7a5..64814e635 100644 --- a/docs/docs/api/v2/mgmt/create-schema.api.mdx +++ b/docs/docs/api/v2/mgmt/create-schema.api.mdx @@ -5,7 +5,7 @@ description: "Create schema" sidebar_label: "Create schema" hide_title: true hide_table_of_contents: true -api: {"operationId":"createSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["name","config"],"title":"create_update_schema"}}}},"responses":{"201":{"description":"Schema created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Create schema","method":"post","path":"/schemas","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-schema","config":{"fields":[{"name":"apolla_first_name","mapped_name":"FirstName"}],"allow_additional_field_mappings":false}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create schema","description":{"type":"text/plain"},"url":{"path":["schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["name","config"],"title":"create_update_schema"}}}},"responses":{"201":{"description":"Schema created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Create schema","method":"post","path":"/schemas","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-schema","config":{"fields":[{"name":"apolla_first_name","mapped_name":"FirstName"}],"allow_additional_field_mappings":false}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create schema","description":{"type":"text/plain"},"url":{"path":["schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/create-sync-config.api.mdx b/docs/docs/api/v2/mgmt/create-sync-config.api.mdx index 461e4bd34..b5c66e157 100644 --- a/docs/docs/api/v2/mgmt/create-sync-config.api.mdx +++ b/docs/docs/api/v2/mgmt/create-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Create Sync Config" sidebar_label: "Create Sync Config" hide_title: true hide_table_of_contents: true -api: {"operationId":"createSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["destination_id","provider_id","config"],"title":"create_update_sync_config"}}}},"responses":{"201":{"description":"SyncConfig created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Create Sync Config","method":"post","path":"/sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_id":"6e7baa88-84dd-4dbc-902a-14522c2984eb","provider_id":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af","config":{"default_config":{"period_ms":60000,"strategy":"full then incremental","auto_start_on_connection":true},"common_objects":[{"object":"contact"}],"standard_objects":[{"object":"Contact"}],"entities":[{"entity_id":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}]}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["destination_id","provider_id","config"],"title":"create_update_sync_config"}}}},"responses":{"201":{"description":"SyncConfig created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Create Sync Config","method":"post","path":"/sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_id":"6e7baa88-84dd-4dbc-902a-14522c2984eb","provider_id":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af","config":{"default_config":{"period_ms":60000,"strategy":"full then incremental","auto_start_on_connection":true},"common_objects":[{"object":"contact"}],"standard_objects":[{"object":"Contact"}],"entities":[{"entity_id":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}]}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/delete-connection-sync-config.api.mdx b/docs/docs/api/v2/mgmt/delete-connection-sync-config.api.mdx index d16935257..16dec8b4d 100644 --- a/docs/docs/api/v2/mgmt/delete-connection-sync-config.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-connection-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Delete connection sync config" sidebar_label: "Delete connection sync config" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteConnectionSyncConfig","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Connection Sync Config"}},"description":"Delete connection sync config","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"delete","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete connection sync config","description":{"type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteConnectionSyncConfig","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Connection Sync Config"}},"description":"Delete connection sync config","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"delete","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete connection sync config","description":{"type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/delete-connection.api.mdx b/docs/docs/api/v2/mgmt/delete-connection.api.mdx index de5f9e165..4a9f2bdce 100644 --- a/docs/docs/api/v2/mgmt/delete-connection.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-connection.api.mdx @@ -5,7 +5,7 @@ description: "Delete connection" sidebar_label: "Delete connection" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteConnection","tags":["Connections"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"An empty body is returned on successful deletion."}},"description":"Delete connection","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/customers/{customer_id}/connections/{connection_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete connection","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id","connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"connection_id"}]},"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteConnection","tags":["Connections"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"An empty body is returned on successful deletion."}},"description":"Delete connection","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/customers/{customer_id}/connections/{connection_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete connection","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id","connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"connection_id"}]},"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/delete-customer.api.mdx b/docs/docs/api/v2/mgmt/delete-customer.api.mdx index d642342f0..ee899c495 100644 --- a/docs/docs/api/v2/mgmt/delete-customer.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-customer.api.mdx @@ -5,7 +5,7 @@ description: "Delete customer" sidebar_label: "Delete customer" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Customer","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"},"examples":{"Example":{"value":{"application_id":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69","name":"MyCompany Inc","email":"contact@mycompany.com","customer_id":"your-customers-unique-application-id"}}}}}}},"description":"Delete customer","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","example":"your-customers-unique-application-id"}}],"method":"delete","path":"/customers/{customer_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete customer","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Customer","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"},"examples":{"Example":{"value":{"application_id":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69","name":"MyCompany Inc","email":"contact@mycompany.com","customer_id":"your-customers-unique-application-id"}}}}}}},"description":"Delete customer","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","example":"your-customers-unique-application-id"}}],"method":"delete","path":"/customers/{customer_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete customer","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/delete-entity-mapping.api.mdx b/docs/docs/api/v2/mgmt/delete-entity-mapping.api.mdx index 07cd628f2..577718bae 100644 --- a/docs/docs/api/v2/mgmt/delete-entity-mapping.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-entity-mapping.api.mdx @@ -5,7 +5,7 @@ description: "Delete entity mapping" sidebar_label: "Delete entity mapping" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteEntityMapping","tags":["EntityMappings"],"security":[{"ApiKeyAuth":[]}],"responses":{"204":{"description":"Entity Mapping"}},"description":"Delete entity mapping","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"method":"delete","path":"/entity_mappings/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete entity mapping","description":{"type":"text/plain"},"url":{"path":["entity_mappings",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""}],"method":"DELETE"}} +api: {"operationId":"deleteEntityMapping","tags":["EntityMappings"],"security":[{"ApiKeyAuth":[]}],"responses":{"204":{"description":"Entity Mapping"}},"description":"Delete entity mapping","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"method":"delete","path":"/entity_mappings/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete entity mapping","description":{"type":"text/plain"},"url":{"path":["entity_mappings",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""}],"method":"DELETE"}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/delete-entity.api.mdx b/docs/docs/api/v2/mgmt/delete-entity.api.mdx index 7dfaf8402..520480849 100644 --- a/docs/docs/api/v2/mgmt/delete-entity.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-entity.api.mdx @@ -5,7 +5,7 @@ description: "Delete entity" sidebar_label: "Delete entity" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Delete entity","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Delete entity","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/delete-magic-link.api.mdx b/docs/docs/api/v2/mgmt/delete-magic-link.api.mdx index 1dbef7e83..ce44e50dc 100644 --- a/docs/docs/api/v2/mgmt/delete-magic-link.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-magic-link.api.mdx @@ -5,7 +5,7 @@ description: "Delete magic link" sidebar_label: "Delete magic link" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteMagicLink","tags":["Magic Links"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Magic Link deleted"}},"description":"Delete magic link","parameters":[{"name":"magic_link_id","in":"path","required":true,"schema":{"type":"string","example":"6bf954f9-dba3-4c34-9275-3830dccb0030"}}],"method":"delete","path":"/magic_links/{magic_link_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete magic link","description":{"type":"text/plain"},"url":{"path":["magic_links",":magic_link_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"magic_link_id"}]},"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteMagicLink","tags":["Magic Links"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Magic Link deleted"}},"description":"Delete magic link","parameters":[{"name":"magic_link_id","in":"path","required":true,"schema":{"type":"string","example":"6bf954f9-dba3-4c34-9275-3830dccb0030"}}],"method":"delete","path":"/magic_links/{magic_link_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete magic link","description":{"type":"text/plain"},"url":{"path":["magic_links",":magic_link_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"magic_link_id"}]},"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/delete-provider.api.mdx b/docs/docs/api/v2/mgmt/delete-provider.api.mdx index 3dfa92727..78dd190b8 100644 --- a/docs/docs/api/v2/mgmt/delete-provider.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-provider.api.mdx @@ -5,7 +5,7 @@ description: "Delete provider" sidebar_label: "Delete provider" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Delete provider","parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Delete provider","parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/delete-schema.api.mdx b/docs/docs/api/v2/mgmt/delete-schema.api.mdx index c767f3cd3..78630369f 100644 --- a/docs/docs/api/v2/mgmt/delete-schema.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-schema.api.mdx @@ -5,7 +5,7 @@ description: "Delete schema" sidebar_label: "Delete schema" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"deleteSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Delete schema","parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"method":"delete","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"deleteSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Delete schema","parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"method":"delete","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/delete-sync-config.api.mdx b/docs/docs/api/v2/mgmt/delete-sync-config.api.mdx index 57d48c59c..66cfeee7b 100644 --- a/docs/docs/api/v2/mgmt/delete-sync-config.api.mdx +++ b/docs/docs/api/v2/mgmt/delete-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Delete Sync Config" sidebar_label: "Delete Sync Config" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Delete Sync Config","parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"method":"delete","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Delete Sync Config","parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"method":"delete","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/entity-entity-mapping-created.api.mdx b/docs/docs/api/v2/mgmt/entity-entity-mapping-created.api.mdx index 1d71db8dd..18785ed75 100644 --- a/docs/docs/api/v2/mgmt/entity-entity-mapping-created.api.mdx +++ b/docs/docs/api/v2/mgmt/entity-entity-mapping-created.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the creation of an entity mapping" sidebar_label: "Entity mapping created" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of the creation of an entity mapping","operationId":"entityEntityMappingCreated","x-event-type":"entity.entity_mapping.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.created","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.created"],"example":"entity.entity_mapping.created"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.created","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of the creation of an entity mapping","operationId":"entityEntityMappingCreated","x-event-type":"entity.entity_mapping.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.created","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.created"],"example":"entity.entity_mapping.created"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.created","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx b/docs/docs/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx index 19da83760..9191705ba 100644 --- a/docs/docs/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx +++ b/docs/docs/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the deletion of an entity mapping" sidebar_label: "Entity mapping deleted" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of the deletion of an entity mapping","operationId":"entityEntityMappingDeleted","x-event-type":"entity.entity_mapping.deleted","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.deleted","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.deleted"],"example":"entity.entity_mapping.deleted"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.deleted"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.deleted","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of the deletion of an entity mapping","operationId":"entityEntityMappingDeleted","x-event-type":"entity.entity_mapping.deleted","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.deleted","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.deleted"],"example":"entity.entity_mapping.deleted"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.deleted"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.deleted","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/entity-entity-mapping-updated.api.mdx b/docs/docs/api/v2/mgmt/entity-entity-mapping-updated.api.mdx index 4645fd86c..def691b3e 100644 --- a/docs/docs/api/v2/mgmt/entity-entity-mapping-updated.api.mdx +++ b/docs/docs/api/v2/mgmt/entity-entity-mapping-updated.api.mdx @@ -5,7 +5,7 @@ description: "Notification of an update to an entity mapping" sidebar_label: "Entity mapping updated" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of an update to an entity mapping","operationId":"entityEntityMappingUpdated","x-event-type":"entity.entity_mapping.updated","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.updated","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.updated"],"example":"entity.entity_mapping.updated"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.updated"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.updated","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of an update to an entity mapping","operationId":"entityEntityMappingUpdated","x-event-type":"entity.entity_mapping.updated","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.updated","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.updated"],"example":"entity.entity_mapping.updated"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.updated"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.updated","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-connection-sync-config.api.mdx b/docs/docs/api/v2/mgmt/get-connection-sync-config.api.mdx index db0d380fd..2817ee8f0 100644 --- a/docs/docs/api/v2/mgmt/get-connection-sync-config.api.mdx +++ b/docs/docs/api/v2/mgmt/get-connection-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Get connection sync config" sidebar_label: "Get connection sync config" hide_title: true hide_table_of_contents: true -api: {"operationId":"getConnectionSyncConfig","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"Connection Sync Config","content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"oneOf":[{"description":"Config specific to postgres destination","type":"object","title":"postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to bigquery destination","type":"object","title":"bigquery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the bigquery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"custom_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name (case sensitive)","example":"Contact__c"}},"required":["object"]}}},"title":"connection_sync_config"}}}}},"description":"Get connection sync config","method":"get","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get connection sync config","description":{"type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getConnectionSyncConfig","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"Connection Sync Config","content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"oneOf":[{"description":"Config specific to postgres destination","type":"object","title":"postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to bigquery destination","type":"object","title":"bigquery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the bigquery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"custom_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name (case sensitive)","example":"Contact__c"}},"required":["object"]}}},"title":"connection_sync_config"}}}}},"description":"Get connection sync config","method":"get","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get connection sync config","description":{"type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-connection.api.mdx b/docs/docs/api/v2/mgmt/get-connection.api.mdx index d1d6e5230..2eedcc1fe 100644 --- a/docs/docs/api/v2/mgmt/get-connection.api.mdx +++ b/docs/docs/api/v2/mgmt/get-connection.api.mdx @@ -5,7 +5,7 @@ description: "Get connection" sidebar_label: "Get connection" hide_title: true hide_table_of_contents: true -api: {"operationId":"getConnection","tags":["Connections"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Connection","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"},{"type":"object","properties":{"user_id":{"type":"string","description":"The id of the user associated with this connection. This is sometimes also known as the owner."}}}]}}}}},"description":"Get connection","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/customers/{customer_id}/connections/{connection_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get connection","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id","connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"connection_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getConnection","tags":["Connections"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Connection","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"},{"type":"object","properties":{"user_id":{"type":"string","description":"The id of the user associated with this connection. This is sometimes also known as the owner."}}}]}}}}},"description":"Get connection","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/customers/{customer_id}/connections/{connection_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get connection","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id","connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"connection_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-connections.api.mdx b/docs/docs/api/v2/mgmt/get-connections.api.mdx index 1cab19c6a..6170a7093 100644 --- a/docs/docs/api/v2/mgmt/get-connections.api.mdx +++ b/docs/docs/api/v2/mgmt/get-connections.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of connections" sidebar_label: "List connections" hide_title: true hide_table_of_contents: true -api: {"operationId":"getConnections","tags":["Connections"],"security":[{"x-api-key":[]}],"description":"Get a list of connections","responses":{"200":{"description":"Connections","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}}}}},"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/customers/{customer_id}/connections","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List connections","description":{"content":"Get a list of connections","type":"text/plain"},"url":{"path":["customers",":customer_id","connections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getConnections","tags":["Connections"],"security":[{"x-api-key":[]}],"description":"Get a list of connections","responses":{"200":{"description":"Connections","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}}}}},"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/customers/{customer_id}/connections","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List connections","description":{"content":"Get a list of connections","type":"text/plain"},"url":{"path":["customers",":customer_id","connections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-customer.api.mdx b/docs/docs/api/v2/mgmt/get-customer.api.mdx index 27d48ae6f..f5f0be9c9 100644 --- a/docs/docs/api/v2/mgmt/get-customer.api.mdx +++ b/docs/docs/api/v2/mgmt/get-customer.api.mdx @@ -5,7 +5,7 @@ description: "Get customer" sidebar_label: "Get customer" hide_title: true hide_table_of_contents: true -api: {"operationId":"getCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Customer","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"},"examples":{"Example":{"value":{"application_id":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69","name":"MyCompany Inc","email":"contact@mycompany.com","customer_id":"your-customers-unique-application-id"}}}}}}},"description":"Get customer","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","example":"your-customers-unique-application-id"}}],"method":"get","path":"/customers/{customer_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get customer","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Customer","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"},"examples":{"Example":{"value":{"application_id":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69","name":"MyCompany Inc","email":"contact@mycompany.com","customer_id":"your-customers-unique-application-id"}}}}}}},"description":"Get customer","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","example":"your-customers-unique-application-id"}}],"method":"get","path":"/customers/{customer_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get customer","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-customers.api.mdx b/docs/docs/api/v2/mgmt/get-customers.api.mdx index 541261d54..c28e6b25f 100644 --- a/docs/docs/api/v2/mgmt/get-customers.api.mdx +++ b/docs/docs/api/v2/mgmt/get-customers.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of customers" sidebar_label: "List customers" hide_title: true hide_table_of_contents: true -api: {"operationId":"getCustomers","tags":["Customers"],"security":[{"x-api-key":[]}],"description":"Get a list of customers","responses":{"200":{"description":"Customers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"}}}}}},"method":"get","path":"/customers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List customers","description":{"content":"Get a list of customers","type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getCustomers","tags":["Customers"],"security":[{"x-api-key":[]}],"description":"Get a list of customers","responses":{"200":{"description":"Customers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"}}}}}},"method":"get","path":"/customers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List customers","description":{"content":"Get a list of customers","type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-destination.api.mdx b/docs/docs/api/v2/mgmt/get-destination.api.mdx index 6ac55857e..bbd8d9543 100644 --- a/docs/docs/api/v2/mgmt/get-destination.api.mdx +++ b/docs/docs/api/v2/mgmt/get-destination.api.mdx @@ -5,7 +5,7 @@ description: "Get destination" sidebar_label: "Get destination" hide_title: true hide_table_of_contents: true -api: {"operationId":"getDestination","tags":["Destinations"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Destination","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Get destination","parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/destinations/{destination_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get destination","description":{"type":"text/plain"},"url":{"path":["destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"destination_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getDestination","tags":["Destinations"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Destination","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Get destination","parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/destinations/{destination_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get destination","description":{"type":"text/plain"},"url":{"path":["destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"destination_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-destinations.api.mdx b/docs/docs/api/v2/mgmt/get-destinations.api.mdx index e8dba82a8..d961e42ab 100644 --- a/docs/docs/api/v2/mgmt/get-destinations.api.mdx +++ b/docs/docs/api/v2/mgmt/get-destinations.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of destinations" sidebar_label: "List destinations" hide_title: true hide_table_of_contents: true -api: {"operationId":"getDestinations","tags":["Destinations"],"security":[{"x-api-key":[]}],"description":"Get a list of destinations","responses":{"200":{"description":"Destinations","content":{"application/json":{"schema":{"type":"array","items":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"},"example":[{"id":"0a292508-d254-4929-98d3-dc23416efff8","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My S3 Destination","type":"s3","config":{"region":"us-west-2","bucket":"my-bucket","access_key_id":"MY_ACCESS_KEY_ID"}},{"id":"92bc3460-a301-4116-8d1f-6e5f8252c2e2","application_id":"9b9a31bb-9fe4-4fa5-ba84-4c035a27f258","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"my_database","schema":"public","user":"user","password":"password"}}]}}}}},"method":"get","path":"/destinations","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List destinations","description":{"content":"Get a list of destinations","type":"text/plain"},"url":{"path":["destinations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getDestinations","tags":["Destinations"],"security":[{"x-api-key":[]}],"description":"Get a list of destinations","responses":{"200":{"description":"Destinations","content":{"application/json":{"schema":{"type":"array","items":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"},"example":[{"id":"0a292508-d254-4929-98d3-dc23416efff8","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My S3 Destination","type":"s3","config":{"region":"us-west-2","bucket":"my-bucket","access_key_id":"MY_ACCESS_KEY_ID"}},{"id":"92bc3460-a301-4116-8d1f-6e5f8252c2e2","application_id":"9b9a31bb-9fe4-4fa5-ba84-4c035a27f258","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"my_database","schema":"public","user":"user","password":"password"}}]}}}}},"method":"get","path":"/destinations","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List destinations","description":{"content":"Get a list of destinations","type":"text/plain"},"url":{"path":["destinations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-entities.api.mdx b/docs/docs/api/v2/mgmt/get-entities.api.mdx index 999fffa11..e16f1bc6e 100644 --- a/docs/docs/api/v2/mgmt/get-entities.api.mdx +++ b/docs/docs/api/v2/mgmt/get-entities.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of entities" sidebar_label: "List entities" hide_title: true hide_table_of_contents: true -api: {"operationId":"getEntities","tags":["Entities"],"security":[{"x-api-key":[]}],"description":"Get a list of entities","responses":{"200":{"description":"Entities","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}}},"method":"get","path":"/entities","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List entities","description":{"content":"Get a list of entities","type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getEntities","tags":["Entities"],"security":[{"x-api-key":[]}],"description":"Get a list of entities","responses":{"200":{"description":"Entities","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}}},"method":"get","path":"/entities","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List entities","description":{"content":"Get a list of entities","type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-entity.api.mdx b/docs/docs/api/v2/mgmt/get-entity.api.mdx index a773f7c4b..386837331 100644 --- a/docs/docs/api/v2/mgmt/get-entity.api.mdx +++ b/docs/docs/api/v2/mgmt/get-entity.api.mdx @@ -5,7 +5,7 @@ description: "Get entity" sidebar_label: "Get entity" hide_title: true hide_table_of_contents: true -api: {"operationId":"getEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Get entity","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Get entity","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-magic-links.api.mdx b/docs/docs/api/v2/mgmt/get-magic-links.api.mdx index 5bccd595c..091513d7c 100644 --- a/docs/docs/api/v2/mgmt/get-magic-links.api.mdx +++ b/docs/docs/api/v2/mgmt/get-magic-links.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of magic links" sidebar_label: "List magic links" hide_title: true hide_table_of_contents: true -api: {"operationId":"getMagicLinks","tags":["Magic Links"],"security":[{"x-api-key":[]}],"description":"Get a list of magic links","responses":{"200":{"description":"Magic Links","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ec208408-db29-4705-b39e-4d33070b4ef6"},"status":{"type":"string","example":"created"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"url":{"type":"string","description":"The magic link URL.","example":"https://app.hubspot.com/contacts/123456"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expires_at":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00Z"}},"required":["id","status","application_id","customer_id","provider_id","provider_name","expires_at","url","return_url"],"title":"magic_link"}}}}}},"method":"get","path":"/magic_links","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List magic links","description":{"content":"Get a list of magic links","type":"text/plain"},"url":{"path":["magic_links"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getMagicLinks","tags":["Magic Links"],"security":[{"x-api-key":[]}],"description":"Get a list of magic links","responses":{"200":{"description":"Magic Links","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ec208408-db29-4705-b39e-4d33070b4ef6"},"status":{"type":"string","example":"created"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"url":{"type":"string","description":"The magic link URL.","example":"https://app.hubspot.com/contacts/123456"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expires_at":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00Z"}},"required":["id","status","application_id","customer_id","provider_id","provider_name","expires_at","url","return_url"],"title":"magic_link"}}}}}},"method":"get","path":"/magic_links","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List magic links","description":{"content":"Get a list of magic links","type":"text/plain"},"url":{"path":["magic_links"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-provider-user-id.api.mdx b/docs/docs/api/v2/mgmt/get-provider-user-id.api.mdx index 6c2ed5ef6..cc639cded 100644 --- a/docs/docs/api/v2/mgmt/get-provider-user-id.api.mdx +++ b/docs/docs/api/v2/mgmt/get-provider-user-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint returns the ID of the logged in user (this is someti sidebar_label: "Get logged in user ID and details" hide_title: true hide_table_of_contents: true -api: {"operationId":"getProviderUserId","description":"This endpoint returns the ID of the logged in user (this is sometimes known as the owner ID) and details.","tags":["Connections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"provider_name","in":"query","required":true,"schema":{"type":"string","enum":["hubspot","ms_dynamics_365_sales","intercom"],"example":"hubspot"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"UserId","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of the logged in user. The ID originates from your customer's third-party Provider."},"raw_details":{"type":"object","additionalProperties":true,"description":"The raw data from the your customer's third-party Provider."}},"example":{"user_id":"70115e3c-2700-4112-b28f-2706e08570e6","raw_details":{"user_id":"70115e3c-2700-4112-b28f-2706e08570e6","user":"test@something.com","scopes":["contacts","automation","oauth"]}}}}}}},"method":"get","path":"/customers/{customer_id}/connections/_provider_user_id","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get logged in user ID and details","description":{"content":"This endpoint returns the ID of the logged in user (this is sometimes known as the owner ID) and details.","type":"text/plain"},"url":{"path":["customers",":customer_id","connections","_provider_user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"provider_name","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getProviderUserId","description":"This endpoint returns the ID of the logged in user (this is sometimes known as the owner ID) and details.","tags":["Connections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"provider_name","in":"query","required":true,"schema":{"type":"string","enum":["hubspot","ms_dynamics_365_sales","intercom"],"example":"hubspot"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"UserId","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of the logged in user. The ID originates from your customer's third-party Provider."},"raw_details":{"type":"object","additionalProperties":true,"description":"The raw data from the your customer's third-party Provider."}},"example":{"user_id":"70115e3c-2700-4112-b28f-2706e08570e6","raw_details":{"user_id":"70115e3c-2700-4112-b28f-2706e08570e6","user":"test@something.com","scopes":["contacts","automation","oauth"]}}}}}}},"method":"get","path":"/customers/{customer_id}/connections/_provider_user_id","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get logged in user ID and details","description":{"content":"This endpoint returns the ID of the logged in user (this is sometimes known as the owner ID) and details.","type":"text/plain"},"url":{"path":["customers",":customer_id","connections","_provider_user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"provider_name","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-provider.api.mdx b/docs/docs/api/v2/mgmt/get-provider.api.mdx index 24ee946ec..75c9b55ce 100644 --- a/docs/docs/api/v2/mgmt/get-provider.api.mdx +++ b/docs/docs/api/v2/mgmt/get-provider.api.mdx @@ -5,7 +5,7 @@ description: "Get provider" sidebar_label: "Get provider" hide_title: true hide_table_of_contents: true -api: {"operationId":"getProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Get provider","parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Get provider","parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-providers.api.mdx b/docs/docs/api/v2/mgmt/get-providers.api.mdx index dba624b11..647119ccb 100644 --- a/docs/docs/api/v2/mgmt/get-providers.api.mdx +++ b/docs/docs/api/v2/mgmt/get-providers.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of providers" sidebar_label: "List providers" hide_title: true hide_table_of_contents: true -api: {"operationId":"getProviders","tags":["Providers"],"security":[{"x-api-key":[]}],"description":"Get a list of providers","responses":{"200":{"description":"Providers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}}},"method":"get","path":"/providers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List providers","description":{"content":"Get a list of providers","type":"text/plain"},"url":{"path":["providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getProviders","tags":["Providers"],"security":[{"x-api-key":[]}],"description":"Get a list of providers","responses":{"200":{"description":"Providers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}}},"method":"get","path":"/providers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List providers","description":{"content":"Get a list of providers","type":"text/plain"},"url":{"path":["providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-schema.api.mdx b/docs/docs/api/v2/mgmt/get-schema.api.mdx index e05c6a01f..de2bc65e6 100644 --- a/docs/docs/api/v2/mgmt/get-schema.api.mdx +++ b/docs/docs/api/v2/mgmt/get-schema.api.mdx @@ -5,7 +5,7 @@ description: "Get schema" sidebar_label: "Get schema" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"getSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Get schema","parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"method":"get","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"getSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Get schema","parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"method":"get","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-schemas.api.mdx b/docs/docs/api/v2/mgmt/get-schemas.api.mdx index 4ff6dc4e1..7ef06b63a 100644 --- a/docs/docs/api/v2/mgmt/get-schemas.api.mdx +++ b/docs/docs/api/v2/mgmt/get-schemas.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of schemas" sidebar_label: "List schemas" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"getSchemas","tags":["Schemas"],"security":[{"x-api-key":[]}],"description":"Get a list of schemas","responses":{"200":{"description":"Schemas","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}}},"method":"get","path":"/schemas","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List schemas","description":{"content":"Get a list of schemas","type":"text/plain"},"url":{"path":["schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"getSchemas","tags":["Schemas"],"security":[{"x-api-key":[]}],"description":"Get a list of schemas","responses":{"200":{"description":"Schemas","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}}},"method":"get","path":"/schemas","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List schemas","description":{"content":"Get a list of schemas","type":"text/plain"},"url":{"path":["schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-sync-config.api.mdx b/docs/docs/api/v2/mgmt/get-sync-config.api.mdx index ce4f85b9f..92e61423d 100644 --- a/docs/docs/api/v2/mgmt/get-sync-config.api.mdx +++ b/docs/docs/api/v2/mgmt/get-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Get Sync Config" sidebar_label: "Get Sync Config" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Get Sync Config","parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"method":"get","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Get Sync Config","parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"method":"get","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-sync-configs.api.mdx b/docs/docs/api/v2/mgmt/get-sync-configs.api.mdx index 53b0d5f84..9490d97f6 100644 --- a/docs/docs/api/v2/mgmt/get-sync-configs.api.mdx +++ b/docs/docs/api/v2/mgmt/get-sync-configs.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of Sync Configs" sidebar_label: "List Sync Configs" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSyncConfigs","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"description":"Get a list of Sync Configs","responses":{"200":{"description":"SyncConfigs","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}}},"method":"get","path":"/sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List Sync Configs","description":{"content":"Get a list of Sync Configs","type":"text/plain"},"url":{"path":["sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSyncConfigs","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"description":"Get a list of Sync Configs","responses":{"200":{"description":"SyncConfigs","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}}},"method":"get","path":"/sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List Sync Configs","description":{"content":"Get a list of Sync Configs","type":"text/plain"},"url":{"path":["sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-sync-runs.api.mdx b/docs/docs/api/v2/mgmt/get-sync-runs.api.mdx index b306ef37b..82f7fce3a 100644 --- a/docs/docs/api/v2/mgmt/get-sync-runs.api.mdx +++ b/docs/docs/api/v2/mgmt/get-sync-runs.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of SyncRuns." sidebar_label: "Get SyncRuns" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSyncRuns","tags":["SyncRuns"],"security":[{"x-api-key":[]}],"description":"Get a list of SyncRuns.","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page"},{"name":"customer_id","in":"query","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application"},{"name":"provider_name","in":"query","schema":{"type":"string","example":"salesforce"},"description":"The provider name"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["common","standard","custom"],"example":"standard"}},{"name":"object","in":"query","schema":{"type":"string","example":"account"},"description":"The object to filter by"},{"name":"entity_id","in":"query","schema":{"type":"string","example":"e74b5a4f-f252-4a6c-940c-f35873498543"},"description":"The entity id to filter by"},{"name":"status","in":"query","schema":{"type":"string","example":"SUCCESS"},"description":"The status to filter by (case-insensitive)"},{"name":"start_timestamp","in":"query","schema":{"type":"string","example":">2021-01-06T03:24:53.434326Z"},"description":"The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp."},{"name":"end_timestamp","in":"query","schema":{"type":"string","example":">2021-01-06T03:24:53.434326Z"},"description":"The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp."}],"responses":{"200":{"description":"SyncRun","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"]},"object":{"type":"string"},"error_message":{"type":"string","nullable":true},"start_timestamp":{"type":"string","example":"2023-02-22T19:55:17.559Z"},"end_timestamp":{"type":"string","nullable":true,"example":"2023-02-22T20:55:17.559Z"},"application_id":{"type":"string","example":"974125fa-ffb6-47fc-b12f-44c566fc5da1"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"status":{"type":"string","enum":["SUCCESS","IN_PROGRESS","FAILURE"]},"num_records_synced":{"type":"number","nullable":true,"example":100}},"required":["object_type","object","start_timestamp","end_timestamp","application_id","customer_id","status","error_message","provider_name","category","connection_id","num_records_synced"]},{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string"},"error_message":{"type":"string","nullable":true},"start_timestamp":{"type":"string","example":"2023-02-22T19:55:17.559Z"},"end_timestamp":{"type":"string","nullable":true,"example":"2023-02-22T20:55:17.559Z"},"application_id":{"type":"string","example":"974125fa-ffb6-47fc-b12f-44c566fc5da1"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"status":{"type":"string","enum":["SUCCESS","IN_PROGRESS","FAILURE"]},"num_records_synced":{"type":"number","nullable":true,"example":100}},"required":["entity_id","start_timestamp","end_timestamp","application_id","customer_id","status","error_message","provider_name","category","connection_id","num_records_synced"]}],"title":"sync_run"}}}}]}}}}},"method":"get","path":"/sync-runs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get SyncRuns","description":{"content":"Get a list of SyncRuns.","type":"text/plain"},"url":{"path":["sync-runs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"Number of results to return per page","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"customer_id","value":""},{"disabled":false,"description":{"content":"The provider name","type":"text/plain"},"key":"provider_name","value":""},{"disabled":false,"key":"object_type","value":""},{"disabled":false,"description":{"content":"The object to filter by","type":"text/plain"},"key":"object","value":""},{"disabled":false,"description":{"content":"The entity id to filter by","type":"text/plain"},"key":"entity_id","value":""},{"disabled":false,"description":{"content":"The status to filter by (case-insensitive)","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp.","type":"text/plain"},"key":"start_timestamp","value":""},{"disabled":false,"description":{"content":"The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp.","type":"text/plain"},"key":"end_timestamp","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSyncRuns","tags":["SyncRuns"],"security":[{"x-api-key":[]}],"description":"Get a list of SyncRuns.","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page"},{"name":"customer_id","in":"query","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application"},{"name":"provider_name","in":"query","schema":{"type":"string","example":"salesforce"},"description":"The provider name"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["common","standard","custom"],"example":"standard"}},{"name":"object","in":"query","schema":{"type":"string","example":"account"},"description":"The object to filter by"},{"name":"entity_id","in":"query","schema":{"type":"string","example":"e74b5a4f-f252-4a6c-940c-f35873498543"},"description":"The entity id to filter by"},{"name":"status","in":"query","schema":{"type":"string","example":"SUCCESS"},"description":"The status to filter by (case-insensitive)"},{"name":"start_timestamp","in":"query","schema":{"type":"string","example":">2021-01-06T03:24:53.434326Z"},"description":"The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp."},{"name":"end_timestamp","in":"query","schema":{"type":"string","example":">2021-01-06T03:24:53.434326Z"},"description":"The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp."}],"responses":{"200":{"description":"SyncRun","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"]},"object":{"type":"string"},"error_message":{"type":"string","nullable":true},"start_timestamp":{"type":"string","example":"2023-02-22T19:55:17.559Z"},"end_timestamp":{"type":"string","nullable":true,"example":"2023-02-22T20:55:17.559Z"},"application_id":{"type":"string","example":"974125fa-ffb6-47fc-b12f-44c566fc5da1"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"status":{"type":"string","enum":["SUCCESS","IN_PROGRESS","FAILURE"]},"num_records_synced":{"type":"number","nullable":true,"example":100}},"required":["object_type","object","start_timestamp","end_timestamp","application_id","customer_id","status","error_message","provider_name","category","connection_id","num_records_synced"]},{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string"},"error_message":{"type":"string","nullable":true},"start_timestamp":{"type":"string","example":"2023-02-22T19:55:17.559Z"},"end_timestamp":{"type":"string","nullable":true,"example":"2023-02-22T20:55:17.559Z"},"application_id":{"type":"string","example":"974125fa-ffb6-47fc-b12f-44c566fc5da1"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"status":{"type":"string","enum":["SUCCESS","IN_PROGRESS","FAILURE"]},"num_records_synced":{"type":"number","nullable":true,"example":100}},"required":["entity_id","start_timestamp","end_timestamp","application_id","customer_id","status","error_message","provider_name","category","connection_id","num_records_synced"]}],"title":"sync_run"}}}}]}}}}},"method":"get","path":"/sync-runs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get SyncRuns","description":{"content":"Get a list of SyncRuns.","type":"text/plain"},"url":{"path":["sync-runs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"Number of results to return per page","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"customer_id","value":""},{"disabled":false,"description":{"content":"The provider name","type":"text/plain"},"key":"provider_name","value":""},{"disabled":false,"key":"object_type","value":""},{"disabled":false,"description":{"content":"The object to filter by","type":"text/plain"},"key":"object","value":""},{"disabled":false,"description":{"content":"The entity id to filter by","type":"text/plain"},"key":"entity_id","value":""},{"disabled":false,"description":{"content":"The status to filter by (case-insensitive)","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp.","type":"text/plain"},"key":"start_timestamp","value":""},{"disabled":false,"description":{"content":"The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp.","type":"text/plain"},"key":"end_timestamp","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/get-syncs.api.mdx b/docs/docs/api/v2/mgmt/get-syncs.api.mdx index ea5a562e1..1ac0c5fec 100644 --- a/docs/docs/api/v2/mgmt/get-syncs.api.mdx +++ b/docs/docs/api/v2/mgmt/get-syncs.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of Syncs." sidebar_label: "Get Syncs" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSyncs","tags":["Syncs"],"security":[{"x-api-key":[]}],"description":"Get a list of Syncs.","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page"},{"name":"customer_id","in":"query","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application"},{"name":"provider_name","in":"query","schema":{"type":"string","example":"salesforce"},"description":"The provider name"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"description":"The object type to filter by"},{"name":"object","in":"query","schema":{"type":"string","example":"contact"},"description":"The object to filter by"},{"name":"entity_id","in":"query","schema":{"type":"string","example":"e74b5a4f-f252-4a6c-940c-f35873498543"},"description":"The entity id to filter by"}],"responses":{"200":{"description":"Sync","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"971cb76d-9558-42fe-8f3b-8a531c32bd5f"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"70da3830-b717-49cb-91f0-22fb3f09a97a"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false},"provider_name":{"type":"string","example":"hubspot"},"customer_id":{"type":"string","example":"my-customer-1"}},"required":["id","type","entity_id","connection_id","sync_config_id","paused","provider_name","customer_id"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"971cb76d-9558-42fe-8f3b-8a531c32bd5f"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false},"provider_name":{"type":"string","example":"hubspot"},"customer_id":{"type":"string","example":"my-customer-1"}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused","provider_name","customer_id"]}],"title":"sync_with_provider_and_customer"}}}}]}}}}},"method":"get","path":"/syncs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get Syncs","description":{"content":"Get a list of Syncs.","type":"text/plain"},"url":{"path":["syncs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"Number of results to return per page","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"customer_id","value":""},{"disabled":false,"description":{"content":"The provider name","type":"text/plain"},"key":"provider_name","value":""},{"disabled":false,"description":{"content":"The object type to filter by","type":"text/plain"},"key":"object_type","value":""},{"disabled":false,"description":{"content":"The object to filter by","type":"text/plain"},"key":"object","value":""},{"disabled":false,"description":{"content":"The entity id to filter by","type":"text/plain"},"key":"entity_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSyncs","tags":["Syncs"],"security":[{"x-api-key":[]}],"description":"Get a list of Syncs.","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page"},{"name":"customer_id","in":"query","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application"},{"name":"provider_name","in":"query","schema":{"type":"string","example":"salesforce"},"description":"The provider name"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"description":"The object type to filter by"},{"name":"object","in":"query","schema":{"type":"string","example":"contact"},"description":"The object to filter by"},{"name":"entity_id","in":"query","schema":{"type":"string","example":"e74b5a4f-f252-4a6c-940c-f35873498543"},"description":"The entity id to filter by"}],"responses":{"200":{"description":"Sync","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"971cb76d-9558-42fe-8f3b-8a531c32bd5f"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"70da3830-b717-49cb-91f0-22fb3f09a97a"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false},"provider_name":{"type":"string","example":"hubspot"},"customer_id":{"type":"string","example":"my-customer-1"}},"required":["id","type","entity_id","connection_id","sync_config_id","paused","provider_name","customer_id"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"971cb76d-9558-42fe-8f3b-8a531c32bd5f"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false},"provider_name":{"type":"string","example":"hubspot"},"customer_id":{"type":"string","example":"my-customer-1"}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused","provider_name","customer_id"]}],"title":"sync_with_provider_and_customer"}}}}]}}}}},"method":"get","path":"/syncs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get Syncs","description":{"content":"Get a list of Syncs.","type":"text/plain"},"url":{"path":["syncs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"Number of results to return per page","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"customer_id","value":""},{"disabled":false,"description":{"content":"The provider name","type":"text/plain"},"key":"provider_name","value":""},{"disabled":false,"description":{"content":"The object type to filter by","type":"text/plain"},"key":"object_type","value":""},{"disabled":false,"description":{"content":"The object to filter by","type":"text/plain"},"key":"object","value":""},{"disabled":false,"description":{"content":"The entity id to filter by","type":"text/plain"},"key":"entity_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/list-entity-mappings.api.mdx b/docs/docs/api/v2/mgmt/list-entity-mappings.api.mdx index 8df147cef..a520634ba 100644 --- a/docs/docs/api/v2/mgmt/list-entity-mappings.api.mdx +++ b/docs/docs/api/v2/mgmt/list-entity-mappings.api.mdx @@ -5,7 +5,7 @@ description: "List entity mappings." sidebar_label: "List entity mappings." hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"listEntityMappings","tags":["EntityMappings"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of entity mappings","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string"},"entity_name":{"type":"string"},"allow_additional_field_mappings":{"type":"boolean"},"object":{"allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},{"type":"object","properties":{"from":{"type":"string","enum":["developer","customer"]}},"required":["from"]}]},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string"},"mapped_field":{"type":"string"},"from":{"type":"string","enum":["developer","customer"]},"is_additional":{"type":"boolean"}},"required":["entity_field","is_additional"]}}},"required":["entity_id","entity_name","allow_additional_field_mappings","field_mappings"],"title":"merged_entity_mapping"}}}}}},"description":"List entity mappings.","method":"get","path":"/entity_mappings","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List entity mappings.","description":{"type":"text/plain"},"url":{"path":["entity_mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"deprecated":true,"operationId":"listEntityMappings","tags":["EntityMappings"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of entity mappings","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string"},"entity_name":{"type":"string"},"allow_additional_field_mappings":{"type":"boolean"},"object":{"allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},{"type":"object","properties":{"from":{"type":"string","enum":["developer","customer"]}},"required":["from"]}]},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string"},"mapped_field":{"type":"string"},"from":{"type":"string","enum":["developer","customer"]},"is_additional":{"type":"boolean"}},"required":["entity_field","is_additional"]}}},"required":["entity_id","entity_name","allow_additional_field_mappings","field_mappings"],"title":"merged_entity_mapping"}}}}}},"description":"List entity mappings.","method":"get","path":"/entity_mappings","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List entity mappings.","description":{"type":"text/plain"},"url":{"path":["entity_mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/list-field-mappings.api.mdx b/docs/docs/api/v2/mgmt/list-field-mappings.api.mdx index 34b7187b5..b187459f3 100644 --- a/docs/docs/api/v2/mgmt/list-field-mappings.api.mdx +++ b/docs/docs/api/v2/mgmt/list-field-mappings.api.mdx @@ -5,7 +5,7 @@ description: "List schema mappings" sidebar_label: "List schema mappings" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"listFieldMappings","tags":["SchemaMappings"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of objects and their field mappings (if set)","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"object_name":{"type":"string","example":"contact"},"object_type":{"type":"string","enum":["common","standard"]},"allow_additional_field_mappings":{"type":"boolean","example":true},"schema_id":{"type":"string","example":"51797e8d-f081-496d-99ec-5e41b467df4b"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field as set in the schema","example":"email"},"is_added_by_customer":{"type":"boolean","description":"Whether the field was added by the customer (only applicable if the schema has allow_additional_field_mappings set to true)"},"schema_mapped_name":{"type":"string","description":"The mapped named of the field as set in the schema by the developer. If set, the customer cannot override. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."},"customer_mapped_name":{"type":"string","description":"The mapped name of the field as set by the customer. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."}},"required":["name","is_added_by_customer"],"title":"merged_field_map"}}},"required":["object_name","object_type","allow_additional_field_mappings","schema_id","fields"],"title":"object_field_mappings"}}}}}},"description":"List schema mappings","method":"get","path":"/field_mappings","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List schema mappings","description":{"type":"text/plain"},"url":{"path":["field_mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"listFieldMappings","tags":["SchemaMappings"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of objects and their field mappings (if set)","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"object_name":{"type":"string","example":"contact"},"object_type":{"type":"string","enum":["common","standard"]},"allow_additional_field_mappings":{"type":"boolean","example":true},"schema_id":{"type":"string","example":"51797e8d-f081-496d-99ec-5e41b467df4b"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field as set in the schema","example":"email"},"is_added_by_customer":{"type":"boolean","description":"Whether the field was added by the customer (only applicable if the schema has allow_additional_field_mappings set to true)"},"schema_mapped_name":{"type":"string","description":"The mapped named of the field as set in the schema by the developer. If set, the customer cannot override. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."},"customer_mapped_name":{"type":"string","description":"The mapped name of the field as set by the customer. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."}},"required":["name","is_added_by_customer"],"title":"merged_field_map"}}},"required":["object_name","object_type","allow_additional_field_mappings","schema_id","fields"],"title":"object_field_mappings"}}}}}},"description":"List schema mappings","method":"get","path":"/field_mappings","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List schema mappings","description":{"type":"text/plain"},"url":{"path":["field_mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/management-api.info.mdx b/docs/docs/api/v2/mgmt/management-api.info.mdx index b14749815..80a6e2817 100644 --- a/docs/docs/api/v2/mgmt/management-api.info.mdx +++ b/docs/docs/api/v2/mgmt/management-api.info.mdx @@ -13,7 +13,7 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 0.14.11 +Version: 0.14.12 diff --git a/docs/docs/api/v2/mgmt/object-field-mapping-created.api.mdx b/docs/docs/api/v2/mgmt/object-field-mapping-created.api.mdx index 93d238872..e7f3aa8f3 100644 --- a/docs/docs/api/v2/mgmt/object-field-mapping-created.api.mdx +++ b/docs/docs/api/v2/mgmt/object-field-mapping-created.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the creation of am object field mapping" sidebar_label: "Object field mapping created" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of the creation of am object field mapping","operationId":"objectFieldMappingCreated","x-event-type":"object.field_mapping.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"object.field_mapping.created","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"salesforce","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"ERROR","error_message":"Error message"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["object.field_mapping.created"],"example":"object.field_mapping.created"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"customer_id":{"type":"string","example":"c7c5204a-61d3-44a7-b581-a1f29b239f89"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"object_name":{"type":"string","example":"Contact"},"object_type":{"type":"string","enum":["common","standard"]},"schema_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","connection_id","application_id","customer_id","provider_name","object_name","object_type","schema_id","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"object.field_mapping.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"object.field_mapping.created","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"hubspot","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of the creation of am object field mapping","operationId":"objectFieldMappingCreated","x-event-type":"object.field_mapping.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"object.field_mapping.created","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"salesforce","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"ERROR","error_message":"Error message"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["object.field_mapping.created"],"example":"object.field_mapping.created"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"customer_id":{"type":"string","example":"c7c5204a-61d3-44a7-b581-a1f29b239f89"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"object_name":{"type":"string","example":"Contact"},"object_type":{"type":"string","enum":["common","standard"]},"schema_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","connection_id","application_id","customer_id","provider_name","object_name","object_type","schema_id","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"object.field_mapping.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"object.field_mapping.created","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"hubspot","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/object-field-mapping-updated.api.mdx b/docs/docs/api/v2/mgmt/object-field-mapping-updated.api.mdx index dc7877231..3914cc011 100644 --- a/docs/docs/api/v2/mgmt/object-field-mapping-updated.api.mdx +++ b/docs/docs/api/v2/mgmt/object-field-mapping-updated.api.mdx @@ -5,7 +5,7 @@ description: "Notification of an update to an object field mapping" sidebar_label: "Object field mapping updated" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of an update to an object field mapping","operationId":"objectFieldMappingUpdated","x-event-type":"object.field_mapping.updated","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"object.field_mapping.updated","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"salesforce","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"ERROR","error_message":"Error message"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["object.field_mapping.updated"],"example":"object.field_mapping.updated"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"customer_id":{"type":"string","example":"c7c5204a-61d3-44a7-b581-a1f29b239f89"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"object_name":{"type":"string","example":"Contact"},"object_type":{"type":"string","enum":["common","standard"]},"schema_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","connection_id","application_id","customer_id","provider_name","object_name","object_type","schema_id","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"object.field_mapping.updated"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"object.field_mapping.updated","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"hubspot","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of an update to an object field mapping","operationId":"objectFieldMappingUpdated","x-event-type":"object.field_mapping.updated","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"object.field_mapping.updated","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"salesforce","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"ERROR","error_message":"Error message"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["object.field_mapping.updated"],"example":"object.field_mapping.updated"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"customer_id":{"type":"string","example":"c7c5204a-61d3-44a7-b581-a1f29b239f89"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"object_name":{"type":"string","example":"Contact"},"object_type":{"type":"string","enum":["common","standard"]},"schema_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","connection_id","application_id","customer_id","provider_name","object_name","object_type","schema_id","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"object.field_mapping.updated"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"object.field_mapping.updated","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"hubspot","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/pause-sync.api.mdx b/docs/docs/api/v2/mgmt/pause-sync.api.mdx index 160a7de74..0cd773be6 100644 --- a/docs/docs/api/v2/mgmt/pause-sync.api.mdx +++ b/docs/docs/api/v2/mgmt/pause-sync.api.mdx @@ -5,7 +5,7 @@ description: "Pause sync" sidebar_label: "Pause sync" hide_title: true hide_table_of_contents: true -api: {"operationId":"pauseSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","description":"The entity id to filter by"}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard","description":"The object type to filter by"},"object":{"type":"string","example":"Contact","description":"The Provider object to filter by (case sensitive)"}},"required":["object_type","object"]},{"type":"object","title":"Data model: Common Schema","properties":{"object_type":{"type":"string","enum":["common"],"example":"common","description":"The object type to filter by"},"object":{"type":"string","example":"contact","description":"The Supaglue object to filter by"}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync paused","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"}}}}},"description":"Pause sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_pause","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Pause sync","description":{"type":"text/plain"},"url":{"path":["syncs","_pause"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"pauseSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","description":"The entity id to filter by"}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard","description":"The object type to filter by"},"object":{"type":"string","example":"Contact","description":"The Provider object to filter by (case sensitive)"}},"required":["object_type","object"]},{"type":"object","title":"Data model: Common Schema","properties":{"object_type":{"type":"string","enum":["common"],"example":"common","description":"The object type to filter by"},"object":{"type":"string","example":"contact","description":"The Supaglue object to filter by"}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync paused","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"}}}}},"description":"Pause sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_pause","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Pause sync","description":{"type":"text/plain"},"url":{"path":["syncs","_pause"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/resume-sync.api.mdx b/docs/docs/api/v2/mgmt/resume-sync.api.mdx index 471cd5ae2..4559157fb 100644 --- a/docs/docs/api/v2/mgmt/resume-sync.api.mdx +++ b/docs/docs/api/v2/mgmt/resume-sync.api.mdx @@ -5,7 +5,7 @@ description: "Resume sync" sidebar_label: "Resume sync" hide_title: true hide_table_of_contents: true -api: {"operationId":"resumeSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","example":"cfba6060-c43a-4a63-8a8c-501c6099f8b0","description":"The entity id to filter by"}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard","description":"The object type to filter by"},"object":{"type":"string","example":"contact","description":"The object to filter by"}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync resumed","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"},"example":{"id":"2caab904-3c7c-4894-8c82-4c28913b3419","type":"entity","entity_id":"db602f88-7a8c-44f0-8932-c92f1e033494","connection_id":"da732713-2ff7-4f3b-8728-257a026177cd","sync_config_id":"f2b3ea2a-6a1e-4983-91f1-92a4db4d7abd","paused":false}}}}},"description":"Resume sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_resume","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"cfba6060-c43a-4a63-8a8c-501c6099f8b0"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Resume sync","description":{"type":"text/plain"},"url":{"path":["syncs","_resume"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"resumeSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","example":"cfba6060-c43a-4a63-8a8c-501c6099f8b0","description":"The entity id to filter by"}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard","description":"The object type to filter by"},"object":{"type":"string","example":"contact","description":"The object to filter by"}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync resumed","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"},"example":{"id":"2caab904-3c7c-4894-8c82-4c28913b3419","type":"entity","entity_id":"db602f88-7a8c-44f0-8932-c92f1e033494","connection_id":"da732713-2ff7-4f3b-8728-257a026177cd","sync_config_id":"f2b3ea2a-6a1e-4983-91f1-92a4db4d7abd","paused":false}}}}},"description":"Resume sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_resume","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"cfba6060-c43a-4a63-8a8c-501c6099f8b0"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Resume sync","description":{"type":"text/plain"},"url":{"path":["syncs","_resume"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/salesforce-cdc-create.api.mdx b/docs/docs/api/v2/mgmt/salesforce-cdc-create.api.mdx index c4f5c3480..695f23366 100644 --- a/docs/docs/api/v2/mgmt/salesforce-cdc-create.api.mdx +++ b/docs/docs/api/v2/mgmt/salesforce-cdc-create.api.mdx @@ -5,7 +5,7 @@ description: "When a record is created in a customer's Salesforce (beta)" sidebar_label: "Salesforce record created (beta)" hide_title: true hide_table_of_contents: true -api: {"description":"When a record is created in a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcCreate","x-event-type":"salesforce_cdc.create","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.create"},"id":{"type":"string","description":"The Salesforce ID of the record that was created","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"},"fields":{"type":"object","description":"The fields that were set when the record was created","example":{"Name":"Acme"}}},"required":["webhook_event_type","id","entity_name","fields"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.create"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.create","id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"When a record is created in a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcCreate","x-event-type":"salesforce_cdc.create","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.create"},"id":{"type":"string","description":"The Salesforce ID of the record that was created","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"},"fields":{"type":"object","description":"The fields that were set when the record was created","example":{"Name":"Acme"}}},"required":["webhook_event_type","id","entity_name","fields"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.create"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.create","id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/salesforce-cdc-delete.api.mdx b/docs/docs/api/v2/mgmt/salesforce-cdc-delete.api.mdx index c71b154d4..3501ee6a4 100644 --- a/docs/docs/api/v2/mgmt/salesforce-cdc-delete.api.mdx +++ b/docs/docs/api/v2/mgmt/salesforce-cdc-delete.api.mdx @@ -5,7 +5,7 @@ description: "When a record is deleted from a customer's Salesforce (beta)" sidebar_label: "Salesforce record deleted (beta)" hide_title: true hide_table_of_contents: true -api: {"description":"When a record is deleted from a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcDelete","x-event-type":"salesforce_cdc.delete","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.delete"},"id":{"type":"string","description":"The Salesforce ID of the record that was deleted","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"}},"required":["webhook_event_type","id","entity_name"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.delete"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.delete","id":"0011t00000B0G6uAAF","entity_name":"Account"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"When a record is deleted from a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcDelete","x-event-type":"salesforce_cdc.delete","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.delete"},"id":{"type":"string","description":"The Salesforce ID of the record that was deleted","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"}},"required":["webhook_event_type","id","entity_name"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.delete"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.delete","id":"0011t00000B0G6uAAF","entity_name":"Account"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/salesforce-cdc-undelete.api.mdx b/docs/docs/api/v2/mgmt/salesforce-cdc-undelete.api.mdx index 91d5004ed..7c9d16123 100644 --- a/docs/docs/api/v2/mgmt/salesforce-cdc-undelete.api.mdx +++ b/docs/docs/api/v2/mgmt/salesforce-cdc-undelete.api.mdx @@ -5,7 +5,7 @@ description: "When a record is undeleted in a customer's Salesforce (beta)" sidebar_label: "Salesforce record undeleted (beta)" hide_title: true hide_table_of_contents: true -api: {"description":"When a record is undeleted in a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcUndelete","x-event-type":"salesforce_cdc.undelete","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.undelete"},"id":{"type":"string","description":"The Salesforce ID of the record that was undeleted","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"},"fields":{"type":"object","description":"The fields that were set when the record was undeleted","example":{"Name":"Acme"}}},"required":["webhook_event_type","id","entity_name","fields"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.undelete"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.undelete","id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"When a record is undeleted in a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcUndelete","x-event-type":"salesforce_cdc.undelete","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.undelete"},"id":{"type":"string","description":"The Salesforce ID of the record that was undeleted","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"},"fields":{"type":"object","description":"The fields that were set when the record was undeleted","example":{"Name":"Acme"}}},"required":["webhook_event_type","id","entity_name","fields"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.undelete"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.undelete","id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/salesforce-cdc-update.api.mdx b/docs/docs/api/v2/mgmt/salesforce-cdc-update.api.mdx index 574665415..a8c196ba5 100644 --- a/docs/docs/api/v2/mgmt/salesforce-cdc-update.api.mdx +++ b/docs/docs/api/v2/mgmt/salesforce-cdc-update.api.mdx @@ -5,7 +5,7 @@ description: "When a record is updated in a customer's Salesforce (beta)" sidebar_label: "Salesforce record updated (beta)" hide_title: true hide_table_of_contents: true -api: {"description":"When a record is updated in a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcUpdate","x-event-type":"salesforce_cdc.update","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"},"nulled_fields":[],"changed_fields":["Name"],"diff_fields":[]},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.update"},"id":{"type":"string","description":"The Salesforce ID of the record that was updated","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"},"nulled_fields":{"type":"array","description":"The fields that were set to null when the record was updated","example":["PhoneNumber2"],"items":{"type":"string"}},"changed_fields":{"type":"array","description":"The fields that were changed when the record was updated","example":["Name"],"items":{"type":"string"}},"diff_fields":{"type":"array","description":"The fields that were changed when the record was updated and the value in the fields object is a diff to be applied to the existing value","example":["Description"],"items":{"type":"string"}},"fields":{"type":"object","description":"The fields that were set when the record was created"}},"required":["webhook_event_type","id","entity_name","fields","nulled_fields","changed_fields","diff_fields"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.update"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.update","id":"0011t00000B0G6uAAF","entity_name":"Account","nulled_fields":["PhoneNumber2"],"changed_fields":["Name"],"diff_fields":["Description"],"fields":{}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"When a record is updated in a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcUpdate","x-event-type":"salesforce_cdc.update","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"},"nulled_fields":[],"changed_fields":["Name"],"diff_fields":[]},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.update"},"id":{"type":"string","description":"The Salesforce ID of the record that was updated","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"},"nulled_fields":{"type":"array","description":"The fields that were set to null when the record was updated","example":["PhoneNumber2"],"items":{"type":"string"}},"changed_fields":{"type":"array","description":"The fields that were changed when the record was updated","example":["Name"],"items":{"type":"string"}},"diff_fields":{"type":"array","description":"The fields that were changed when the record was updated and the value in the fields object is a diff to be applied to the existing value","example":["Description"],"items":{"type":"string"}},"fields":{"type":"object","description":"The fields that were set when the record was created"}},"required":["webhook_event_type","id","entity_name","fields","nulled_fields","changed_fields","diff_fields"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.update"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.update","id":"0011t00000B0G6uAAF","entity_name":"Account","nulled_fields":["PhoneNumber2"],"changed_fields":["Name"],"diff_fields":["Description"],"fields":{}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/sync-complete.api.mdx b/docs/docs/api/v2/mgmt/sync-complete.api.mdx index 6d9b3d87c..6cd0b870b 100644 --- a/docs/docs/api/v2/mgmt/sync-complete.api.mdx +++ b/docs/docs/api/v2/mgmt/sync-complete.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the completion of a sync" sidebar_label: "Sync complete" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of the completion of a sync","operationId":"syncComplete","x-event-type":"sync.complete","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"sync.complete","run_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","customer_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","provider_name":"salesforce","type":"object","object_type":"standard","object":"contact","result":"ERROR","error_message":"Error message"},"schema":{"oneOf":[{"type":"object","title":"Object Sync Complete","properties":{"webhook_event_type":{"type":"string","enum":["sync.complete"],"example":"sync.complete"},"run_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"customer_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"num_records_synced":{"type":"integer","example":100},"error_message":{"type":"string","example":"Error message"},"type":{"type":"string","enum":["object"]},"object_type":{"type":"string","enum":["common","standard","custom"]},"object":{"type":"string","example":"contact"}},"required":["webhook_event_type","run_id","connection_id","customer_id","provider_name","result","type","object_type","object"]},{"type":"object","title":"Entity Sync Complete","properties":{"webhook_event_type":{"type":"string","enum":["sync.complete"],"example":"sync.complete"},"run_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"customer_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"num_records_synced":{"type":"integer","example":100},"error_message":{"type":"string","example":"Error message"},"type":{"type":"string","enum":["entity"]},"entity_id":{"type":"string"},"entity_name":{"type":"string"}},"required":["webhook_event_type","run_id","connection_id","customer_id","provider_name","result","type","entity_id","entity_name"]}]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"sync.complete"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"sync.complete","run_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","customer_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","provider_name":"hubspot","result":"SUCCESS","num_records_synced":100,"error_message":"Error message","type":"object","object_type":"common","object":"contact"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of the completion of a sync","operationId":"syncComplete","x-event-type":"sync.complete","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"sync.complete","run_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","customer_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","provider_name":"salesforce","type":"object","object_type":"standard","object":"contact","result":"ERROR","error_message":"Error message"},"schema":{"oneOf":[{"type":"object","title":"Object Sync Complete","properties":{"webhook_event_type":{"type":"string","enum":["sync.complete"],"example":"sync.complete"},"run_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"customer_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"num_records_synced":{"type":"integer","example":100},"error_message":{"type":"string","example":"Error message"},"type":{"type":"string","enum":["object"]},"object_type":{"type":"string","enum":["common","standard","custom"]},"object":{"type":"string","example":"contact"}},"required":["webhook_event_type","run_id","connection_id","customer_id","provider_name","result","type","object_type","object"]},{"type":"object","title":"Entity Sync Complete","properties":{"webhook_event_type":{"type":"string","enum":["sync.complete"],"example":"sync.complete"},"run_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"customer_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"num_records_synced":{"type":"integer","example":100},"error_message":{"type":"string","example":"Error message"},"type":{"type":"string","enum":["entity"]},"entity_id":{"type":"string"},"entity_name":{"type":"string"}},"required":["webhook_event_type","run_id","connection_id","customer_id","provider_name","result","type","entity_id","entity_name"]}]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"sync.complete"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"sync.complete","run_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","customer_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","provider_name":"hubspot","result":"SUCCESS","num_records_synced":100,"error_message":"Error message","type":"object","object_type":"common","object":"contact"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/trigger-sync.api.mdx b/docs/docs/api/v2/mgmt/trigger-sync.api.mdx index db749d855..233b1e780 100644 --- a/docs/docs/api/v2/mgmt/trigger-sync.api.mdx +++ b/docs/docs/api/v2/mgmt/trigger-sync.api.mdx @@ -5,7 +5,7 @@ description: "Trigger sync" sidebar_label: "Trigger sync" hide_title: true hide_table_of_contents: true -api: {"operationId":"triggerSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","description":"The entity id to filter by"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["standard","custom"],"description":"The object type to filter by","example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider object to filter by (case sensitive)"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["object_type","object"]},{"type":"object","title":"Data model: Common Schema","properties":{"object_type":{"type":"string","enum":["common"],"description":"The object type to filter by","example":"common"},"object":{"type":"string","example":"contact","description":"The Supaglue object to filter by"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync triggered","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"}}}}},"description":"Trigger sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_trigger","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string","perform_full_refresh":true},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Trigger sync","description":{"type":"text/plain"},"url":{"path":["syncs","_trigger"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"triggerSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","description":"The entity id to filter by"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["standard","custom"],"description":"The object type to filter by","example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider object to filter by (case sensitive)"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["object_type","object"]},{"type":"object","title":"Data model: Common Schema","properties":{"object_type":{"type":"string","enum":["common"],"description":"The object type to filter by","example":"common"},"object":{"type":"string","example":"contact","description":"The Supaglue object to filter by"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync triggered","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"}}}}},"description":"Trigger sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_trigger","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string","perform_full_refresh":true},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Trigger sync","description":{"type":"text/plain"},"url":{"path":["syncs","_trigger"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/update-destination.api.mdx b/docs/docs/api/v2/mgmt/update-destination.api.mdx index 549bae258..1aa964e0d 100644 --- a/docs/docs/api/v2/mgmt/update-destination.api.mdx +++ b/docs/docs/api/v2/mgmt/update-destination.api.mdx @@ -5,7 +5,7 @@ description: "Update destination" sidebar_label: "Update destination" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateDestination","tags":["Destinations"],"parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser","password":"mysensitivepassword"}},"oneOf":[{"type":"object","title":"postgres","properties":{"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","port","database","schema","user"],"title":"postgres_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]},{"type":"object","title":"s3","properties":{"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"},"secret_access_key":{"type":"string","example":"A1lciPB09K2iqNHTLAftxTHy0SKGxNcO4QecAsZS"}},"required":["region","bucket","access_key_id"],"title":"s3_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"},"private_key":{"type":"string","example":"-----BEGIN PRIVATE KEY-----\\nMII..."}},"required":["client_email","private_key"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"name":{"type":"string","example":"My MongoDB Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","database","user"],"title":"mongodb_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]}],"title":"update_destination"}}}},"responses":{"200":{"description":"Destination","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Update destination","method":"put","path":"/destinations/{destination_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser","password":"mysensitivepassword"}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update destination","description":{"type":"text/plain"},"url":{"path":["destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"destination_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"operationId":"updateDestination","tags":["Destinations"],"parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser","password":"mysensitivepassword"}},"oneOf":[{"type":"object","title":"postgres","properties":{"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","port","database","schema","user"],"title":"postgres_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]},{"type":"object","title":"s3","properties":{"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"},"secret_access_key":{"type":"string","example":"A1lciPB09K2iqNHTLAftxTHy0SKGxNcO4QecAsZS"}},"required":["region","bucket","access_key_id"],"title":"s3_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"},"private_key":{"type":"string","example":"-----BEGIN PRIVATE KEY-----\\nMII..."}},"required":["client_email","private_key"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"name":{"type":"string","example":"My MongoDB Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","database","user"],"title":"mongodb_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]}],"title":"update_destination"}}}},"responses":{"200":{"description":"Destination","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Update destination","method":"put","path":"/destinations/{destination_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser","password":"mysensitivepassword"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update destination","description":{"type":"text/plain"},"url":{"path":["destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"destination_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/update-entity.api.mdx b/docs/docs/api/v2/mgmt/update-entity.api.mdx index 9487385b3..ebe040107 100644 --- a/docs/docs/api/v2/mgmt/update-entity.api.mdx +++ b/docs/docs/api/v2/mgmt/update-entity.api.mdx @@ -5,7 +5,7 @@ description: "Update entity" sidebar_label: "Update entity" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateEntity","tags":["Entities"],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["name","config"],"title":"create_update_entity"}}}},"responses":{"200":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Update entity","method":"put","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-entity","config":{"fields":[{"name":"apolla_first_name"}],"allow_additional_field_mappings":true}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"operationId":"updateEntity","tags":["Entities"],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["name","config"],"title":"create_update_entity"}}}},"responses":{"200":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Update entity","method":"put","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-entity","config":{"fields":[{"name":"apolla_first_name"}],"allow_additional_field_mappings":true}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/update-object-field-mappings.api.mdx b/docs/docs/api/v2/mgmt/update-object-field-mappings.api.mdx index d197daa7e..930a043cf 100644 --- a/docs/docs/api/v2/mgmt/update-object-field-mappings.api.mdx +++ b/docs/docs/api/v2/mgmt/update-object-field-mappings.api.mdx @@ -5,7 +5,7 @@ description: "Update schema mappings" sidebar_label: "Update schema mappings" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"updateObjectFieldMappings","tags":["SchemaMappings"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"contact"},"type":{"type":"string","enum":["common","standard"]},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["name","type","field_mappings"],"title":"update_object_field_mapping"}}}},"responses":{"200":{"description":"List of objects and their field mappings (if set)","content":{"application/json":{"schema":{"type":"object","properties":{"object_name":{"type":"string","example":"contact"},"object_type":{"type":"string","enum":["common","standard"]},"allow_additional_field_mappings":{"type":"boolean","example":true},"schema_id":{"type":"string","example":"51797e8d-f081-496d-99ec-5e41b467df4b"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field as set in the schema","example":"email"},"is_added_by_customer":{"type":"boolean","description":"Whether the field was added by the customer (only applicable if the schema has allow_additional_field_mappings set to true)"},"schema_mapped_name":{"type":"string","description":"The mapped named of the field as set in the schema by the developer. If set, the customer cannot override. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."},"customer_mapped_name":{"type":"string","description":"The mapped name of the field as set by the customer. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."}},"required":["name","is_added_by_customer"],"title":"merged_field_map"}}},"required":["object_name","object_type","allow_additional_field_mappings","schema_id","fields"],"title":"object_field_mappings"}}}}},"description":"Update schema mappings","method":"put","path":"/field_mappings/_update_object","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"contact","type":"common","field_mappings":[{"schema_field":"apolla_first_name","mapped_field":"FirstName"}]},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update schema mappings","description":{"type":"text/plain"},"url":{"path":["field_mappings","_update_object"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"updateObjectFieldMappings","tags":["SchemaMappings"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"contact"},"type":{"type":"string","enum":["common","standard"]},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["name","type","field_mappings"],"title":"update_object_field_mapping"}}}},"responses":{"200":{"description":"List of objects and their field mappings (if set)","content":{"application/json":{"schema":{"type":"object","properties":{"object_name":{"type":"string","example":"contact"},"object_type":{"type":"string","enum":["common","standard"]},"allow_additional_field_mappings":{"type":"boolean","example":true},"schema_id":{"type":"string","example":"51797e8d-f081-496d-99ec-5e41b467df4b"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field as set in the schema","example":"email"},"is_added_by_customer":{"type":"boolean","description":"Whether the field was added by the customer (only applicable if the schema has allow_additional_field_mappings set to true)"},"schema_mapped_name":{"type":"string","description":"The mapped named of the field as set in the schema by the developer. If set, the customer cannot override. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."},"customer_mapped_name":{"type":"string","description":"The mapped name of the field as set by the customer. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."}},"required":["name","is_added_by_customer"],"title":"merged_field_map"}}},"required":["object_name","object_type","allow_additional_field_mappings","schema_id","fields"],"title":"object_field_mappings"}}}}},"description":"Update schema mappings","method":"put","path":"/field_mappings/_update_object","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"contact","type":"common","field_mappings":[{"schema_field":"apolla_first_name","mapped_field":"FirstName"}]},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update schema mappings","description":{"type":"text/plain"},"url":{"path":["field_mappings","_update_object"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/update-provider.api.mdx b/docs/docs/api/v2/mgmt/update-provider.api.mdx index 6ee89032f..38d8000eb 100644 --- a/docs/docs/api/v2/mgmt/update-provider.api.mdx +++ b/docs/docs/api/v2/mgmt/update-provider.api.mdx @@ -5,7 +5,7 @@ description: "Update provider" sidebar_label: "Update provider" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateProvider","tags":["Providers"],"parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"crm","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["crm"]},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule"],"title":"provider_name_crm"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"engagement","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["engagement"]},"name":{"type":"string","enum":["outreach","apollo","salesloft"],"title":"provider_name_engagement"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"no category","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["no_category"]},"name":{"type":"string","enum":["intercom","gong","linear"],"title":"provider_name_no_category"}},"required":["auth_type","config","category","name"]}],"title":"update_provider"}}}},"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Update provider","method":"put","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"auth_type":"oauth2","config":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"objects":{"common":[{"name":"account","schema_id":"328a8cb3-8345-4b02-b661-ee13b4f76806"}],"standard":[{"name":"Account","schema_id":"777ea826-5776-4347-9ece-47bbb17ccdd4"}]},"entity_mappings":[{"entity_id":"apolla_contact","object":{"type":"standard","name":"Contact"},"field_mappings":[{"entity_field":"apolla_first_name","mapped_field":"FirstName"}]}],"category":"crm","name":"hubspot"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"operationId":"updateProvider","tags":["Providers"],"parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"crm","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["crm"]},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule"],"title":"provider_name_crm"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"engagement","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["engagement"]},"name":{"type":"string","enum":["outreach","apollo","salesloft"],"title":"provider_name_engagement"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"no category","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["no_category"]},"name":{"type":"string","enum":["intercom","gong","linear"],"title":"provider_name_no_category"}},"required":["auth_type","config","category","name"]}],"title":"update_provider"}}}},"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Update provider","method":"put","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"auth_type":"oauth2","config":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"objects":{"common":[{"name":"account","schema_id":"328a8cb3-8345-4b02-b661-ee13b4f76806"}],"standard":[{"name":"Account","schema_id":"777ea826-5776-4347-9ece-47bbb17ccdd4"}]},"entity_mappings":[{"entity_id":"apolla_contact","object":{"type":"standard","name":"Contact"},"field_mappings":[{"entity_field":"apolla_first_name","mapped_field":"FirstName"}]}],"category":"crm","name":"hubspot"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/update-schema.api.mdx b/docs/docs/api/v2/mgmt/update-schema.api.mdx index 5637b0a5f..0d079eece 100644 --- a/docs/docs/api/v2/mgmt/update-schema.api.mdx +++ b/docs/docs/api/v2/mgmt/update-schema.api.mdx @@ -5,7 +5,7 @@ description: "Update schema" sidebar_label: "Update schema" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"updateSchema","tags":["Schemas"],"parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["name","config"],"title":"create_update_schema"}}}},"responses":{"200":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Update schema","method":"put","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-schema","config":{"fields":[{"name":"apolla_first_name","mapped_name":"FirstName"}],"allow_additional_field_mappings":false}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"deprecated":true,"operationId":"updateSchema","tags":["Schemas"],"parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["name","config"],"title":"create_update_schema"}}}},"responses":{"200":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Update schema","method":"put","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-schema","config":{"fields":[{"name":"apolla_first_name","mapped_name":"FirstName"}],"allow_additional_field_mappings":false}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/update-sync-config.api.mdx b/docs/docs/api/v2/mgmt/update-sync-config.api.mdx index 6a29f6dbb..bb4afb6ef 100644 --- a/docs/docs/api/v2/mgmt/update-sync-config.api.mdx +++ b/docs/docs/api/v2/mgmt/update-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Update Sync Config" sidebar_label: "Update Sync Config" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateSyncConfig","tags":["SyncConfigs"],"parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["destination_id","provider_id","config"],"title":"create_update_sync_config"}}}},"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Update Sync Config","method":"put","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_id":"6e7baa88-84dd-4dbc-902a-14522c2984eb","provider_id":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af","config":{"default_config":{"period_ms":60000,"strategy":"full then incremental","auto_start_on_connection":true},"common_objects":[{"object":"contact"}],"standard_objects":[{"object":"Contact"}],"entities":[{"entity_id":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}]}},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"operationId":"updateSyncConfig","tags":["SyncConfigs"],"parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["destination_id","provider_id","config"],"title":"create_update_sync_config"}}}},"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Update Sync Config","method":"put","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_id":"6e7baa88-84dd-4dbc-902a-14522c2984eb","provider_id":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af","config":{"default_config":{"period_ms":60000,"strategy":"full then incremental","auto_start_on_connection":true},"common_objects":[{"object":"contact"}],"standard_objects":[{"object":"Contact"}],"entities":[{"entity_id":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}]}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/upsert-connection-sync-config.api.mdx b/docs/docs/api/v2/mgmt/upsert-connection-sync-config.api.mdx index b94ee2119..9f36620c1 100644 --- a/docs/docs/api/v2/mgmt/upsert-connection-sync-config.api.mdx +++ b/docs/docs/api/v2/mgmt/upsert-connection-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Upsert connection sync config" sidebar_label: "Upsert connection sync config" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertConnectionSyncConfig","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"oneOf":[{"description":"Config specific to postgres destination","type":"object","title":"postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to bigquery destination","type":"object","title":"bigquery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the bigquery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"custom_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name (case sensitive)","example":"Contact__c"}},"required":["object"]}}},"title":"upsert_connection_sync_config"}}}},"responses":{"200":{"description":"Connection Sync Config","content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"oneOf":[{"description":"Config specific to postgres destination","type":"object","title":"postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to bigquery destination","type":"object","title":"bigquery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the bigquery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"custom_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name (case sensitive)","example":"Contact__c"}},"required":["object"]}}},"title":"connection_sync_config"}}}}},"description":"Upsert connection sync config","method":"put","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_config":{"type":"postgres","schema":"customer_1_schema"},"standard_objects":[{"object":"Contact"}],"custom_objects":[{"object":"Contact__c"}]},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert connection sync config","description":{"type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"upsertConnectionSyncConfig","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"oneOf":[{"description":"Config specific to postgres destination","type":"object","title":"postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to bigquery destination","type":"object","title":"bigquery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the bigquery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"custom_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name (case sensitive)","example":"Contact__c"}},"required":["object"]}}},"title":"upsert_connection_sync_config"}}}},"responses":{"200":{"description":"Connection Sync Config","content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"oneOf":[{"description":"Config specific to postgres destination","type":"object","title":"postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to bigquery destination","type":"object","title":"bigquery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the bigquery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"custom_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name (case sensitive)","example":"Contact__c"}},"required":["object"]}}},"title":"connection_sync_config"}}}}},"description":"Upsert connection sync config","method":"put","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_config":{"type":"postgres","schema":"customer_1_schema"},"standard_objects":[{"object":"Contact"}],"custom_objects":[{"object":"Contact__c"}]},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert connection sync config","description":{"type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/upsert-customer.api.mdx b/docs/docs/api/v2/mgmt/upsert-customer.api.mdx index 88be4cab5..55e0dd8f4 100644 --- a/docs/docs/api/v2/mgmt/upsert-customer.api.mdx +++ b/docs/docs/api/v2/mgmt/upsert-customer.api.mdx @@ -5,7 +5,7 @@ description: "Upsert customer" sidebar_label: "Upsert customer" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"}},"required":["name","email","customer_id"],"title":"create_update_customer"}}}},"responses":{"200":{"description":"Customer upserted","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"}}}}},"description":"Upsert customer","method":"put","path":"/customers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"customer_id":"your-customers-unique-application-id","name":"MyCompany Inc","email":"contact@mycompany.com"},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert customer","description":{"type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"upsertCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"}},"required":["name","email","customer_id"],"title":"create_update_customer"}}}},"responses":{"200":{"description":"Customer upserted","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"}}}}},"description":"Upsert customer","method":"put","path":"/customers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"customer_id":"your-customers-unique-application-id","name":"MyCompany Inc","email":"contact@mycompany.com"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert customer","description":{"type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/mgmt/upsert-entity-mapping.api.mdx b/docs/docs/api/v2/mgmt/upsert-entity-mapping.api.mdx index 5e8b11728..ea00991f8 100644 --- a/docs/docs/api/v2/mgmt/upsert-entity-mapping.api.mdx +++ b/docs/docs/api/v2/mgmt/upsert-entity-mapping.api.mdx @@ -5,7 +5,7 @@ description: "Upsert entity mapping" sidebar_label: "Upsert entity mapping" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"upsertEntityMapping","tags":["EntityMappings"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"}}}},"responses":{"200":{"description":"Entity Mapping"}},"description":"Upsert entity mapping","method":"put","path":"/entity_mappings/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string","object":{"type":"standard","name":"string"},"field_mappings":[{"entity_field":"apolla_first_name","mapped_field":"FirstName"}]},"info":{"version":"0.14.11","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert entity mapping","description":{"type":"text/plain"},"url":{"path":["entity_mappings",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"deprecated":true,"operationId":"upsertEntityMapping","tags":["EntityMappings"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"}}}},"responses":{"200":{"description":"Entity Mapping"}},"description":"Upsert entity mapping","method":"put","path":"/entity_mappings/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string","object":{"type":"standard","name":"string"},"field_mappings":[{"entity_field":"apolla_first_name","mapped_field":"FirstName"}]},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert entity mapping","description":{"type":"text/plain"},"url":{"path":["entity_mappings",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/create-attachment.api.mdx b/docs/docs/api/v2/ticketing/create-attachment.api.mdx index cf3914b13..89350af46 100644 --- a/docs/docs/api/v2/ticketing/create-attachment.api.mdx +++ b/docs/docs/api/v2/ticketing/create-attachment.api.mdx @@ -5,7 +5,7 @@ description: "Creates a Attachment object with the given values." sidebar_label: "Create attachment" hide_title: true hide_table_of_contents: true -api: {"operationId":"createAttachment","description":"Creates a Attachment object with the given values.","tags":["Attachments"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}},"required":["record"]}}}},"responses":{"201":{"description":"Attachment created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"post","path":"/attachments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"file_name":"Screenshot.png","ticket":"0958cbc6-6040-430a-848e-aafacbadf4ae","file_url":"http://alturl.com/p749b","content_type":"jpeg","uploaded_by":"28b54125-287f-494d-965e-3c5b330c9a68"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create attachment","description":{"content":"Creates a Attachment object with the given values.","type":"text/plain"},"url":{"path":["attachments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createAttachment","description":"Creates a Attachment object with the given values.","tags":["Attachments"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}},"required":["record"]}}}},"responses":{"201":{"description":"Attachment created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"post","path":"/attachments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"file_name":"Screenshot.png","ticket":"0958cbc6-6040-430a-848e-aafacbadf4ae","file_url":"http://alturl.com/p749b","content_type":"jpeg","uploaded_by":"28b54125-287f-494d-965e-3c5b330c9a68"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create attachment","description":{"content":"Creates a Attachment object with the given values.","type":"text/plain"},"url":{"path":["attachments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/create-comment.api.mdx b/docs/docs/api/v2/ticketing/create-comment.api.mdx index afabbeb56..97f519d1d 100644 --- a/docs/docs/api/v2/ticketing/create-comment.api.mdx +++ b/docs/docs/api/v2/ticketing/create-comment.api.mdx @@ -5,7 +5,7 @@ description: "Creates a Comment object with the given values." sidebar_label: "Create comment" hide_title: true hide_table_of_contents: true -api: {"operationId":"createComment","description":"Creates a Comment object with the given values.","tags":["Comments"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"user":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"},"contact":{"type":"string","example":"dde3fb16-b8eb-483d-81c4-b78100816f15"},"body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"html_body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"ticket":{"type":"string","nullable":true,"example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"},"is_private":{"type":"boolean","example":true}},"required":["user","body","ticket","is_private"]}},"required":["record"]}}}},"responses":{"201":{"description":"Comment created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"post","path":"/comments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"user":"17a54124-287f-494d-965e-3c5b330c9a68","contact":"dde3fb16-b8eb-483d-81c4-b78100816f15","body":"When will these integrations be done? You all should use Supaglue.","html_body":"When will these integrations be done? You all should use Supaglue.","ticket":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d","is_private":true}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create comment","description":{"content":"Creates a Comment object with the given values.","type":"text/plain"},"url":{"path":["comments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createComment","description":"Creates a Comment object with the given values.","tags":["Comments"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"user":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"},"contact":{"type":"string","example":"dde3fb16-b8eb-483d-81c4-b78100816f15"},"body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"html_body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"ticket":{"type":"string","nullable":true,"example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"},"is_private":{"type":"boolean","example":true}},"required":["user","body","ticket","is_private"]}},"required":["record"]}}}},"responses":{"201":{"description":"Comment created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"post","path":"/comments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"user":"17a54124-287f-494d-965e-3c5b330c9a68","contact":"dde3fb16-b8eb-483d-81c4-b78100816f15","body":"When will these integrations be done? You all should use Supaglue.","html_body":"When will these integrations be done? You all should use Supaglue.","ticket":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d","is_private":true}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create comment","description":{"content":"Creates a Comment object with the given values.","type":"text/plain"},"url":{"path":["comments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/create-ticket.api.mdx b/docs/docs/api/v2/ticketing/create-ticket.api.mdx index e8c9aaea1..359109a9d 100644 --- a/docs/docs/api/v2/ticketing/create-ticket.api.mdx +++ b/docs/docs/api/v2/ticketing/create-ticket.api.mdx @@ -5,7 +5,7 @@ description: "Creates a Ticket object with the given values." sidebar_label: "Create ticket" hide_title: true hide_table_of_contents: true -api: {"operationId":"createTicket","description":"Creates a Ticket object with the given values.","tags":["Tickets"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"create_ticket"}},"required":["record"]}}}},"responses":{"201":{"description":"Ticket created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"post","path":"/tickets","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"Please add more integrations","assignees":["17a54124-287f-494d-965e-3c5b330c9a68"],"creator":"3fa85f64-5717-4562-b3fc-2c963f66afa6","due_date":"2022-10-11T00:00:00Z","status":"OPEN","description":"Can you please add more integrations? It'll make syncing data much easier!","collections":["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],"ticket_type":"incident","account":"0958cbc6-6040-430a-848e-aafacbadf4ae","contact":"65c345ba-6870-4974-87ba-dd31509c367a","parent_ticket":"75b33d04-30d2-4f3e-be45-27838bc94342","tags":["enterprise"],"completed_at":"2021-12-09T00:00:00Z","ticket_url":"https://thirdpartysoftware.com/project/3/issue/1","priority":"HIGH"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create ticket","description":{"content":"Creates a Ticket object with the given values.","type":"text/plain"},"url":{"path":["tickets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createTicket","description":"Creates a Ticket object with the given values.","tags":["Tickets"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"create_ticket"}},"required":["record"]}}}},"responses":{"201":{"description":"Ticket created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"post","path":"/tickets","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"Please add more integrations","assignees":["17a54124-287f-494d-965e-3c5b330c9a68"],"creator":"3fa85f64-5717-4562-b3fc-2c963f66afa6","due_date":"2022-10-11T00:00:00Z","status":"OPEN","description":"Can you please add more integrations? It'll make syncing data much easier!","collections":["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],"ticket_type":"incident","account":"0958cbc6-6040-430a-848e-aafacbadf4ae","contact":"65c345ba-6870-4974-87ba-dd31509c367a","parent_ticket":"75b33d04-30d2-4f3e-be45-27838bc94342","tags":["enterprise"],"completed_at":"2021-12-09T00:00:00Z","ticket_url":"https://thirdpartysoftware.com/project/3/issue/1","priority":"HIGH"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create ticket","description":{"content":"Creates a Ticket object with the given values.","type":"text/plain"},"url":{"path":["tickets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/get-account.api.mdx b/docs/docs/api/v2/ticketing/get-account.api.mdx index 7baf0e066..d3c37a40b 100644 --- a/docs/docs/api/v2/ticketing/get-account.api.mdx +++ b/docs/docs/api/v2/ticketing/get-account.api.mdx @@ -5,7 +5,7 @@ description: "Returns an Account object with the given id." sidebar_label: "Get account" hide_title: true hide_table_of_contents: true -api: {"operationId":"getAccount","description":"Returns an Account object with the given id.","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"AccountData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Waystar Royco"},"domains":{"type":"array","items":{"type":"string","example":"waystar-royco.com"}}},"required":["name","domains"],"title":"account"}}}}},"method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get account","description":{"content":"Returns an Account object with the given id.","type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getAccount","description":"Returns an Account object with the given id.","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"AccountData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Waystar Royco"},"domains":{"type":"array","items":{"type":"string","example":"waystar-royco.com"}}},"required":["name","domains"],"title":"account"}}}}},"method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get account","description":{"content":"Returns an Account object with the given id.","type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/get-attachment.api.mdx b/docs/docs/api/v2/ticketing/get-attachment.api.mdx index fd98cd088..ddc1d9674 100644 --- a/docs/docs/api/v2/ticketing/get-attachment.api.mdx +++ b/docs/docs/api/v2/ticketing/get-attachment.api.mdx @@ -5,7 +5,7 @@ description: "Returns an Attachment object with the given id." sidebar_label: "Get attachment" hide_title: true hide_table_of_contents: true -api: {"operationId":"getAttachment","description":"Returns an Attachment object with the given id.","tags":["Attachments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"attachment_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"attachmentData","content":{"application/json":{"schema":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}}}}},"method":"get","path":"/attachments/{attachment_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get attachment","description":{"content":"Returns an Attachment object with the given id.","type":"text/plain"},"url":{"path":["attachments",":attachment_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"attachment_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getAttachment","description":"Returns an Attachment object with the given id.","tags":["Attachments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"attachment_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"attachmentData","content":{"application/json":{"schema":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}}}}},"method":"get","path":"/attachments/{attachment_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get attachment","description":{"content":"Returns an Attachment object with the given id.","type":"text/plain"},"url":{"path":["attachments",":attachment_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"attachment_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/get-collection.api.mdx b/docs/docs/api/v2/ticketing/get-collection.api.mdx index 85e6b3130..47fb7d44f 100644 --- a/docs/docs/api/v2/ticketing/get-collection.api.mdx +++ b/docs/docs/api/v2/ticketing/get-collection.api.mdx @@ -5,7 +5,7 @@ description: "Returns a Collection object with the given id." sidebar_label: "Get collection" hide_title: true hide_table_of_contents: true -api: {"operationId":"getCollection","description":"Returns a Collection object with the given id.","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"CollectionData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Q1 Platform"},"description":{"type":"string","nullable":true,"example":"For tracking all tasks related to Platform for Q1"},"collection_type":{"type":"string","nullable":true,"example":"LIST"},"parent_collection":{"type":"string","nullable":true,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"},"access_level":{"type":"string","nullable":true,"example":"PUBLIC"}},"required":["name"],"title":"collection"}}}}},"method":"get","path":"/collections/{collection_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get collection","description":{"content":"Returns a Collection object with the given id.","type":"text/plain"},"url":{"path":["collections",":collection_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"collection_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getCollection","description":"Returns a Collection object with the given id.","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"CollectionData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Q1 Platform"},"description":{"type":"string","nullable":true,"example":"For tracking all tasks related to Platform for Q1"},"collection_type":{"type":"string","nullable":true,"example":"LIST"},"parent_collection":{"type":"string","nullable":true,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"},"access_level":{"type":"string","nullable":true,"example":"PUBLIC"}},"required":["name"],"title":"collection"}}}}},"method":"get","path":"/collections/{collection_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get collection","description":{"content":"Returns a Collection object with the given id.","type":"text/plain"},"url":{"path":["collections",":collection_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"collection_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/get-contact.api.mdx b/docs/docs/api/v2/ticketing/get-contact.api.mdx index e2008e33f..21b0106cc 100644 --- a/docs/docs/api/v2/ticketing/get-contact.api.mdx +++ b/docs/docs/api/v2/ticketing/get-contact.api.mdx @@ -5,7 +5,7 @@ description: "Returns a Contact object with the given id." sidebar_label: "Get contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"getContact","description":"Returns a Contact object with the given id.","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"ContactData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Cousin Greg"},"email_address":{"type":"string","example":"greg@waystar-royco.com"},"phone_number":{"type":"string","nullable":true,"example":"5108890293"},"details":{"type":"string","nullable":true,"example":"Executive Assistant to Tom Wambsgans"},"account":{"type":"string","nullable":true,"example":"8998e1ed-1c76-4b64-9097-9d37ee88bf6f"}},"required":["name","email_address"],"title":"contact"}}}}},"method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get contact","description":{"content":"Returns a Contact object with the given id.","type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getContact","description":"Returns a Contact object with the given id.","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"ContactData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Cousin Greg"},"email_address":{"type":"string","example":"greg@waystar-royco.com"},"phone_number":{"type":"string","nullable":true,"example":"5108890293"},"details":{"type":"string","nullable":true,"example":"Executive Assistant to Tom Wambsgans"},"account":{"type":"string","nullable":true,"example":"8998e1ed-1c76-4b64-9097-9d37ee88bf6f"}},"required":["name","email_address"],"title":"contact"}}}}},"method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get contact","description":{"content":"Returns a Contact object with the given id.","type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/get-tag.api.mdx b/docs/docs/api/v2/ticketing/get-tag.api.mdx index 47265fb94..38c0a75ae 100644 --- a/docs/docs/api/v2/ticketing/get-tag.api.mdx +++ b/docs/docs/api/v2/ticketing/get-tag.api.mdx @@ -5,7 +5,7 @@ description: "Returns a Tag object with the given id." sidebar_label: "Get tag" hide_title: true hide_table_of_contents: true -api: {"operationId":"getTag","description":"Returns a Tag object with the given id.","tags":["Tags"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"tag_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TagData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Ticketing API"}},"required":["name"],"title":"tag"}}}}},"method":"get","path":"/tags/{tag_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get tag","description":{"content":"Returns a Tag object with the given id.","type":"text/plain"},"url":{"path":["tags",":tag_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"tag_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getTag","description":"Returns a Tag object with the given id.","tags":["Tags"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"tag_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TagData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Ticketing API"}},"required":["name"],"title":"tag"}}}}},"method":"get","path":"/tags/{tag_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get tag","description":{"content":"Returns a Tag object with the given id.","type":"text/plain"},"url":{"path":["tags",":tag_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"tag_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/get-team.api.mdx b/docs/docs/api/v2/ticketing/get-team.api.mdx index eb70182a2..b34784a06 100644 --- a/docs/docs/api/v2/ticketing/get-team.api.mdx +++ b/docs/docs/api/v2/ticketing/get-team.api.mdx @@ -5,7 +5,7 @@ description: "Returns an Team object with the given id." sidebar_label: "Get team" hide_title: true hide_table_of_contents: true -api: {"operationId":"getTeam","description":"Returns an Team object with the given id.","tags":["Teams"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"team_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TeamData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Platform"},"decription":{"type":"string","nullable":true,"example":"Platform and Integrations Team"}},"required":["name"]}}}}},"method":"get","path":"/teams/{team_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get team","description":{"content":"Returns an Team object with the given id.","type":"text/plain"},"url":{"path":["teams",":team_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"team_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getTeam","description":"Returns an Team object with the given id.","tags":["Teams"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"team_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TeamData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Platform"},"decription":{"type":"string","nullable":true,"example":"Platform and Integrations Team"}},"required":["name"]}}}}},"method":"get","path":"/teams/{team_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get team","description":{"content":"Returns an Team object with the given id.","type":"text/plain"},"url":{"path":["teams",":team_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"team_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/get-ticket.api.mdx b/docs/docs/api/v2/ticketing/get-ticket.api.mdx index 5639b5a0a..1199c599b 100644 --- a/docs/docs/api/v2/ticketing/get-ticket.api.mdx +++ b/docs/docs/api/v2/ticketing/get-ticket.api.mdx @@ -5,7 +5,7 @@ description: "Returns an Ticket object with the given id." sidebar_label: "Get ticket" hide_title: true hide_table_of_contents: true -api: {"operationId":"getTicket","description":"Returns an Ticket object with the given id.","tags":["Tickets"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"ticket_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TicketData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"ticket"}}}}},"method":"get","path":"/tickets/{ticket_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get ticket","description":{"content":"Returns an Ticket object with the given id.","type":"text/plain"},"url":{"path":["tickets",":ticket_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"ticket_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getTicket","description":"Returns an Ticket object with the given id.","tags":["Tickets"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"ticket_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TicketData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"ticket"}}}}},"method":"get","path":"/tickets/{ticket_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get ticket","description":{"content":"Returns an Ticket object with the given id.","type":"text/plain"},"url":{"path":["tickets",":ticket_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"ticket_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/get-user.api.mdx b/docs/docs/api/v2/ticketing/get-user.api.mdx index 84d519602..bab2b7e3a 100644 --- a/docs/docs/api/v2/ticketing/get-user.api.mdx +++ b/docs/docs/api/v2/ticketing/get-user.api.mdx @@ -5,7 +5,7 @@ description: "Returns a User object with the given id." sidebar_label: "Get user" hide_title: true hide_table_of_contents: true -api: {"operationId":"getUser","description":"Returns a User object with the given id.","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"UserData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}}}},"method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get user","description":{"content":"Returns a User object with the given id.","type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getUser","description":"Returns a User object with the given id.","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"UserData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}}}},"method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get user","description":{"content":"Returns a User object with the given id.","type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/list-accounts.api.mdx b/docs/docs/api/v2/ticketing/list-accounts.api.mdx index 7990bb234..8e87ef2c5 100644 --- a/docs/docs/api/v2/ticketing/list-accounts.api.mdx +++ b/docs/docs/api/v2/ticketing/list-accounts.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Account objects." sidebar_label: "List accounts" hide_title: true hide_table_of_contents: true -api: {"operationId":"listAccounts","description":"Returns a list of Account objects.","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"AccountsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Waystar Royco"},"domains":{"type":"array","items":{"type":"string","example":"waystar-royco.com"}}},"required":["name","domains"],"title":"account"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/accounts","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List accounts","description":{"content":"Returns a list of Account objects.","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listAccounts","description":"Returns a list of Account objects.","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"AccountsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Waystar Royco"},"domains":{"type":"array","items":{"type":"string","example":"waystar-royco.com"}}},"required":["name","domains"],"title":"account"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/accounts","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List accounts","description":{"content":"Returns a list of Account objects.","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/list-attachments.api.mdx b/docs/docs/api/v2/ticketing/list-attachments.api.mdx index 9b963ca4f..28c91d548 100644 --- a/docs/docs/api/v2/ticketing/list-attachments.api.mdx +++ b/docs/docs/api/v2/ticketing/list-attachments.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Attachment objects." sidebar_label: "List attachments" hide_title: true hide_table_of_contents: true -api: {"operationId":"listAttachments","description":"Returns a list of Attachment objects.","tags":["Attachments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"AttachmentsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}}},"required":["pagination","records"]}}}}},"method":"get","path":"/attachments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List attachments","description":{"content":"Returns a list of Attachment objects.","type":"text/plain"},"url":{"path":["attachments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listAttachments","description":"Returns a list of Attachment objects.","tags":["Attachments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"AttachmentsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}}},"required":["pagination","records"]}}}}},"method":"get","path":"/attachments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List attachments","description":{"content":"Returns a list of Attachment objects.","type":"text/plain"},"url":{"path":["attachments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/list-collection-users.api.mdx b/docs/docs/api/v2/ticketing/list-collection-users.api.mdx index ab7eb40cb..efc9d9afb 100644 --- a/docs/docs/api/v2/ticketing/list-collection-users.api.mdx +++ b/docs/docs/api/v2/ticketing/list-collection-users.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of User objects." sidebar_label: "List collection users" hide_title: true hide_table_of_contents: true -api: {"operationId":"listCollectionUsers","description":"Returns a list of User objects.","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"parent_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"CollectionUsersData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/collections/{parent_id}/users","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List collection users","description":{"content":"Returns a list of User objects.","type":"text/plain"},"url":{"path":["collections",":parent_id","users"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"parent_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listCollectionUsers","description":"Returns a list of User objects.","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"parent_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"CollectionUsersData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/collections/{parent_id}/users","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List collection users","description":{"content":"Returns a list of User objects.","type":"text/plain"},"url":{"path":["collections",":parent_id","users"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"parent_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/list-collections.api.mdx b/docs/docs/api/v2/ticketing/list-collections.api.mdx index df6dce301..f6a6d1c74 100644 --- a/docs/docs/api/v2/ticketing/list-collections.api.mdx +++ b/docs/docs/api/v2/ticketing/list-collections.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Collection objects." sidebar_label: "List collections" hide_title: true hide_table_of_contents: true -api: {"operationId":"listCollections","description":"Returns a list of Collection objects.","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"CollectionsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Q1 Platform"},"description":{"type":"string","nullable":true,"example":"For tracking all tasks related to Platform for Q1"},"collection_type":{"type":"string","nullable":true,"example":"LIST"},"parent_collection":{"type":"string","nullable":true,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"},"access_level":{"type":"string","nullable":true,"example":"PUBLIC"}},"required":["name"],"title":"collection"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/collections","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List collections","description":{"content":"Returns a list of Collection objects.","type":"text/plain"},"url":{"path":["collections"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listCollections","description":"Returns a list of Collection objects.","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"CollectionsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Q1 Platform"},"description":{"type":"string","nullable":true,"example":"For tracking all tasks related to Platform for Q1"},"collection_type":{"type":"string","nullable":true,"example":"LIST"},"parent_collection":{"type":"string","nullable":true,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"},"access_level":{"type":"string","nullable":true,"example":"PUBLIC"}},"required":["name"],"title":"collection"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/collections","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List collections","description":{"content":"Returns a list of Collection objects.","type":"text/plain"},"url":{"path":["collections"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/list-comments.api.mdx b/docs/docs/api/v2/ticketing/list-comments.api.mdx index beabbc9b9..d9e18f6ad 100644 --- a/docs/docs/api/v2/ticketing/list-comments.api.mdx +++ b/docs/docs/api/v2/ticketing/list-comments.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Comment objects." sidebar_label: "List comments" hide_title: true hide_table_of_contents: true -api: {"operationId":"listComments","description":"Returns a list of Comment objects.","tags":["Comments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"CommentsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"user":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"},"contact":{"type":"string","example":"dde3fb16-b8eb-483d-81c4-b78100816f15"},"body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"html_body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"ticket":{"type":"string","nullable":true,"example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"},"is_private":{"type":"boolean","example":true}},"required":["user","body","ticket","is_private"],"title":"comment"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/comments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List comments","description":{"content":"Returns a list of Comment objects.","type":"text/plain"},"url":{"path":["comments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listComments","description":"Returns a list of Comment objects.","tags":["Comments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"CommentsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"user":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"},"contact":{"type":"string","example":"dde3fb16-b8eb-483d-81c4-b78100816f15"},"body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"html_body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"ticket":{"type":"string","nullable":true,"example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"},"is_private":{"type":"boolean","example":true}},"required":["user","body","ticket","is_private"],"title":"comment"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/comments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List comments","description":{"content":"Returns a list of Comment objects.","type":"text/plain"},"url":{"path":["comments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/list-contacts.api.mdx b/docs/docs/api/v2/ticketing/list-contacts.api.mdx index 48caf85b0..f5e2b19ea 100644 --- a/docs/docs/api/v2/ticketing/list-contacts.api.mdx +++ b/docs/docs/api/v2/ticketing/list-contacts.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Contact objects." sidebar_label: "List contacts" hide_title: true hide_table_of_contents: true -api: {"operationId":"listContacts","description":"Returns a list of Contact objects.","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"ContactsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Cousin Greg"},"email_address":{"type":"string","example":"greg@waystar-royco.com"},"phone_number":{"type":"string","nullable":true,"example":"5108890293"},"details":{"type":"string","nullable":true,"example":"Executive Assistant to Tom Wambsgans"},"account":{"type":"string","nullable":true,"example":"8998e1ed-1c76-4b64-9097-9d37ee88bf6f"}},"required":["name","email_address"],"title":"contact"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/contacts","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List contacts","description":{"content":"Returns a list of Contact objects.","type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listContacts","description":"Returns a list of Contact objects.","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"ContactsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Cousin Greg"},"email_address":{"type":"string","example":"greg@waystar-royco.com"},"phone_number":{"type":"string","nullable":true,"example":"5108890293"},"details":{"type":"string","nullable":true,"example":"Executive Assistant to Tom Wambsgans"},"account":{"type":"string","nullable":true,"example":"8998e1ed-1c76-4b64-9097-9d37ee88bf6f"}},"required":["name","email_address"],"title":"contact"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/contacts","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List contacts","description":{"content":"Returns a list of Contact objects.","type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/list-tags.api.mdx b/docs/docs/api/v2/ticketing/list-tags.api.mdx index c2fc4a29c..e613e1891 100644 --- a/docs/docs/api/v2/ticketing/list-tags.api.mdx +++ b/docs/docs/api/v2/ticketing/list-tags.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Tag objects." sidebar_label: "List tags" hide_title: true hide_table_of_contents: true -api: {"operationId":"listTags","description":"Returns a list of Tag objects.","tags":["Tags"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TagsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Ticketing API"}},"required":["name"],"title":"tag"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/tags","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List tags","description":{"content":"Returns a list of Tag objects.","type":"text/plain"},"url":{"path":["tags"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listTags","description":"Returns a list of Tag objects.","tags":["Tags"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TagsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Ticketing API"}},"required":["name"],"title":"tag"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/tags","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List tags","description":{"content":"Returns a list of Tag objects.","type":"text/plain"},"url":{"path":["tags"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/list-teams.api.mdx b/docs/docs/api/v2/ticketing/list-teams.api.mdx index 1e3e3990a..5147a3943 100644 --- a/docs/docs/api/v2/ticketing/list-teams.api.mdx +++ b/docs/docs/api/v2/ticketing/list-teams.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Team objects." sidebar_label: "List teams" hide_title: true hide_table_of_contents: true -api: {"operationId":"listTeams","description":"Returns a list of Team objects.","tags":["Teams"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TeamsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Platform"},"decription":{"type":"string","nullable":true,"example":"Platform and Integrations Team"}},"required":["name"]}}},"required":["pagination","records"]}}}}},"method":"get","path":"/teams","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List teams","description":{"content":"Returns a list of Team objects.","type":"text/plain"},"url":{"path":["teams"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listTeams","description":"Returns a list of Team objects.","tags":["Teams"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TeamsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Platform"},"decription":{"type":"string","nullable":true,"example":"Platform and Integrations Team"}},"required":["name"]}}},"required":["pagination","records"]}}}}},"method":"get","path":"/teams","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List teams","description":{"content":"Returns a list of Team objects.","type":"text/plain"},"url":{"path":["teams"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/list-tickets.api.mdx b/docs/docs/api/v2/ticketing/list-tickets.api.mdx index 95f84d8eb..be9dbf6d4 100644 --- a/docs/docs/api/v2/ticketing/list-tickets.api.mdx +++ b/docs/docs/api/v2/ticketing/list-tickets.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Ticket objects." sidebar_label: "List tickets" hide_title: true hide_table_of_contents: true -api: {"operationId":"listTickets","description":"Returns a list of Ticket objects.","tags":["Tickets"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TicketsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"ticket"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/tickets","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List tickets","description":{"content":"Returns a list of Ticket objects.","type":"text/plain"},"url":{"path":["tickets"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listTickets","description":"Returns a list of Ticket objects.","tags":["Tickets"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TicketsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"ticket"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/tickets","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List tickets","description":{"content":"Returns a list of Ticket objects.","type":"text/plain"},"url":{"path":["tickets"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/list-users.api.mdx b/docs/docs/api/v2/ticketing/list-users.api.mdx index a1bf1f494..076224233 100644 --- a/docs/docs/api/v2/ticketing/list-users.api.mdx +++ b/docs/docs/api/v2/ticketing/list-users.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of User objects." sidebar_label: "List users" hide_title: true hide_table_of_contents: true -api: {"operationId":"listUsers","description":"Returns a list of User objects.","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"UsersData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/users","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List users","description":{"content":"Returns a list of User objects.","type":"text/plain"},"url":{"path":["users"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listUsers","description":"Returns a list of User objects.","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"UsersData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/users","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List users","description":{"content":"Returns a list of User objects.","type":"text/plain"},"url":{"path":["users"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/unified-ticketing-api.info.mdx b/docs/docs/api/v2/ticketing/unified-ticketing-api.info.mdx index 8c76ee01b..f5e74b045 100644 --- a/docs/docs/api/v2/ticketing/unified-ticketing-api.info.mdx +++ b/docs/docs/api/v2/ticketing/unified-ticketing-api.info.mdx @@ -13,7 +13,7 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 0.14.11 +Version: 0.14.12 diff --git a/docs/docs/api/v2/ticketing/update-ticket.api.mdx b/docs/docs/api/v2/ticketing/update-ticket.api.mdx index 817d2b03b..239b19e9d 100644 --- a/docs/docs/api/v2/ticketing/update-ticket.api.mdx +++ b/docs/docs/api/v2/ticketing/update-ticket.api.mdx @@ -5,7 +5,7 @@ description: "Updates a Ticket object with the given values." sidebar_label: "Update ticket" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateTicket","description":"Updates a Ticket object with the given values.","tags":["Tickets"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"ticket_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"update_ticket"}},"required":["record"]}}}},"responses":{"200":{"description":"Ticket updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"patch","path":"/tickets/{ticket_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"Please add more integrations","assignees":["17a54124-287f-494d-965e-3c5b330c9a68"],"creator":"3fa85f64-5717-4562-b3fc-2c963f66afa6","due_date":"2022-10-11T00:00:00Z","status":"OPEN","description":"Can you please add more integrations? It'll make syncing data much easier!","collections":["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],"ticket_type":"incident","account":"0958cbc6-6040-430a-848e-aafacbadf4ae","contact":"65c345ba-6870-4974-87ba-dd31509c367a","parent_ticket":"75b33d04-30d2-4f3e-be45-27838bc94342","tags":["enterprise"],"completed_at":"2021-12-09T00:00:00Z","ticket_url":"https://thirdpartysoftware.com/project/3/issue/1","priority":"HIGH"}},"info":{"version":"0.14.11","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Update ticket","description":{"content":"Updates a Ticket object with the given values.","type":"text/plain"},"url":{"path":["tickets",":ticket_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"ticket_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"updateTicket","description":"Updates a Ticket object with the given values.","tags":["Tickets"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"ticket_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"update_ticket"}},"required":["record"]}}}},"responses":{"200":{"description":"Ticket updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"patch","path":"/tickets/{ticket_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"Please add more integrations","assignees":["17a54124-287f-494d-965e-3c5b330c9a68"],"creator":"3fa85f64-5717-4562-b3fc-2c963f66afa6","due_date":"2022-10-11T00:00:00Z","status":"OPEN","description":"Can you please add more integrations? It'll make syncing data much easier!","collections":["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],"ticket_type":"incident","account":"0958cbc6-6040-430a-848e-aafacbadf4ae","contact":"65c345ba-6870-4974-87ba-dd31509c367a","parent_ticket":"75b33d04-30d2-4f3e-be45-27838bc94342","tags":["enterprise"],"completed_at":"2021-12-09T00:00:00Z","ticket_url":"https://thirdpartysoftware.com/project/3/issue/1","priority":"HIGH"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Update ticket","description":{"content":"Updates a Ticket object with the given values.","type":"text/plain"},"url":{"path":["tickets",":ticket_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"ticket_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "patch api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/docs/quickstart.mdx b/docs/docs/quickstart.mdx index 3f24f4e51..82f44d4bc 100644 --- a/docs/docs/quickstart.mdx +++ b/docs/docs/quickstart.mdx @@ -36,7 +36,7 @@ Create a free Supaglue Cloud account **[here](https://app.supaglue.io/sign-up)** Clone the Github repo and run the Supaglue stack locally using docker compose: ```shell -git clone -b v0.14.11 https://github.com/supaglue-labs/supaglue.git && cd supaglue +git clone -b v0.14.12 https://github.com/supaglue-labs/supaglue.git && cd supaglue ./scripts/create_quickstart_env.sh docker compose up ``` diff --git a/docs/package.json b/docs/package.json index bec2f6384..53ac0b5c4 100644 --- a/docs/package.json +++ b/docs/package.json @@ -1,6 +1,6 @@ { "name": "docs", - "version": "0.14.11", + "version": "0.14.12", "private": true, "scripts": { "docusaurus": "docusaurus", diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/create-account.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/crm/create-account.api.mdx deleted file mode 100644 index 2dfdc5555..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/create-account.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: create-account -title: "Create account" -description: "Create account" -sidebar_label: "Create account" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createAccount","tags":["Accounts"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"}},"required":["record"]}}}},"responses":{"201":{"description":"Account created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Create account","method":"post","path":"/accounts","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create account","description":{"type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/crm/unified-crm-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Create account

- - - - - - - -Create account - -## Request - -

Header Parameters

Body

required
    record objectrequired
    addresses object[]
  • Array [
  • ]
    • phone_numbers object[]
  • Array [
  • ]
    • custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
- -Account created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • record object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/create-contact.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/crm/create-contact.api.mdx deleted file mode 100644 index 319bc5b17..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/create-contact.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: create-contact -title: "Create contact" -description: "Create contact" -sidebar_label: "Create contact" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"}},"required":["record"]},"example":{"record":{"first_name":"George","last_activity_at":"2022-02-10T00:00:00Z","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"}}}}},"responses":{"201":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Create contact","method":"post","path":"/contacts","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create contact","description":{"type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/crm/unified-crm-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Create contact

- - - - - - - -Create contact - -## Request - -

Header Parameters

Body

required
    record objectrequired
    addresses object[]
  • Array [
  • ]
    • email_addresses object[]
  • Array [
  • ]
    • phone_numbers object[]
  • Array [
  • ]
    • custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
- -Contact created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • record object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/create-lead.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/crm/create-lead.api.mdx deleted file mode 100644 index 35ddd5ee3..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/create-lead.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: create-lead -title: "Create lead" -description: "Create lead" -sidebar_label: "Create lead" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"company":{"type":"string","nullable":true,"example":"Supaglue"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"title":{"type":"string","example":"Co-Founder"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"converted_contact_id":{"type":"string","nullable":true,"example":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b"},"converted_account_id":{"type":"string","nullable":true,"example":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_lead"}},"required":["record"]},"example":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder"}}}}},"responses":{"201":{"description":"Lead created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Create lead","method":"post","path":"/leads","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder","email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","converted_contact_id":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b","converted_account_id":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd","custom_fields":{}}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create lead","description":{"type":"text/plain"},"url":{"path":["leads"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/crm/unified-crm-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Create lead

- - - - - - - -Create lead - -## Request - -

Header Parameters

Body

required
    record objectrequired
    email_addresses object[]
  • Array [
  • ]
    • addresses object[]
  • Array [
  • ]
    • custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
- -Lead created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • record object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/create-opportunity.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/crm/create-opportunity.api.mdx deleted file mode 100644 index 25bac661a..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/create-opportunity.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: create-opportunity -title: "Create opportunity" -description: "Create opportunity" -sidebar_label: "Create opportunity" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"example":"2022-02-10T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"name":{"type":"string","nullable":true,"example":"Needs Integrations"},"stage":{"type":"string","example":"Closed Won"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"pipeline":{"type":"string","nullable":true},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_opportunity"}},"required":["record"]},"example":{"record":{"amount":100000,"close_date":"2023-02-27T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"109c88c0-7bf4-4cd8-afbc-b51f9432ca0b"}}}}},"responses":{"201":{"description":"Opportunity created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Create opportunity","method":"post","path":"/opportunities","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"amount":100000,"close_date":"2022-02-10T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","pipeline":"string","custom_fields":{}}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/crm/unified-crm-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Create opportunity

- - - - - - - -Create opportunity - -## Request - -

Header Parameters

Body

required
    record objectrequired
    custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
- -Opportunity created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • record object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/update-account.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/crm/update-account.api.mdx deleted file mode 100644 index cadc9724b..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/update-account.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: update-account -title: "Update account" -description: "Update account" -sidebar_label: "Update account" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"updateAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"}},"required":["record"]}}}},"responses":{"200":{"description":"Account updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Update account","method":"patch","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "patch api-method" -info_path: api/v2/crm/unified-crm-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Update account

- - - - - - - -Update account - -## Request - -

Path Parameters

Header Parameters

Body

required
    record objectrequired
    addresses object[]
  • Array [
  • ]
    • phone_numbers object[]
  • Array [
  • ]
    • custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
- -Account updated - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/update-contact.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/crm/update-contact.api.mdx deleted file mode 100644 index dfb2a1c6f..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/update-contact.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: update-contact -title: "Update contact" -description: "Update contact" -sidebar_label: "Update contact" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"updateContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"first_name":"George","last_name":"Xing","account_id":"0ce05511-adbc-4144-a049-6631c7ea3b04"}}}}}}},"responses":{"200":{"description":"Contact updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Update contact","method":"patch","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "patch api-method" -info_path: api/v2/crm/unified-crm-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Update contact

- - - - - - - -Update contact - -## Request - -

Path Parameters

Header Parameters

Body

required
    record objectrequired
    addresses object[]
  • Array [
  • ]
    • email_addresses object[]
  • Array [
  • ]
    • phone_numbers object[]
  • Array [
  • ]
    • custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
- -Contact updated - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/update-lead.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/crm/update-lead.api.mdx deleted file mode 100644 index a7e67bf50..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/update-lead.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: update-lead -title: "Update lead" -description: "Update lead" -sidebar_label: "Update lead" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"updateLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","example":"82de27cb-6f8c-4278-b783-82d1d916eddc"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"company":{"type":"string","nullable":true,"example":"Supaglue"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"title":{"type":"string","example":"Co-Founder"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"converted_contact_id":{"type":"string","nullable":true,"example":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b"},"converted_account_id":{"type":"string","nullable":true,"example":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_lead"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder"}}}}}}},"responses":{"200":{"description":"Lead updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Update lead","method":"patch","path":"/leads/{lead_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder","email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","converted_contact_id":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b","converted_account_id":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd","custom_fields":{}}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update lead","description":{"type":"text/plain"},"url":{"path":["leads",":lead_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"lead_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "patch api-method" -info_path: api/v2/crm/unified-crm-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Update lead

- - - - - - - -Update lead - -## Request - -

Path Parameters

Header Parameters

Body

required
    record objectrequired
    email_addresses object[]
  • Array [
  • ]
    • addresses object[]
  • Array [
  • ]
    • custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
- -Lead updated - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/update-opportunity.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/crm/update-opportunity.api.mdx deleted file mode 100644 index b1837fa01..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/update-opportunity.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: update-opportunity -title: "Update opportunity" -description: "Update opportunity" -sidebar_label: "Update opportunity" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"updateOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"opportunity_id","in":"path","required":true,"schema":{"type":"string","example":"c9f58083-a370-47b5-ad02-99160ea20372"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"example":"2022-02-10T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"name":{"type":"string","nullable":true,"example":"Needs Integrations"},"stage":{"type":"string","example":"Closed Won"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"pipeline":{"type":"string","nullable":true},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_opportunity"}},"required":["record"]}}}},"responses":{"200":{"description":"Opportunity updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Update opportunity","method":"patch","path":"/opportunities/{opportunity_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"amount":100000,"close_date":"2022-02-10T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","pipeline":"string","custom_fields":{}}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities",":opportunity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"opportunity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "patch api-method" -info_path: api/v2/crm/unified-crm-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Update opportunity

- - - - - - - -Update opportunity - -## Request - -

Path Parameters

Header Parameters

Body

required
    record objectrequired
    custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
- -Opportunity updated - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/upsert-account.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/crm/upsert-account.api.mdx deleted file mode 100644 index 5869b906c..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/upsert-account.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: upsert-account -title: "Upsert account" -description: "Upsert account" -sidebar_label: "Upsert account" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"upsertAccount","tags":["Accounts"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["domain"]},"values":{"type":"array","items":{"type":"string","example":"mydomain.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"responses":{"201":{"description":"Account upserted","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Upsert account","method":"post","path":"/accounts/_upsert","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}},"upsert_on":{"key":"domain","values":["mydomain.com"]}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Upsert account","description":{"type":"text/plain"},"url":{"path":["accounts","_upsert"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/crm/unified-crm-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Upsert account

- - - - - - - -Upsert account - -## Request - -

Header Parameters

Body

required
    record objectrequired
    addresses object[]
  • Array [
  • ]
    • phone_numbers object[]
  • Array [
  • ]
    • custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
    upsert_on objectrequired
- -Account upserted - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • record object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/upsert-contact.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/crm/upsert-contact.api.mdx deleted file mode 100644 index 2643aa4d0..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/upsert-contact.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: upsert-contact -title: "Upsert contact" -description: "Upsert contact" -sidebar_label: "Upsert contact" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"upsertContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["email"]},"values":{"type":"array","items":{"type":"string","example":"hello@example.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"responses":{"201":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Upsert contact","method":"post","path":"/contacts/_upsert","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}},"upsert_on":{"key":"email","values":["hello@example.com"]}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Upsert contact","description":{"type":"text/plain"},"url":{"path":["contacts","_upsert"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/crm/unified-crm-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Upsert contact

- - - - - - - -Upsert contact - -## Request - -

Header Parameters

Body

required
    record objectrequired
    addresses object[]
  • Array [
  • ]
    • email_addresses object[]
  • Array [
  • ]
    • phone_numbers object[]
  • Array [
  • ]
    • custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
    upsert_on objectrequired
- -Contact created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • record object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-account.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-account.api.mdx deleted file mode 100644 index 267ea85cf..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-account.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: create-account -title: "Create account" -description: "Create account" -sidebar_label: "Create account" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_account"}},"required":["record"]},"example":{"record":{"id":1234,"name":"My Company","domain":"mycompany.com","created_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Account created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Create account","method":"post","path":"/accounts","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"My Company","domain":"mycompany.com","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.10","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create account","description":{"type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/engagement/unified-engagement-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Create account

- - - - - - - -Create account - -## Request - -

Header Parameters

Body

required
    record objectrequired
    custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
- -Account created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • record object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-contact.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-contact.api.mdx deleted file mode 100644 index 6f4856113..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-contact.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: create-contact -title: "Create contact" -description: "Create contact" -sidebar_label: "Create contact" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_contact"}},"required":["record"]},"example":{"record":{"id":1234,"address":{"city":"San Francisco","country":"USA","street_1":"525 Brannan St","street_2":null,"postalCode":"94107","state":"CA"},"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"workline2"}],"first_name":"George","last_name":"Xing","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Create contact","method":"post","path":"/contacts","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","job_title":"CEO","address":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.10","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create contact","description":{"type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/engagement/unified-engagement-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Create contact

- - - - - - - -Create contact - -## Request - -

Header Parameters

Body

required
    record objectrequired
    address objectnullable
    email_addresses object[]
  • Array [
  • ]
    • custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
- -Contact created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • record object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-sequence-state.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-sequence-state.api.mdx deleted file mode 100644 index 5587da379..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-sequence-state.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-sequence-state -title: "Create sequence state" -description: "Create sequence state" -sidebar_label: "Create sequence state" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createSequenceState","tags":["Sequence States"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"contact_id":{"type":"string","example":"c590dc63-8e43-48a4-8154-1fbb00ac936b"},"mailbox_id":{"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d","description":"The ID of the mailbox to use for the sequence. Required for Apollo and Outreach. Unused for Salesloft."},"sequence_id":{"type":"string","example":"b854e510-1c40-4ef6-ade4-8eb35f49d331"},"user_id":{"type":"string","description":"The ID of the user who is performing the action. Required for Salesloft, optional for Apollo, unused for Outreach."}},"required":["contact_id","sequence_id"],"title":"create_sequence_state"}},"required":["record"]},"example":{"record":{"id":"355843a5-c536-4e82-b497-05160bfb7d78","state":"active","mailbox_id":"a7e860b5-cb8b-400b-812d-921fa526140c","contact_id":"6bdcebc2-f886-4de3-88ed-0b9eb420f7b1","sequence_id":"45e07817-fd59-4ec8-a727-066d2db27c9b","created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Sequence state created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Create sequence state","method":"post","path":"/sequence_states","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"contact_id":"c590dc63-8e43-48a4-8154-1fbb00ac936b","mailbox_id":"39fd1fe0-094b-4a61-b47f-3e3ac033203d","sequence_id":"b854e510-1c40-4ef6-ade4-8eb35f49d331","user_id":"string"}},"info":{"version":"0.14.10","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence state","description":{"type":"text/plain"},"url":{"path":["sequence_states"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/engagement/unified-engagement-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Create sequence state

- - - - - - - -Create sequence state - -## Request - -

Header Parameters

Body

required
    record objectrequired
- -Sequence state created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • record object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-sequence-step.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-sequence-step.api.mdx deleted file mode 100644 index ff67a6203..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-sequence-step.api.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -id: create-sequence-step -title: "Create sequence step" -description: "Create sequence step" -sidebar_label: "Create sequence step" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createSequenceStep","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_id","in":"path","required":true,"description":"The ID of the sequence.","schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"interval_seconds":{"type":"number","description":"The interval (in seconds) until this step will activate; only applicable to interval-based sequences."},"date":{"type":"string","example":"2023-01-01","description":"The date this step will activate; only applicable to date-based sequences."},"template":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"The ID of the template to use for this step."}},"required":["id"]},{"type":"object","properties":{"body":{"type":"string","description":"The body of the email (HTML)."},"subject":{"type":"string","description":"The subject of the email."},"name":{"type":"string","description":"The name of the template."},"to":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"to\" field","items":{"type":"string"}},"cc":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"cc\" field","items":{"type":"string"}},"bcc":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"bcc\" field","items":{"type":"string"}},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["body","subject","name"]}]},"is_reply":{"type":"boolean","description":"If true, this step will be sent as a reply to the previous step."},"order":{"type":"number","description":"The step's display order within its sequence."},"type":{"type":"string","enum":["auto","manual"]},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["template","is_reply","order","type"],"title":"create_sequence_step"}},"required":["record"]}}}},"responses":{"201":{"description":"Sequence step created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Create sequence step","method":"post","path":"/sequences/{sequence_id}/sequence_steps","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"interval_seconds":0,"date":"2023-01-01","template":{"id":"string"},"is_reply":true,"order":0,"type":"auto","custom_fields":{}}},"info":{"version":"0.14.10","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence step","description":{"type":"text/plain"},"url":{"path":["sequences",":sequence_id","sequence_steps"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the sequence.","type":"text/plain"},"type":"any","value":"","key":"sequence_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/engagement/unified-engagement-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Create sequence step

- - - - - - - -Create sequence step - -## Request - -

Path Parameters

Header Parameters

Body

required
    record objectrequired
    template objectrequired
    oneOf
    custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
    custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
- -Sequence step created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • record object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-sequence.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-sequence.api.mdx deleted file mode 100644 index 6f62b67ad..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/create-sequence.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: create-sequence -title: "Create sequence" -description: "Create sequence" -sidebar_label: "Create sequence" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createSequence","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"type":{"type":"string","description":"The share type of the sequence. Setting to `team` will share with the whole team. `private` will only share with the owner.","enum":["team","private"]},"owner_id":{"type":"string"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["name","type"],"title":"create_sequence"}},"required":["record"]}}}},"responses":{"201":{"description":"Sequence created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Create sequence","method":"post","path":"/sequences","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"string","tags":["string"],"type":"team","owner_id":"string","custom_fields":{}}},"info":{"version":"0.14.10","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence","description":{"type":"text/plain"},"url":{"path":["sequences"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/engagement/unified-engagement-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Create sequence

- - - - - - - -Create sequence - -## Request - -

Header Parameters

Body

required
    record objectrequired
    custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
- -Sequence created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • record object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/update-account.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/engagement/update-account.api.mdx deleted file mode 100644 index 511e396c7..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/update-account.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: update-account -title: "Update account" -description: "Update account" -sidebar_label: "Update account" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"updateAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_account"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"id":1234,"name":"My Company","domain":"mycompany.com","created_at":"2023-02-27T00:00:00Z"}}}}}}},"responses":{"200":{"description":"Account updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Update account","method":"patch","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"My Company","domain":"mycompany.com","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.10","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Update account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "patch api-method" -info_path: api/v2/engagement/unified-engagement-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Update account

- - - - - - - -Update account - -## Request - -

Path Parameters

Header Parameters

Body

required
    record objectrequired
    custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
- -Account updated - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/update-contact.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/engagement/update-contact.api.mdx deleted file mode 100644 index 91fce94bd..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/update-contact.api.mdx +++ /dev/null @@ -1,46 +0,0 @@ ---- -id: update-contact -title: "Update contact" -description: "Update contact" -sidebar_label: "Update contact" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"updateContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_contact"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"id":1234,"address":{"city":"San Francisco","country":"USA","street_1":"525 Brannan St","street_2":null,"postalCode":"94107","state":"CA"},"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"workline2"}],"first_name":"George","last_name":"Xing","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z"}}}}}}},"responses":{"200":{"description":"Contact updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Update contact","method":"patch","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","job_title":"CEO","address":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.10","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Update contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "patch api-method" -info_path: api/v2/engagement/unified-engagement-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Update contact

- - - - - - - -Update contact - -## Request - -

Path Parameters

Header Parameters

Body

required
    record objectrequired
    address objectnullable
    email_addresses object[]
  • Array [
  • ]
    • custom_fields object
    - -Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. - -
- -Contact updated - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/metadata/create-association-type.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/metadata/create-association-type.api.mdx deleted file mode 100644 index efa2f6fbf..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/metadata/create-association-type.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-association-type -title: "Create associationType" -description: "Create associationType" -sidebar_label: "Create associationType" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createAssociationType","tags":["AssociationTypes"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"source_entity_id":{"type":"string"},"target_entity_id":{"type":"string"},"suggested_key_name":{"type":"string"},"display_name":{"type":"string"},"cardinality":{"type":"string","enum":["ONE_TO_MANY"],"title":"association_type_cardinality"}},"required":["source_entity_id","target_entity_id","suggested_key_name","display_name","cardinality"],"title":"create_update_association_type"}}}},"responses":{"201":{"description":"AssociationType created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"association_type":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Create associationType","method":"post","path":"/association-types","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"source_entity_id":"string","target_entity_id":"string","suggested_key_name":"string","display_name":"string","cardinality":"ONE_TO_MANY"},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Create associationType","description":{"type":"text/plain"},"url":{"path":["association-types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/metadata/metadata-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Create associationType

- - - - - - - -Create associationType - -## Request - -

Header Parameters

Body

required
- -AssociationType created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • association_type object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/metadata/create-custom-object.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/metadata/create-custom-object.api.mdx deleted file mode 100644 index 412467118..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/metadata/create-custom-object.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-custom-object -title: "Create customObject" -description: "Create customObject" -sidebar_label: "Create customObject" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createCustomObject","tags":["CustomObjects"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"object","properties":{"suggested_name":{"type":"string","example":"ticket","description":"The name you'd like to use for the custom object. For Salesforce, we will append `__c` if necessary. For HubSpot, it will pass through as-is."},"description":{"type":"string","nullable":true,"example":"Ticket object"},"labels":{"type":"object","properties":{"singular":{"type":"string","example":"Ticket"},"plural":{"type":"string","example":"Tickets"}},"required":["singular","plural"]},"primary_field_key_name":{"type":"string","description":"The key name of the \"primary\" field. For example, in HubSpot, this is the field that will be displayed for a record in the UI by default. For Salesforce, this will be referenced as the \"Name\" field.","example":"ticket_id"},"fields":{"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string","example":"Ticket ID"},"key_name":{"type":"string","example":"ticket_id","description":"In Salesforce, this must end with `__c`."},"is_required":{"type":"boolean","example":false},"field_type":{"type":"string","enum":["string","number"],"description":"In Salesforce, when this is set to 'string', the max length will be set to 255 by default. In Salesforce, when it is set to 'number', the precision and scale will be set to 18 and 0, respectively."}},"required":["display_name","key_name","is_required","field_type"],"title":"custom_object_field"}}},"required":["suggested_name","description","labels","primary_field_key_name","fields"],"title":"create_update_custom_object"}},"required":["object"]}}}},"responses":{"201":{"description":"CustomObject created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"object":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Create customObject","method":"post","path":"/objects/custom","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"object":{"suggested_name":"ticket","description":"Ticket object","labels":{"singular":"Ticket","plural":"Tickets"},"primary_field_key_name":"ticket_id","fields":[{"display_name":"Ticket ID","key_name":"ticket_id","is_required":false,"field_type":"string"}]}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Create customObject","description":{"type":"text/plain"},"url":{"path":["objects","custom"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/metadata/metadata-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Create customObject

- - - - - - - -Create customObject - -## Request - -

Header Parameters

Body

required
    object objectrequired
    labels objectrequired
    fields object[]required
  • Array [
  • ]
- -CustomObject created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • object object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/metadata/list-properties.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/metadata/list-properties.api.mdx deleted file mode 100644 index 884547ff8..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/metadata/list-properties.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: list-properties -title: "List properties" -description: "List properties" -sidebar_label: "List properties" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"listProperties","tags":["Properties"],"security":[{"x-api-key":[]}],"parameters":[{"name":"type","in":"query","required":true,"schema":{"type":"string","enum":["common","standard","custom"]}},{"name":"name","in":"query","required":true,"schema":{"type":"string","description":"The name of the object for which you want to list properties."}},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of properties","content":{"application/json":{"schema":{"type":"object","properties":{"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"}},"required":["id","label"],"title":"property"}}},"required":["properties"]}}}}},"description":"List properties","method":"get","path":"/properties","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"List properties","description":{"type":"text/plain"},"url":{"path":["properties"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"type","value":""},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"name","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "get api-method" -info_path: api/v2/metadata/metadata-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

List properties

- - - - - - - -List properties - -## Request - -

Query Parameters

Header Parameters

- -List of properties - -
Schema
    properties object[]required
  • Array [
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/metadata/update-custom-object.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/metadata/update-custom-object.api.mdx deleted file mode 100644 index 3f14de936..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/metadata/update-custom-object.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: update-custom-object -title: "Update customObject" -description: "Update customObject" -sidebar_label: "Update customObject" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"updateCustomObject","tags":["CustomObjects"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"custom_object_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"object","properties":{"suggested_name":{"type":"string","example":"ticket","description":"The name you'd like to use for the custom object. For Salesforce, we will append `__c` if necessary. For HubSpot, it will pass through as-is."},"description":{"type":"string","nullable":true,"example":"Ticket object"},"labels":{"type":"object","properties":{"singular":{"type":"string","example":"Ticket"},"plural":{"type":"string","example":"Tickets"}},"required":["singular","plural"]},"primary_field_key_name":{"type":"string","description":"The key name of the \"primary\" field. For example, in HubSpot, this is the field that will be displayed for a record in the UI by default. For Salesforce, this will be referenced as the \"Name\" field.","example":"ticket_id"},"fields":{"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string","example":"Ticket ID"},"key_name":{"type":"string","example":"ticket_id","description":"In Salesforce, this must end with `__c`."},"is_required":{"type":"boolean","example":false},"field_type":{"type":"string","enum":["string","number"],"description":"In Salesforce, when this is set to 'string', the max length will be set to 255 by default. In Salesforce, when it is set to 'number', the precision and scale will be set to 18 and 0, respectively."}},"required":["display_name","key_name","is_required","field_type"],"title":"custom_object_field"}}},"required":["suggested_name","description","labels","primary_field_key_name","fields"],"title":"create_update_custom_object"}},"required":["object"]}}}},"responses":{"200":{"description":"CustomObject updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}],"title":"warnings"}}}}}}},"description":"Update customObject","method":"put","path":"/objects/custom/{custom_object_id}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"object":{"suggested_name":"ticket","description":"Ticket object","labels":{"singular":"Ticket","plural":"Tickets"},"primary_field_key_name":"ticket_id","fields":[{"display_name":"Ticket ID","key_name":"ticket_id","is_required":false,"field_type":"string"}]}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Update customObject","description":{"type":"text/plain"},"url":{"path":["objects","custom",":custom_object_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"custom_object_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "put api-method" -info_path: api/v2/metadata/metadata-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Update customObject

- - - - - - - -Update customObject - -## Request - -

Path Parameters

Header Parameters

Body

required
    object objectrequired
    labels objectrequired
    fields object[]required
  • Array [
  • ]
- -CustomObject updated - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/create-attachment.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/ticketing/create-attachment.api.mdx deleted file mode 100644 index cc433d0b1..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/create-attachment.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-attachment -title: "Create attachment" -description: "Creates a Attachment object with the given values." -sidebar_label: "Create attachment" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createAttachment","description":"Creates a Attachment object with the given values.","tags":["Attachments"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}},"required":["record"]}}}},"responses":{"201":{"description":"Attachment created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}]}}}}}}},"method":"post","path":"/attachments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"file_name":"Screenshot.png","ticket":"0958cbc6-6040-430a-848e-aafacbadf4ae","file_url":"http://alturl.com/p749b","content_type":"jpeg","uploaded_by":"28b54125-287f-494d-965e-3c5b330c9a68"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create attachment","description":{"content":"Creates a Attachment object with the given values.","type":"text/plain"},"url":{"path":["attachments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/ticketing/unified-ticketing-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Create attachment

- - - - - - - -Creates a Attachment object with the given values. - -## Request - -

Header Parameters

Body

required
    record objectrequired
- -Attachment created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • record object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/create-comment.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/ticketing/create-comment.api.mdx deleted file mode 100644 index a8d50a006..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/create-comment.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-comment -title: "Create comment" -description: "Creates a Comment object with the given values." -sidebar_label: "Create comment" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createComment","description":"Creates a Comment object with the given values.","tags":["Comments"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"user":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"},"contact":{"type":"string","example":"dde3fb16-b8eb-483d-81c4-b78100816f15"},"body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"html_body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"ticket":{"type":"string","nullable":true,"example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"},"is_private":{"type":"boolean","example":true}},"required":["user","body","ticket","is_private"]}},"required":["record"]}}}},"responses":{"201":{"description":"Comment created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}]}}}}}}},"method":"post","path":"/comments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"user":"17a54124-287f-494d-965e-3c5b330c9a68","contact":"dde3fb16-b8eb-483d-81c4-b78100816f15","body":"When will these integrations be done? You all should use Supaglue.","html_body":"When will these integrations be done? You all should use Supaglue.","ticket":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d","is_private":true}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create comment","description":{"content":"Creates a Comment object with the given values.","type":"text/plain"},"url":{"path":["comments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/ticketing/unified-ticketing-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Create comment

- - - - - - - -Creates a Comment object with the given values. - -## Request - -

Header Parameters

Body

required
    record objectrequired
    Supaglue."}}>
- -Comment created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • record object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/create-ticket.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/ticketing/create-ticket.api.mdx deleted file mode 100644 index f5efef52d..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/create-ticket.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: create-ticket -title: "Create ticket" -description: "Creates a Ticket object with the given values." -sidebar_label: "Create ticket" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"createTicket","description":"Creates a Ticket object with the given values.","tags":["Tickets"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"create_ticket"}},"required":["record"]}}}},"responses":{"201":{"description":"Ticket created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}]}}}}}}},"method":"post","path":"/tickets","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"Please add more integrations","assignees":["17a54124-287f-494d-965e-3c5b330c9a68"],"creator":"3fa85f64-5717-4562-b3fc-2c963f66afa6","due_date":"2022-10-11T00:00:00Z","status":"OPEN","description":"Can you please add more integrations? It'll make syncing data much easier!","collections":["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],"ticket_type":"incident","account":"0958cbc6-6040-430a-848e-aafacbadf4ae","contact":"65c345ba-6870-4974-87ba-dd31509c367a","parent_ticket":"75b33d04-30d2-4f3e-be45-27838bc94342","tags":["enterprise"],"completed_at":"2021-12-09T00:00:00Z","ticket_url":"https://thirdpartysoftware.com/project/3/issue/1","priority":"HIGH"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create ticket","description":{"content":"Creates a Ticket object with the given values.","type":"text/plain"},"url":{"path":["tickets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "post api-method" -info_path: api/v2/ticketing/unified-ticketing-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Create ticket

- - - - - - - -Creates a Ticket object with the given values. - -## Request - -

Header Parameters

Body

required
    record objectrequired
- -Ticket created - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • record object
    warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/update-ticket.api.mdx b/docs/versioned_docs/version-0.14.10/api/v2/ticketing/update-ticket.api.mdx deleted file mode 100644 index 5aaddd186..000000000 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/update-ticket.api.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: update-ticket -title: "Update ticket" -description: "Updates a Ticket object with the given values." -sidebar_label: "Update ticket" -hide_title: true -hide_table_of_contents: true -api: {"operationId":"updateTicket","description":"Updates a Ticket object with the given values.","tags":["Tickets"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"ticket_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"update_ticket"}},"required":["record"]}}}},"responses":{"200":{"description":"Ticket updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"name is a required field on model."},"problem_type":{"type":"string","example":"MISSING_REQUIRED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"irure consectetur"}}},"title":{"type":"string","example":"Missing Required Field"}},"example":[{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"irure consectetur"},"title":"Missing Required Field"},{"detail":"name is a required field on model.","problem_type":"MISSING_REQUIRED_FIELD","source":{"pointer":"et"},"title":"Missing Required Field"}]}},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","example":"An unrecognized field, age, was passed in with request data."},"problem_type":{"type":"string","example":"UNRECOGNIZED_FIELD"},"source":{"type":"object","properties":{"pointer":{"type":"string","example":"Lorem ipsum"}}},"title":{"type":"string","example":"Unrecognized Field"}}},"example":[{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"Lorem ipsum"},"title":"Unrecognized Field"},{"detail":"An unrecognized field, age, was passed in with request data.","problem_type":"UNRECOGNIZED_FIELD","source":{"pointer":"in"},"title":"Unrecognized Field"}]}}}}}}},"method":"patch","path":"/tickets/{ticket_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"Please add more integrations","assignees":["17a54124-287f-494d-965e-3c5b330c9a68"],"creator":"3fa85f64-5717-4562-b3fc-2c963f66afa6","due_date":"2022-10-11T00:00:00Z","status":"OPEN","description":"Can you please add more integrations? It'll make syncing data much easier!","collections":["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],"ticket_type":"incident","account":"0958cbc6-6040-430a-848e-aafacbadf4ae","contact":"65c345ba-6870-4974-87ba-dd31509c367a","parent_ticket":"75b33d04-30d2-4f3e-be45-27838bc94342","tags":["enterprise"],"completed_at":"2021-12-09T00:00:00Z","ticket_url":"https://thirdpartysoftware.com/project/3/issue/1","priority":"HIGH"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Update ticket","description":{"content":"Updates a Ticket object with the given values.","type":"text/plain"},"url":{"path":["tickets",":ticket_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"ticket_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} -sidebar_class_name: "patch api-method" -info_path: api/v2/ticketing/unified-ticketing-api -custom_edit_url: null ---- - -import ApiTabs from "@theme/ApiTabs"; -import DiscriminatorTabs from "@theme/DiscriminatorTabs"; -import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; -import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; -import MimeTabs from "@theme/MimeTabs"; -import ParamsItem from "@theme/ParamsItem"; -import ResponseSamples from "@theme/ResponseSamples"; -import SchemaItem from "@theme/SchemaItem"; -import SchemaTabs from "@theme/SchemaTabs"; -import TabItem from "@theme/TabItem"; - -

Update ticket

- - - - - - - -Updates a Ticket object with the given values. - -## Request - -

Path Parameters

Header Parameters

Body

required
    record objectrequired
- -Ticket updated - -
Schema
    errors object[]
  • Array [
    • source object
  • ]
    • warnings object[]
  • Array [
    • source object
  • ]
- diff --git a/docs/versioned_docs/version-0.14.10/integration-patterns/unified-api.mdx b/docs/versioned_docs/version-0.14.10/integration-patterns/unified-api.mdx deleted file mode 100644 index 60a7f082b..000000000 --- a/docs/versioned_docs/version-0.14.10/integration-patterns/unified-api.mdx +++ /dev/null @@ -1,26 +0,0 @@ -import ThemedImage from '@theme/ThemedImage'; - -# Unified API - - - -**Unified API**: Write to multiple third-party providers with a single API for the following categories: - -- [`crm`](../api/v2/crm/unified-crm-api) -- [`engagement`](../api/v2/engagement/unified-engagement-api) -- [`enrichment`](../api/v2/enrichment/unified-enrichment-api) -- [`ticketing`](../api/v2/ticketing/unified-ticketing-api) - -View the common schemas for the Unified APIs below: - -- [CRM common schema](../platform/common-schemas/crm) -- [Engagement common schema](../platform/common-schemas/engagement) -- [Enrichment common schema](../platform/common-schemas/enrichment) -- [Ticketing common schema](../platform/common-schemas/ticketing) diff --git a/docs/versioned_docs/version-0.14.10/api/introduction.mdx b/docs/versioned_docs/version-0.14.12/api/introduction.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/introduction.mdx rename to docs/versioned_docs/version-0.14.12/api/introduction.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/actions/actions-api.info.mdx b/docs/versioned_docs/version-0.14.12/api/v2/actions/actions-api.info.mdx similarity index 98% rename from docs/versioned_docs/version-0.14.10/api/v2/actions/actions-api.info.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/actions/actions-api.info.mdx index f8da309d0..22abbfbc7 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/actions/actions-api.info.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/actions/actions-api.info.mdx @@ -13,7 +13,7 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 0.14.10 +Version: 0.14.12 diff --git a/docs/versioned_docs/version-0.14.10/api/v2/actions/get-list-view-membership.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/actions/get-list-view-membership.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/actions/get-list-view-membership.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/actions/get-list-view-membership.api.mdx index 2adf13d6c..a241f2e8a 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/actions/get-list-view-membership.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/actions/get-list-view-membership.api.mdx @@ -5,7 +5,7 @@ description: "Get list view membership" sidebar_label: "Get list view membership" hide_title: true hide_table_of_contents: true -api: {"operationId":"getListViewMembership","tags":["Salesforce"],"security":[{"x-api-key":[]}],"parameters":[{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"object_type","in":"path","required":true,"schema":{"type":"string","enum":["contact","account","lead","opportunity"]}},{"name":"list_view_id","in":"path","required":true,"schema":{"type":"string","example":"220e715a-0cbc-4d2d-8420-cd729f12f094"}}],"responses":{"200":{"description":"List Views","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for a member of this list view."},"raw_data":{"type":"object","additionalProperties":true,"description":"The raw data for this list view membership.","example":{"columns":[{"fieldNameOrPath":"Id","value":"0012800000bbzSAAAY"},{"fieldNameOrPath":"Email","value":"jdoe@example.com"},{"fieldNameOrPath":"FirstName","value":"John"},{"fieldNameOrPath":"LastName","value":"Doe"},{"fieldNameOrPath":"CreatedDate","value":"Fri Aug 01 21:15:46 GMT 2014"},{"fieldNameOrPath":"LastModifiedDate","value":"Fri Aug 01 21:15:46 GMT 2014"},{"fieldNameOrPath":"SystemModstamp","value":"Fri Aug 01 21:15:46 GMT 2014"}]}}},"required":["id","raw_data"],"title":"salesforce_list_view_membership"}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":12345,"description":"The unique identifier for this list view."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"my-list","description":"The developer name of this list view."},"label":{"type":"string","example":"My List","description":"The label for this list view."},"raw_data":{"type":"object","description":"The raw data for this list view.","additionalProperties":true,"example":{"describeUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/describe","developerName":"NewThisWeek","id":"00BD0000005WcBeMAK","label":"New This Week","resultsUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/results","soqlCompatible":true,"url":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK"}}},"required":["id","name","label","raw_data"],"title":"salesforce_list_view_metadata"}},"required":["pagination","records"]}}}}},"description":"Get list view membership","method":"get","path":"/salesforce/list_views/{object_type}/{list_id}","servers":[{"url":"https://api.supaglue.io/actions/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Actions API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Actions API documentation. Actions are helpful APIs scoped to Providers. They range from handling CRUD operations on objects to performing multi-step workflows.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/actions/v2\n```\n"},"postman":{"name":"Get list view membership","description":{"type":"text/plain"},"url":{"path":["salesforce","list_views",":object_type",":list_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_type"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"list_view_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getListViewMembership","tags":["Salesforce"],"security":[{"x-api-key":[]}],"parameters":[{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"object_type","in":"path","required":true,"schema":{"type":"string","enum":["contact","account","lead","opportunity"]}},{"name":"list_view_id","in":"path","required":true,"schema":{"type":"string","example":"220e715a-0cbc-4d2d-8420-cd729f12f094"}}],"responses":{"200":{"description":"List Views","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for a member of this list view."},"raw_data":{"type":"object","additionalProperties":true,"description":"The raw data for this list view membership.","example":{"columns":[{"fieldNameOrPath":"Id","value":"0012800000bbzSAAAY"},{"fieldNameOrPath":"Email","value":"jdoe@example.com"},{"fieldNameOrPath":"FirstName","value":"John"},{"fieldNameOrPath":"LastName","value":"Doe"},{"fieldNameOrPath":"CreatedDate","value":"Fri Aug 01 21:15:46 GMT 2014"},{"fieldNameOrPath":"LastModifiedDate","value":"Fri Aug 01 21:15:46 GMT 2014"},{"fieldNameOrPath":"SystemModstamp","value":"Fri Aug 01 21:15:46 GMT 2014"}]}}},"required":["id","raw_data"],"title":"salesforce_list_view_membership"}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":12345,"description":"The unique identifier for this list view."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"my-list","description":"The developer name of this list view."},"label":{"type":"string","example":"My List","description":"The label for this list view."},"raw_data":{"type":"object","description":"The raw data for this list view.","additionalProperties":true,"example":{"describeUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/describe","developerName":"NewThisWeek","id":"00BD0000005WcBeMAK","label":"New This Week","resultsUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/results","soqlCompatible":true,"url":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK"}}},"required":["id","name","label","raw_data"],"title":"salesforce_list_view_metadata"}},"required":["pagination","records"]}}}}},"description":"Get list view membership","method":"get","path":"/salesforce/list_views/{object_type}/{list_id}","servers":[{"url":"https://api.supaglue.io/actions/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Actions API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Actions API documentation. Actions are helpful APIs scoped to Providers. They range from handling CRUD operations on objects to performing multi-step workflows.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/actions/v2\n```\n"},"postman":{"name":"Get list view membership","description":{"type":"text/plain"},"url":{"path":["salesforce","list_views",":object_type",":list_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_type"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"list_view_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/actions/actions-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/actions/list-list-viewss.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/actions/list-list-viewss.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/actions/list-list-viewss.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/actions/list-list-viewss.api.mdx index 3d409db9f..bb6a77323 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/actions/list-list-viewss.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/actions/list-list-viewss.api.mdx @@ -5,7 +5,7 @@ description: "List list views" sidebar_label: "List list views" hide_title: true hide_table_of_contents: true -api: {"operationId":"listListViewss","tags":["Salesforce"],"security":[{"x-api-key":[]}],"parameters":[{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"object_type","in":"path","required":true,"schema":{"type":"string","enum":["contact","account","lead","opportunity"]}}],"responses":{"200":{"description":"List Views","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":12345,"description":"The unique identifier for this list view."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"my-list","description":"The developer name of this list view."},"label":{"type":"string","example":"My List","description":"The label for this list view."},"raw_data":{"type":"object","description":"The raw data for this list view.","additionalProperties":true,"example":{"describeUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/describe","developerName":"NewThisWeek","id":"00BD0000005WcBeMAK","label":"New This Week","resultsUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/results","soqlCompatible":true,"url":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK"}}},"required":["id","name","label","raw_data"],"title":"salesforce_list_view_metadata"}}},"required":["pagination","records"]}}}}},"description":"List list views","method":"get","path":"/salesforce/list_views/{object_type}","servers":[{"url":"https://api.supaglue.io/actions/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Actions API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Actions API documentation. Actions are helpful APIs scoped to Providers. They range from handling CRUD operations on objects to performing multi-step workflows.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/actions/v2\n```\n"},"postman":{"name":"List list views","description":{"type":"text/plain"},"url":{"path":["salesforce","list_views",":object_type"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_type"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listListViewss","tags":["Salesforce"],"security":[{"x-api-key":[]}],"parameters":[{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"object_type","in":"path","required":true,"schema":{"type":"string","enum":["contact","account","lead","opportunity"]}}],"responses":{"200":{"description":"List Views","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":12345,"description":"The unique identifier for this list view."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"my-list","description":"The developer name of this list view."},"label":{"type":"string","example":"My List","description":"The label for this list view."},"raw_data":{"type":"object","description":"The raw data for this list view.","additionalProperties":true,"example":{"describeUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/describe","developerName":"NewThisWeek","id":"00BD0000005WcBeMAK","label":"New This Week","resultsUrl":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK/results","soqlCompatible":true,"url":"/services/data/v58.0/sobjects/Account/listviews/00BD0000005WcBeMAK"}}},"required":["id","name","label","raw_data"],"title":"salesforce_list_view_metadata"}}},"required":["pagination","records"]}}}}},"description":"List list views","method":"get","path":"/salesforce/list_views/{object_type}","servers":[{"url":"https://api.supaglue.io/actions/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Actions API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Actions API documentation. Actions are helpful APIs scoped to Providers. They range from handling CRUD operations on objects to performing multi-step workflows.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/actions/v2\n```\n"},"postman":{"name":"List list views","description":{"type":"text/plain"},"url":{"path":["salesforce","list_views",":object_type"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"object_type"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/actions/actions-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/actions/passthrough.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/actions/passthrough.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/actions/passthrough.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/actions/passthrough.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/actions/send-passthrough-request.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/actions/send-passthrough-request.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/actions/send-passthrough-request.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/actions/send-passthrough-request.api.mdx index 69a577936..2f026db14 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/actions/send-passthrough-request.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/actions/send-passthrough-request.api.mdx @@ -5,7 +5,7 @@ description: "Send request directly to a provider" sidebar_label: "Send passthrough request" hide_title: true hide_table_of_contents: true -api: {"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["path","method"],"example":{"path":"/crm/v3/schemas","method":"GET"}}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customcrm.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://api.hubapi.com/crm/v3/schemas","status":200,"headers":{"x-hubspot-ratelimit-remaining":99},"body":{"results":[{"labels":{"singular":"Contract","plural":"Contracts"},"requiredProperties":["name","description"]}]}}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/actions/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"/crm/v3/schemas","method":"GET"},"info":{"version":"0.14.10","title":"Actions API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Actions API documentation. Actions are helpful APIs scoped to Providers. They range from handling CRUD operations on objects to performing multi-step workflows.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/actions/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["path","method"],"example":{"path":"/crm/v3/schemas","method":"GET"}}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customcrm.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://api.hubapi.com/crm/v3/schemas","status":200,"headers":{"x-hubspot-ratelimit-remaining":99},"body":{"results":[{"labels":{"singular":"Contract","plural":"Contracts"},"requiredProperties":["name","description"]}]}}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/actions/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"/crm/v3/schemas","method":"GET"},"info":{"version":"0.14.12","title":"Actions API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Actions API documentation. Actions are helpful APIs scoped to Providers. They range from handling CRUD operations on objects to performing multi-step workflows.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/actions/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/actions/actions-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/actions/sidebar.js b/docs/versioned_docs/version-0.14.12/api/v2/actions/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/actions/sidebar.js rename to docs/versioned_docs/version-0.14.12/api/v2/actions/sidebar.js diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/accounts.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/accounts.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/crm/accounts.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/crm/accounts.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/contacts.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/contacts.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/crm/contacts.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/crm/contacts.tag.mdx diff --git a/docs/versioned_docs/version-0.14.12/api/v2/crm/create-account.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/create-account.api.mdx new file mode 100644 index 000000000..58444f316 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/create-account.api.mdx @@ -0,0 +1,46 @@ +--- +id: create-account +title: "Create account" +description: "Create account" +sidebar_label: "Create account" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createAccount","tags":["Accounts"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"}},"required":["record"]}}}},"responses":{"201":{"description":"Account created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create account","method":"post","path":"/accounts","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create account","description":{"type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/crm/unified-crm-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Create account

+ + + + + + + +Create account + +## Request + +

Header Parameters

Body

required
    record objectrequired
    addresses object[]
  • Array [
  • ]
    • phone_numbers object[]
  • Array [
  • ]
    • custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
+ +Account created + +
Schema
    errors object[]
  • Array [
  • ]
    • record object
    warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.12/api/v2/crm/create-contact.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/create-contact.api.mdx new file mode 100644 index 000000000..8a0f88a4d --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/create-contact.api.mdx @@ -0,0 +1,46 @@ +--- +id: create-contact +title: "Create contact" +description: "Create contact" +sidebar_label: "Create contact" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"}},"required":["record"]},"example":{"record":{"first_name":"George","last_activity_at":"2022-02-10T00:00:00Z","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"}}}}},"responses":{"201":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create contact","method":"post","path":"/contacts","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create contact","description":{"type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/crm/unified-crm-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Create contact

+ + + + + + + +Create contact + +## Request + +

Header Parameters

Body

required
    record objectrequired
    addresses object[]
  • Array [
  • ]
    • email_addresses object[]
  • Array [
  • ]
    • phone_numbers object[]
  • Array [
  • ]
    • custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
+ +Contact created + +
Schema
    errors object[]
  • Array [
  • ]
    • record object
    warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.12/api/v2/crm/create-lead.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/create-lead.api.mdx new file mode 100644 index 000000000..630b3b0e0 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/create-lead.api.mdx @@ -0,0 +1,46 @@ +--- +id: create-lead +title: "Create lead" +description: "Create lead" +sidebar_label: "Create lead" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"company":{"type":"string","nullable":true,"example":"Supaglue"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"title":{"type":"string","example":"Co-Founder"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"converted_contact_id":{"type":"string","nullable":true,"example":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b"},"converted_account_id":{"type":"string","nullable":true,"example":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_lead"}},"required":["record"]},"example":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder"}}}}},"responses":{"201":{"description":"Lead created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create lead","method":"post","path":"/leads","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder","email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","converted_contact_id":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b","converted_account_id":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create lead","description":{"type":"text/plain"},"url":{"path":["leads"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/crm/unified-crm-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Create lead

+ + + + + + + +Create lead + +## Request + +

Header Parameters

Body

required
    record objectrequired
    email_addresses object[]
  • Array [
  • ]
    • addresses object[]
  • Array [
  • ]
    • custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
+ +Lead created + +
Schema
    errors object[]
  • Array [
  • ]
    • record object
    warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.12/api/v2/crm/create-opportunity.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/create-opportunity.api.mdx new file mode 100644 index 000000000..305ab4298 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/create-opportunity.api.mdx @@ -0,0 +1,46 @@ +--- +id: create-opportunity +title: "Create opportunity" +description: "Create opportunity" +sidebar_label: "Create opportunity" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"example":"2022-02-10T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"name":{"type":"string","nullable":true,"example":"Needs Integrations"},"stage":{"type":"string","example":"Closed Won"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"pipeline":{"type":"string","nullable":true},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_opportunity"}},"required":["record"]},"example":{"record":{"amount":100000,"close_date":"2023-02-27T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"109c88c0-7bf4-4cd8-afbc-b51f9432ca0b"}}}}},"responses":{"201":{"description":"Opportunity created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create opportunity","method":"post","path":"/opportunities","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"amount":100000,"close_date":"2022-02-10T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","pipeline":"string","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Create opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/crm/unified-crm-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Create opportunity

+ + + + + + + +Create opportunity + +## Request + +

Header Parameters

Body

required
    record objectrequired
    custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
+ +Opportunity created + +
Schema
    errors object[]
  • Array [
  • ]
    • record object
    warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/get-account.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/get-account.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/crm/get-account.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/crm/get-account.api.mdx index 160fd537e..1eef3dde8 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/get-account.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/get-account.api.mdx @@ -5,7 +5,7 @@ description: "Get account" sidebar_label: "Get account" hide_title: true hide_table_of_contents: true -api: {"operationId":"getAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Account","content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"examples":{"Example":{"value":{"addresses":[{"address_type":"BILLING","city":"San Francisco","country":"CX","postal_code":"94107","state":"CA","street1":"525 Brannan","street2":null},{"address_type":"BILLING","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street1":"525 Brannan","street2":null}],"description":"Integration API","id":1234,"industry":"API's","last_activity_at":"2022-02-10T00:00:00Z","name":"Supaglue","number_of_employees":276000,"owner_id":"9377fd4d-d420-4e0b-93ea-789078a3eab4","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z","website":"https://supaglue.com/"}}}}}}},"description":"Get account","method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Account","content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"examples":{"Example":{"value":{"addresses":[{"address_type":"BILLING","city":"San Francisco","country":"CX","postal_code":"94107","state":"CA","street1":"525 Brannan","street2":null},{"address_type":"BILLING","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street1":"525 Brannan","street2":null}],"description":"Integration API","id":1234,"industry":"API's","last_activity_at":"2022-02-10T00:00:00Z","name":"Supaglue","number_of_employees":276000,"owner_id":"9377fd4d-d420-4e0b-93ea-789078a3eab4","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z","website":"https://supaglue.com/"}}}}}}},"description":"Get account","method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/get-contact.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/get-contact.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/crm/get-contact.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/crm/get-contact.api.mdx index ed5bce471..7be99f82c 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/get-contact.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/get-contact.api.mdx @@ -5,7 +5,7 @@ description: "Get contact" sidebar_label: "Get contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"getContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"}}}}},"description":"Get contact","method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"}}}}},"description":"Get contact","method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/get-lead.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/get-lead.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/crm/get-lead.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/crm/get-lead.api.mdx index c80fcf6d5..90ecd1b8c 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/get-lead.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/get-lead.api.mdx @@ -5,7 +5,7 @@ description: "Get lead" sidebar_label: "Get lead" hide_title: true hide_table_of_contents: true -api: {"operationId":"getLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","example":"82de27cb-6f8c-4278-b783-82d1d916eddc"}}],"responses":{"200":{"description":"Lead","content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"company":{"type":"string","nullable":true,"example":"Supaglue"},"converted_account_id":{"type":"string","nullable":true,"example":"88cc44ca-7a34-4e8b-b0da-51c3aae34daf"},"converted_account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"converted_contact_id":{"type":"string","nullable":true,"example":"8c8de778-a219-4d6c-848c-1d57b52149f6"},"converted_contact":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"},"converted_date":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"owner_id":{"type":"string","nullable":true,"example":"62e5e0f7-becd-4ae2-be82-8b4e1d5ed8a2"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"title":{"type":"string","nullable":true,"example":"Co-Founder"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-10T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-10T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","company","converted_account_id","converted_contact_id","converted_date","id","last_name","lead_source","owner_id","phone_numbers","title","created_at","updated_at","is_deleted","last_modified_at"],"title":"lead"}}}}},"description":"Get lead","method":"get","path":"/leads/{lead_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get lead","description":{"type":"text/plain"},"url":{"path":["leads",":lead_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"lead_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","example":"82de27cb-6f8c-4278-b783-82d1d916eddc"}}],"responses":{"200":{"description":"Lead","content":{"application/json":{"schema":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"company":{"type":"string","nullable":true,"example":"Supaglue"},"converted_account_id":{"type":"string","nullable":true,"example":"88cc44ca-7a34-4e8b-b0da-51c3aae34daf"},"converted_account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"converted_contact_id":{"type":"string","nullable":true,"example":"8c8de778-a219-4d6c-848c-1d57b52149f6"},"converted_contact":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["account_id","owner_id","description","id","addresses","email_addresses","first_name","last_activity_at","last_name","phone_numbers","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"},"converted_date":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"first_name":{"type":"string","nullable":true,"example":"George"},"id":{"type":"string","example":54312},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"owner_id":{"type":"string","nullable":true,"example":"62e5e0f7-becd-4ae2-be82-8b4e1d5ed8a2"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"title":{"type":"string","nullable":true,"example":"Co-Founder"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-10T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-10T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","company","converted_account_id","converted_contact_id","converted_date","id","last_name","lead_source","owner_id","phone_numbers","title","created_at","updated_at","is_deleted","last_modified_at"],"title":"lead"}}}}},"description":"Get lead","method":"get","path":"/leads/{lead_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get lead","description":{"type":"text/plain"},"url":{"path":["leads",":lead_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"lead_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/get-opportunity.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/get-opportunity.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/crm/get-opportunity.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/crm/get-opportunity.api.mdx index 866ce7180..01e363b98 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/get-opportunity.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/get-opportunity.api.mdx @@ -5,7 +5,7 @@ description: "Get opportunity" sidebar_label: "Get opportunity" hide_title: true hide_table_of_contents: true -api: {"operationId":"getOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"opportunity_id","in":"path","required":true,"schema":{"type":"string","example":"c9f58083-a370-47b5-ad02-99160ea20372"}}],"responses":{"200":{"description":"Opportunity","content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Needs third-party integrations"},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"pipeline":{"type":"string","nullable":true},"stage":{"type":"string","nullable":true,"example":"Closed Won"},"status":{"type":"string","nullable":true,"example":"OPEN"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["account_id","amount","description","id","last_activity_at","name","owner_id","stage","status","pipeline","created_at","updated_at","is_deleted","last_modified_at"],"title":"opportunity"},"examples":{"Example":{"value":{"account":{"id":"a329053d-bf86-4b82-8356-9e897aa7dacc"},"amount":100000,"close_date":"2023-02-27T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","id":1234,"last_activity_at":"2023-02-27T00:00:00Z","name":"Needs third-party integrations","owner":"93b0c2b5-26a8-4b92-b4e5-05d764eb1119","created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z","stage":"Closed Won"}}}}}}},"description":"Get opportunity","method":"get","path":"/opportunities/{opportunity_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities",":opportunity_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"opportunity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"opportunity_id","in":"path","required":true,"schema":{"type":"string","example":"c9f58083-a370-47b5-ad02-99160ea20372"}}],"responses":{"200":{"description":"Opportunity","content":{"application/json":{"schema":{"type":"object","properties":{"account_id":{"type":"string","nullable":true,"example":"fd089246-09b1-4e3b-a60a-7a76314bbcce"},"account":{"type":"object","properties":{"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"description":{"type":"string","nullable":true,"example":"Integration API"},"id":{"type":"string","example":1234},"industry":{"type":"string","nullable":true,"example":"API's"},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["addresses","description","id","industry","last_activity_at","name","number_of_employees","owner_id","phone_numbers","website","lifecycle_stage","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"},"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"id":{"type":"string","example":54312},"last_activity_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"name":{"type":"string","nullable":true,"example":"Needs third-party integrations"},"owner_id":{"type":"string","nullable":true,"example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"owner":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"},"pipeline":{"type":"string","nullable":true},"stage":{"type":"string","nullable":true,"example":"Closed Won"},"status":{"type":"string","nullable":true,"example":"OPEN"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2023-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["account_id","amount","description","id","last_activity_at","name","owner_id","stage","status","pipeline","created_at","updated_at","is_deleted","last_modified_at"],"title":"opportunity"},"examples":{"Example":{"value":{"account":{"id":"a329053d-bf86-4b82-8356-9e897aa7dacc"},"amount":100000,"close_date":"2023-02-27T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","id":1234,"last_activity_at":"2023-02-27T00:00:00Z","name":"Needs third-party integrations","owner":"93b0c2b5-26a8-4b92-b4e5-05d764eb1119","created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z","stage":"Closed Won"}}}}}}},"description":"Get opportunity","method":"get","path":"/opportunities/{opportunity_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities",":opportunity_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"opportunity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/get-user.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/get-user.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/crm/get-user.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/crm/get-user.api.mdx index 12da6306e..63919cd34 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/get-user.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/get-user.api.mdx @@ -5,7 +5,7 @@ description: "Get user" sidebar_label: "Get user" hide_title: true hide_table_of_contents: true -api: {"operationId":"getUser","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"}}}}},"description":"Get user","method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get user","description":{"type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getUser","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"name":{"type":"string","nullable":true,"example":"George Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"is_active":{"type":"boolean","nullable":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","name","email","is_active","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"}}}}},"description":"Get user","method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Get user","description":{"type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/leads.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/leads.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/crm/leads.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/crm/leads.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/opportunities.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/opportunities.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/crm/opportunities.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/crm/opportunities.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/passthrough.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/passthrough.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/crm/passthrough.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/crm/passthrough.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/send-passthrough-request.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/send-passthrough-request.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/crm/send-passthrough-request.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/crm/send-passthrough-request.api.mdx index 6be7ae336..c201e343d 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/send-passthrough-request.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/send-passthrough-request.api.mdx @@ -5,7 +5,7 @@ description: "Send request directly to a provider" sidebar_label: "Send passthrough request" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["path","method"]}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customcrm.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://customcrm.com/api/cars","status":200,"headers":{"x-requests-limit":96},"body":[]}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"string","method":"GET","headers":{},"query":{},"body":"string"},"info":{"version":"0.14.10","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["path","method"]}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customcrm.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://customcrm.com/api/cars","status":200,"headers":{"x-requests-limit":96},"body":[]}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"string","method":"GET","headers":{},"query":{},"body":"string"},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/crm/unified-crm-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/sidebar.js b/docs/versioned_docs/version-0.14.12/api/v2/crm/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/crm/sidebar.js rename to docs/versioned_docs/version-0.14.12/api/v2/crm/sidebar.js diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/unified-crm-api.info.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/unified-crm-api.info.mdx similarity index 98% rename from docs/versioned_docs/version-0.14.10/api/v2/crm/unified-crm-api.info.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/crm/unified-crm-api.info.mdx index 17384a33e..533921ce0 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/crm/unified-crm-api.info.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/unified-crm-api.info.mdx @@ -13,7 +13,7 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 0.14.10 +Version: 0.14.12 diff --git a/docs/versioned_docs/version-0.14.12/api/v2/crm/update-account.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/update-account.api.mdx new file mode 100644 index 000000000..6bc21b980 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/update-account.api.mdx @@ -0,0 +1,46 @@ +--- +id: update-account +title: "Update account" +description: "Update account" +sidebar_label: "Update account" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"}},"required":["record"]}}}},"responses":{"200":{"description":"Account updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update account","method":"patch","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "patch api-method" +info_path: api/v2/crm/unified-crm-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Update account

+ + + + + + + +Update account + +## Request + +

Path Parameters

Header Parameters

Body

required
    record objectrequired
    addresses object[]
  • Array [
  • ]
    • phone_numbers object[]
  • Array [
  • ]
    • custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
+ +Account updated + +
Schema
    errors object[]
  • Array [
  • ]
    • warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.12/api/v2/crm/update-contact.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/update-contact.api.mdx new file mode 100644 index 000000000..bd1f184db --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/update-contact.api.mdx @@ -0,0 +1,46 @@ +--- +id: update-contact +title: "Update contact" +description: "Update contact" +sidebar_label: "Update contact" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"first_name":"George","last_name":"Xing","account_id":"0ce05511-adbc-4144-a049-6631c7ea3b04"}}}}}}},"responses":{"200":{"description":"Contact updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update contact","method":"patch","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "patch api-method" +info_path: api/v2/crm/unified-crm-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Update contact

+ + + + + + + +Update contact + +## Request + +

Path Parameters

Header Parameters

Body

required
    record objectrequired
    addresses object[]
  • Array [
  • ]
    • email_addresses object[]
  • Array [
  • ]
    • phone_numbers object[]
  • Array [
  • ]
    • custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
+ +Contact updated + +
Schema
    errors object[]
  • Array [
  • ]
    • warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.12/api/v2/crm/update-lead.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/update-lead.api.mdx new file mode 100644 index 000000000..1cb0c64cb --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/update-lead.api.mdx @@ -0,0 +1,46 @@ +--- +id: update-lead +title: "Update lead" +description: "Update lead" +sidebar_label: "Update lead" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateLead","tags":["Leads"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"lead_id","in":"path","required":true,"schema":{"type":"string","example":"82de27cb-6f8c-4278-b783-82d1d916eddc"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"company":{"type":"string","nullable":true,"example":"Supaglue"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"lead_source":{"type":"string","nullable":true,"example":"API Blogger"},"title":{"type":"string","example":"Co-Founder"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"converted_contact_id":{"type":"string","nullable":true,"example":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b"},"converted_account_id":{"type":"string","nullable":true,"example":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_lead"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder"}}}}}}},"responses":{"200":{"description":"Lead updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update lead","method":"patch","path":"/leads/{lead_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"company":"Supaglue","first_name":"George","last_name":"Xing","lead_source":"API Blogger","title":"Co-Founder","email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","converted_contact_id":"ad43955d-2b27-4ec3-b38a-0ca07a76d43b","converted_account_id":"2e1e6813-0459-47f5-ad4c-3d137c0e1fdd","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update lead","description":{"type":"text/plain"},"url":{"path":["leads",":lead_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"lead_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "patch api-method" +info_path: api/v2/crm/unified-crm-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Update lead

+ + + + + + + +Update lead + +## Request + +

Path Parameters

Header Parameters

Body

required
    record objectrequired
    email_addresses object[]
  • Array [
  • ]
    • addresses object[]
  • Array [
  • ]
    • custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
+ +Lead updated + +
Schema
    errors object[]
  • Array [
  • ]
    • warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.12/api/v2/crm/update-opportunity.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/update-opportunity.api.mdx new file mode 100644 index 000000000..a843b9a5c --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/update-opportunity.api.mdx @@ -0,0 +1,46 @@ +--- +id: update-opportunity +title: "Update opportunity" +description: "Update opportunity" +sidebar_label: "Update opportunity" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateOpportunity","tags":["Opportunities"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"opportunity_id","in":"path","required":true,"schema":{"type":"string","example":"c9f58083-a370-47b5-ad02-99160ea20372"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"amount":{"type":"integer","nullable":true,"example":100000},"close_date":{"type":"string","nullable":true,"example":"2022-02-10T00:00:00Z"},"description":{"type":"string","nullable":true,"example":"Wants to use open source unified API for third-party integrations"},"name":{"type":"string","nullable":true,"example":"Needs Integrations"},"stage":{"type":"string","example":"Closed Won"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"pipeline":{"type":"string","nullable":true},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_opportunity"}},"required":["record"]}}}},"responses":{"200":{"description":"Opportunity updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update opportunity","method":"patch","path":"/opportunities/{opportunity_id}","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"amount":100000,"close_date":"2022-02-10T00:00:00Z","description":"Wants to use open source unified API for third-party integrations","name":"Needs Integrations","stage":"Closed Won","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","pipeline":"string","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Update opportunity","description":{"type":"text/plain"},"url":{"path":["opportunities",":opportunity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"opportunity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "patch api-method" +info_path: api/v2/crm/unified-crm-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Update opportunity

+ + + + + + + +Update opportunity + +## Request + +

Path Parameters

Header Parameters

Body

required
    record objectrequired
    custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
+ +Opportunity updated + +
Schema
    errors object[]
  • Array [
  • ]
    • warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.12/api/v2/crm/upsert-account.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/upsert-account.api.mdx new file mode 100644 index 000000000..013d5de6d --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/upsert-account.api.mdx @@ -0,0 +1,46 @@ +--- +id: upsert-account +title: "Upsert account" +description: "Upsert account" +sidebar_label: "Upsert account" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"upsertAccount","tags":["Accounts"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"description":{"type":"string","nullable":true,"example":"Integration API"},"industry":{"type":"string","nullable":true,"example":"API's"},"name":{"type":"string","nullable":true,"example":"Sample Customer"},"number_of_employees":{"type":"integer","nullable":true,"example":276000},"website":{"type":"string","nullable":true,"example":"https://supaglue.com/"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_account"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["domain"]},"values":{"type":"array","items":{"type":"string","example":"mydomain.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"responses":{"201":{"description":"Account upserted","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Upsert account","method":"post","path":"/accounts/_upsert","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"description":"Integration API","industry":"API's","name":"Sample Customer","number_of_employees":276000,"website":"https://supaglue.com/","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}},"upsert_on":{"key":"domain","values":["mydomain.com"]}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Upsert account","description":{"type":"text/plain"},"url":{"path":["accounts","_upsert"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/crm/unified-crm-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Upsert account

+ + + + + + + +Upsert account + +## Request + +

Header Parameters

Body

required
    record objectrequired
    addresses object[]
  • Array [
  • ]
    • phone_numbers object[]
  • Array [
  • ]
    • custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
    upsert_on objectrequired
+ +Account upserted + +
Schema
    errors object[]
  • Array [
  • ]
    • record object
    warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.12/api/v2/crm/upsert-contact.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/upsert-contact.api.mdx new file mode 100644 index 000000000..d2012d4c9 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/crm/upsert-contact.api.mdx @@ -0,0 +1,46 @@ +--- +id: upsert-contact +title: "Upsert contact" +description: "Upsert contact" +sidebar_label: "Upsert contact" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"upsertContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"account_id":{"type":"string","nullable":true,"example":"64571bff-48ea-4469-9fa0-ee1a0bab38bd"},"addresses":{"type":"array","items":{"type":"object","properties":{"address_type":{"type":"string","enum":["primary","mailing","other","billing","shipping"]},"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["address_type","city","country","postal_code","state","street_1","street_2"]},"example":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"addresses"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","enum":["primary","work","other"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","enum":["primary","mobile","fax","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"title":"phone_numbers"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"lifecycle_stage":{"type":"string","nullable":true,"enum":["subscriber","lead","marketingqualifiedlead","salesqualifiedlead","opportunity","customer","evangelist","other"],"title":"lifecycle_stage"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_update_contact"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["email"]},"values":{"type":"array","items":{"type":"string","example":"hello@example.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"responses":{"201":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Upsert contact","method":"post","path":"/contacts/_upsert","servers":[{"url":"https://api.supaglue.io/crm/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","account_id":"64571bff-48ea-4469-9fa0-ee1a0bab38bd","addresses":[{"address_type":"shipping","city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"primary"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","lifecycle_stage":"subscriber","custom_fields":{}},"upsert_on":{"key":"email","values":["hello@example.com"]}},"info":{"version":"0.14.12","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API documentation for CRM. You can use this API to write to multiple third-party providers within the CRM category.\n\n[View common schema for CRM](https://docs.supaglue.com/platform/common-schemas/crm)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/crm/v2\n```\n"},"postman":{"name":"Upsert contact","description":{"type":"text/plain"},"url":{"path":["contacts","_upsert"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/crm/unified-crm-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Upsert contact

+ + + + + + + +Upsert contact + +## Request + +

Header Parameters

Body

required
    record objectrequired
    addresses object[]
  • Array [
  • ]
    • email_addresses object[]
  • Array [
  • ]
    • phone_numbers object[]
  • Array [
  • ]
    • custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
    upsert_on objectrequired
+ +Contact created + +
Schema
    errors object[]
  • Array [
  • ]
    • record object
    warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.10/api/v2/crm/users.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/crm/users.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/crm/users.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/crm/users.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/data/data-listing-api.info.mdx b/docs/versioned_docs/version-0.14.12/api/v2/data/data-listing-api.info.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/data/data-listing-api.info.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/data/data-listing-api.info.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/data/hubspot.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/data/hubspot.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/data/hubspot.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/data/hubspot.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/data/list-hubspot-companies.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/data/list-hubspot-companies.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/data/list-hubspot-companies.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/data/list-hubspot-companies.api.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/data/list-hubspot-contacts.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/data/list-hubspot-contacts.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/data/list-hubspot-contacts.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/data/list-hubspot-contacts.api.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/data/list-salesforce-accounts.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/data/list-salesforce-accounts.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/data/list-salesforce-accounts.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/data/list-salesforce-accounts.api.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/data/list-salesforce-contacts.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/data/list-salesforce-contacts.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/data/list-salesforce-contacts.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/data/list-salesforce-contacts.api.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/data/salesforce.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/data/salesforce.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/data/salesforce.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/data/salesforce.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/data/sidebar.js b/docs/versioned_docs/version-0.14.12/api/v2/data/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/data/sidebar.js rename to docs/versioned_docs/version-0.14.12/api/v2/data/sidebar.js diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/accounts.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/accounts.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/accounts.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/accounts.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/contacts.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/contacts.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/contacts.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/contacts.tag.mdx diff --git a/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-account.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-account.api.mdx new file mode 100644 index 000000000..5abb49116 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-account.api.mdx @@ -0,0 +1,46 @@ +--- +id: create-account +title: "Create account" +description: "Create account" +sidebar_label: "Create account" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_account"}},"required":["record"]},"example":{"record":{"id":1234,"name":"My Company","domain":"mycompany.com","created_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Account created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create account","method":"post","path":"/accounts","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"My Company","domain":"mycompany.com","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create account","description":{"type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/engagement/unified-engagement-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Create account

+ + + + + + + +Create account + +## Request + +

Header Parameters

Body

required
    record objectrequired
    custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
+ +Account created + +
Schema
    errors object[]
  • Array [
  • ]
    • record object
    warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-contact.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-contact.api.mdx new file mode 100644 index 000000000..00157c78b --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-contact.api.mdx @@ -0,0 +1,46 @@ +--- +id: create-contact +title: "Create contact" +description: "Create contact" +sidebar_label: "Create contact" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_contact"}},"required":["record"]},"example":{"record":{"id":1234,"address":{"city":"San Francisco","country":"USA","street_1":"525 Brannan St","street_2":null,"postalCode":"94107","state":"CA"},"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"workline2"}],"first_name":"George","last_name":"Xing","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Contact created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create contact","method":"post","path":"/contacts","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","job_title":"CEO","address":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create contact","description":{"type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/engagement/unified-engagement-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Create contact

+ + + + + + + +Create contact + +## Request + +

Header Parameters

Body

required
    record objectrequired
    address objectnullable
    email_addresses object[]
  • Array [
  • ]
    • custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
+ +Contact created + +
Schema
    errors object[]
  • Array [
  • ]
    • record object
    warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-sequence-state.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-sequence-state.api.mdx new file mode 100644 index 000000000..253e25459 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-sequence-state.api.mdx @@ -0,0 +1,42 @@ +--- +id: create-sequence-state +title: "Create sequence state" +description: "Create sequence state" +sidebar_label: "Create sequence state" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createSequenceState","tags":["Sequence States"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"contact_id":{"type":"string","example":"c590dc63-8e43-48a4-8154-1fbb00ac936b"},"mailbox_id":{"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d","description":"The ID of the mailbox to use for the sequence. Required for Apollo and Outreach. Unused for Salesloft."},"sequence_id":{"type":"string","example":"b854e510-1c40-4ef6-ade4-8eb35f49d331"},"user_id":{"type":"string","description":"The ID of the user who is performing the action. Required for Salesloft, optional for Apollo, unused for Outreach."}},"required":["contact_id","sequence_id"],"title":"create_sequence_state"}},"required":["record"]},"example":{"record":{"id":"355843a5-c536-4e82-b497-05160bfb7d78","state":"active","mailbox_id":"a7e860b5-cb8b-400b-812d-921fa526140c","contact_id":"6bdcebc2-f886-4de3-88ed-0b9eb420f7b1","sequence_id":"45e07817-fd59-4ec8-a727-066d2db27c9b","created_at":"2023-02-27T00:00:00Z","updated_at":"2023-02-27T00:00:00Z"}}}}},"responses":{"201":{"description":"Sequence state created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create sequence state","method":"post","path":"/sequence_states","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"contact_id":"c590dc63-8e43-48a4-8154-1fbb00ac936b","mailbox_id":"39fd1fe0-094b-4a61-b47f-3e3ac033203d","sequence_id":"b854e510-1c40-4ef6-ade4-8eb35f49d331","user_id":"string"}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence state","description":{"type":"text/plain"},"url":{"path":["sequence_states"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/engagement/unified-engagement-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Create sequence state

+ + + + + + + +Create sequence state + +## Request + +

Header Parameters

Body

required
    record objectrequired
+ +Sequence state created + +
Schema
    errors object[]
  • Array [
  • ]
    • record object
    warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-sequence-step.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-sequence-step.api.mdx new file mode 100644 index 000000000..c4162bb8a --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-sequence-step.api.mdx @@ -0,0 +1,50 @@ +--- +id: create-sequence-step +title: "Create sequence step" +description: "Create sequence step" +sidebar_label: "Create sequence step" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createSequenceStep","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_id","in":"path","required":true,"description":"The ID of the sequence.","schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"interval_seconds":{"type":"number","description":"The interval (in seconds) until this step will activate; only applicable to interval-based sequences."},"date":{"type":"string","example":"2023-01-01","description":"The date this step will activate; only applicable to date-based sequences."},"template":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","description":"The ID of the template to use for this step."}},"required":["id"]},{"type":"object","properties":{"body":{"type":"string","description":"The body of the email (HTML)."},"subject":{"type":"string","description":"The subject of the email."},"name":{"type":"string","description":"The name of the template."},"to":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"to\" field","items":{"type":"string"}},"cc":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"cc\" field","items":{"type":"string"}},"bcc":{"type":"array","description":"A list of default person and email address pairs to receive this template in the \"bcc\" field","items":{"type":"string"}},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["body","subject","name"]}]},"is_reply":{"type":"boolean","description":"If true, this step will be sent as a reply to the previous step."},"order":{"type":"number","description":"The step's display order within its sequence."},"type":{"type":"string","enum":["auto","manual"]},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["template","is_reply","order","type"],"title":"create_sequence_step"}},"required":["record"]}}}},"responses":{"201":{"description":"Sequence step created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create sequence step","method":"post","path":"/sequences/{sequence_id}/sequence_steps","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"interval_seconds":0,"date":"2023-01-01","template":{"id":"string"},"is_reply":true,"order":0,"type":"auto","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence step","description":{"type":"text/plain"},"url":{"path":["sequences",":sequence_id","sequence_steps"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID of the sequence.","type":"text/plain"},"type":"any","value":"","key":"sequence_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/engagement/unified-engagement-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Create sequence step

+ + + + + + + +Create sequence step + +## Request + +

Path Parameters

Header Parameters

Body

required
    record objectrequired
    template objectrequired
    oneOf
    custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
    custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
+ +Sequence step created + +
Schema
    errors object[]
  • Array [
  • ]
    • record object
    warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-sequence.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-sequence.api.mdx new file mode 100644 index 000000000..f3237574a --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/create-sequence.api.mdx @@ -0,0 +1,46 @@ +--- +id: create-sequence +title: "Create sequence" +description: "Create sequence" +sidebar_label: "Create sequence" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createSequence","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"type":{"type":"string","description":"The share type of the sequence. Setting to `team` will share with the whole team. `private` will only share with the owner.","enum":["team","private"]},"owner_id":{"type":"string"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"required":["name","type"],"title":"create_sequence"}},"required":["record"]}}}},"responses":{"201":{"description":"Sequence created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"],"title":"created_record"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create sequence","method":"post","path":"/sequences","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"string","tags":["string"],"type":"team","owner_id":"string","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Create sequence","description":{"type":"text/plain"},"url":{"path":["sequences"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/engagement/unified-engagement-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Create sequence

+ + + + + + + +Create sequence + +## Request + +

Header Parameters

Body

required
    record objectrequired
    custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
+ +Sequence created + +
Schema
    errors object[]
  • Array [
  • ]
    • record object
    warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/get-account.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/get-account.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/get-account.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/get-account.api.mdx index b66f32595..1ea5e5eb1 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/get-account.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/get-account.api.mdx @@ -5,7 +5,7 @@ description: "Get account" sidebar_label: "Get account" hide_title: true hide_table_of_contents: true -api: {"operationId":"getAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Account","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["id","owner_id","name","domain","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"}}}}},"description":"Get account","method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Account","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["id","owner_id","name","domain","created_at","updated_at","is_deleted","last_modified_at"],"title":"account"}}}}},"description":"Get account","method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/get-contact.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/get-contact.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/get-contact.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/get-contact.api.mdx index a10af1a0d..9c30413bd 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/get-contact.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/get-contact.api.mdx @@ -5,7 +5,7 @@ description: "Get contact" sidebar_label: "Get contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"getContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"account_id":{"type":"string","nullable":true,"example":"45edea5a-0b9a-44ff-bd45-4452014eb4fa"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","nullable":true,"enum":["primary","work","home","mobile","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"work"}]},"open_count":{"type":"number"},"click_count":{"type":"number"},"reply_count":{"type":"number"},"bounced_count":{"type":"number"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["id","owner_id","first_name","last_name","job_title","address","email_addresses","phone_numbers","open_count","click_count","reply_count","bounced_count","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"}}}}},"description":"Get contact","method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Contact","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"owner_id":{"type":"string","nullable":true,"example":"23e640fe-6105-4a11-a636-3aa6b6c6e762"},"account_id":{"type":"string","nullable":true,"example":"45edea5a-0b9a-44ff-bd45-4452014eb4fa"},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"phone_numbers":{"type":"array","items":{"type":"object","properties":{"phone_number":{"type":"string","nullable":true,"example":"+14151234567"},"phone_number_type":{"type":"string","nullable":true,"enum":["primary","work","home","mobile","other"]}},"required":["phone_number","phone_number_type"]},"example":[{"phone_number":"+14151234567","phone_number_type":"work"}]},"open_count":{"type":"number"},"click_count":{"type":"number"},"reply_count":{"type":"number"},"bounced_count":{"type":"number"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"},"raw_data":{"type":"object","additionalProperties":true}},"required":["id","owner_id","first_name","last_name","job_title","address","email_addresses","phone_numbers","open_count","click_count","reply_count","bounced_count","created_at","updated_at","is_deleted","last_modified_at"],"title":"contact"}}}}},"description":"Get contact","method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/get-mailbox.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/get-mailbox.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/get-mailbox.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/get-mailbox.api.mdx index 34c31a892..690329103 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/get-mailbox.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/get-mailbox.api.mdx @@ -5,7 +5,7 @@ description: "Get mailbox" sidebar_label: "Get mailbox" hide_title: true hide_table_of_contents: true -api: {"operationId":"getMailbox","tags":["Mailboxes"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"mailbox_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Mailbox","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"email":{"type":"string","nullable":true,"example":null},"user_id":{"nullable":true,"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","email","user_id","created_at","updated_at","is_deleted","last_modified_at"],"title":"mailbox"}}}}},"description":"Get mailbox","method":"get","path":"/mailboxes/{mailbox_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get mailbox","description":{"type":"text/plain"},"url":{"path":["mailboxes",":mailbox_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"mailbox_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getMailbox","tags":["Mailboxes"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"mailbox_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Mailbox","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"email":{"type":"string","nullable":true,"example":null},"user_id":{"nullable":true,"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","email","user_id","created_at","updated_at","is_deleted","last_modified_at"],"title":"mailbox"}}}}},"description":"Get mailbox","method":"get","path":"/mailboxes/{mailbox_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get mailbox","description":{"type":"text/plain"},"url":{"path":["mailboxes",":mailbox_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"mailbox_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/get-sequence-state.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/get-sequence-state.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/get-sequence-state.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/get-sequence-state.api.mdx index 6392570e1..9c021ed19 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/get-sequence-state.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/get-sequence-state.api.mdx @@ -5,7 +5,7 @@ description: "Get sequence state" sidebar_label: "Get sequence state" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSequenceState","tags":["Sequence States"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_state_id","in":"path","required":true,"schema":{"type":"string","example":"ffb62704-addd-454e-bb86-ed0799703dc6"}}],"responses":{"200":{"description":"Sequence State","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"state":{"type":"string","nullable":true,"example":"active"},"contact_id":{"type":"string","nullable":true,"example":"c590dc63-8e43-48a4-8154-1fbb00ac936b"},"mailbox_id":{"nullable":true,"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d"},"user_id":{"nullable":true,"type":"string","example":"ab0530ef-61dd-4a99-b26b-6b5a61c7c62e"},"sequence_id":{"nullable":true,"type":"string","example":"b854e510-1c40-4ef6-ade4-8eb35f49d331"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","state","mailbox_id","user_id","contact_id","sequence_id","created_at","updated_at","is_deleted","last_modified_at"],"title":"sequence_state"}}}}},"description":"Get sequence state","method":"get","path":"/sequence_states/{sequence_state_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get sequence state","description":{"type":"text/plain"},"url":{"path":["sequence_states",":sequence_state_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sequence_state_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSequenceState","tags":["Sequence States"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_state_id","in":"path","required":true,"schema":{"type":"string","example":"ffb62704-addd-454e-bb86-ed0799703dc6"}}],"responses":{"200":{"description":"Sequence State","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"state":{"type":"string","nullable":true,"example":"active"},"contact_id":{"type":"string","nullable":true,"example":"c590dc63-8e43-48a4-8154-1fbb00ac936b"},"mailbox_id":{"nullable":true,"type":"string","example":"39fd1fe0-094b-4a61-b47f-3e3ac033203d"},"user_id":{"nullable":true,"type":"string","example":"ab0530ef-61dd-4a99-b26b-6b5a61c7c62e"},"sequence_id":{"nullable":true,"type":"string","example":"b854e510-1c40-4ef6-ade4-8eb35f49d331"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","state","mailbox_id","user_id","contact_id","sequence_id","created_at","updated_at","is_deleted","last_modified_at"],"title":"sequence_state"}}}}},"description":"Get sequence state","method":"get","path":"/sequence_states/{sequence_state_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get sequence state","description":{"type":"text/plain"},"url":{"path":["sequence_states",":sequence_state_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sequence_state_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/get-sequence.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/get-sequence.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/get-sequence.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/get-sequence.api.mdx index 2e0e57554..2384949b3 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/get-sequence.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/get-sequence.api.mdx @@ -5,7 +5,7 @@ description: "Get sequence" sidebar_label: "Get sequence" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSequence","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Sequence","content":{"application/json":{"schema":{"type":"object","properties":{"owner_id":{"type":"string","nullable":true,"example":"95fe0d29-e8cc-48ac-9afd-e02d8037a597"},"id":{"type":"string","example":54312},"is_enabled":{"type":"boolean","example":true},"name":{"nullable":true,"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"num_steps":{"type":"number"},"metrics":{"type":"object","additionalProperties":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","is_enabled","name","tags","num_steps","metrics","created_at","updated_at","last_modified_at"],"title":"sequence"}}}}},"description":"Get sequence","method":"get","path":"/sequences/{sequence_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get sequence","description":{"type":"text/plain"},"url":{"path":["sequences",":sequence_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sequence_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSequence","tags":["Sequences"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"sequence_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"Sequence","content":{"application/json":{"schema":{"type":"object","properties":{"owner_id":{"type":"string","nullable":true,"example":"95fe0d29-e8cc-48ac-9afd-e02d8037a597"},"id":{"type":"string","example":54312},"is_enabled":{"type":"boolean","example":true},"name":{"nullable":true,"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"num_steps":{"type":"number"},"metrics":{"type":"object","additionalProperties":true},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","is_enabled","name","tags","num_steps","metrics","created_at","updated_at","last_modified_at"],"title":"sequence"}}}}},"description":"Get sequence","method":"get","path":"/sequences/{sequence_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get sequence","description":{"type":"text/plain"},"url":{"path":["sequences",":sequence_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sequence_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/get-user.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/get-user.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/get-user.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/get-user.api.mdx index d606edcfc..f0897e4f5 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/get-user.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/get-user.api.mdx @@ -5,7 +5,7 @@ description: "Get user" sidebar_label: "Get user" hide_title: true hide_table_of_contents: true -api: {"operationId":"getUser","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","first_name","last_name","email","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"}}}}},"description":"Get user","method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get user","description":{"type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getUser","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"User","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":54312},"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"email":{"type":"string","nullable":true,"example":"george@supaglue.com"},"created_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"updated_at":{"type":"string","nullable":true,"format":"date-time","example":"2022-02-27T00:00:00Z"},"is_deleted":{"type":"boolean","example":false},"last_modified_at":{"type":"string","format":"date-time","example":"2022-02-27T00:00:00Z"}},"required":["id","first_name","last_name","email","created_at","updated_at","is_deleted","last_modified_at"],"title":"user"}}}}},"description":"Get user","method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Get user","description":{"type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/mailboxes.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/mailboxes.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/mailboxes.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/mailboxes.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/passthrough.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/passthrough.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/passthrough.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/passthrough.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/send-passthrough-request.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/send-passthrough-request.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/send-passthrough-request.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/send-passthrough-request.api.mdx index 12b175366..c7d0c2dd4 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/send-passthrough-request.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/send-passthrough-request.api.mdx @@ -5,7 +5,7 @@ description: "Send request directly to a provider" sidebar_label: "Send passthrough request" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["path","method"]}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customengagement.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://customengagement.com/api/cars","status":200,"headers":{"x-requests-limit":96},"body":[]}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"string","method":"GET","headers":{},"query":{},"body":"string"},"info":{"version":"0.14.10","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"sendPassthroughRequest","tags":["Passthrough"],"security":[{"x-api-key":[]}],"description":"Send request directly to a provider","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"path":{"type":"string","description":"The path to send the request to (do not pass the domain)"},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE"],"example":"GET"},"headers":{"type":"object","description":"Headers to pass to downstream","additionalProperties":{"type":"string"}},"query":{"type":"object","description":"Query parameters to pass to downstream","additionalProperties":{"type":"string"}},"body":{"description":"Body to pass to downstream (can be string or JSON object)","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["path","method"]}}}},"responses":{"200":{"description":"Passthrough response","content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"The full URL the request was went to","example":"https://customengagement.com/api/cars"},"status":{"type":"number","description":"Status code from the downstream","example":200},"headers":{"type":"object","description":"The response headers from the downstream","additionalProperties":{"type":"string"}},"body":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"integer"},{"type":"boolean"},{"type":"array","items":{"additionalProperties":true}},{"type":"object","additionalProperties":true}],"description":"The body from the downstream"}},"required":["url","status","headers"]},"examples":{"Example":{"value":{"url":"https://customengagement.com/api/cars","status":200,"headers":{"x-requests-limit":96},"body":[]}}}}}}},"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true}],"method":"post","path":"/passthrough","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"path":"string","method":"GET","headers":{},"query":{},"body":"string"},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Send passthrough request","description":{"content":"Send request directly to a provider","type":"text/plain"},"url":{"path":["passthrough"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/engagement/unified-engagement-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/sequence-states.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/sequence-states.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/sequence-states.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/sequence-states.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/sequences.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/sequences.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/sequences.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/sequences.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/sidebar.js b/docs/versioned_docs/version-0.14.12/api/v2/engagement/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/sidebar.js rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/sidebar.js diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/unified-engagement-api.info.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/unified-engagement-api.info.mdx similarity index 98% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/unified-engagement-api.info.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/unified-engagement-api.info.mdx index fae69d769..15992a033 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/engagement/unified-engagement-api.info.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/unified-engagement-api.info.mdx @@ -13,7 +13,7 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 0.14.10 +Version: 0.14.12 diff --git a/docs/versioned_docs/version-0.14.12/api/v2/engagement/update-account.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/update-account.api.mdx new file mode 100644 index 000000000..ba27a98a7 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/update-account.api.mdx @@ -0,0 +1,46 @@ +--- +id: update-account +title: "Update account" +description: "Update account" +sidebar_label: "Update account" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateAccount","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"My Company"},"domain":{"type":"string","nullable":true,"example":"mycompany.com"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_account"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"id":1234,"name":"My Company","domain":"mycompany.com","created_at":"2023-02-27T00:00:00Z"}}}}}}},"responses":{"200":{"description":"Account updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update account","method":"patch","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"My Company","domain":"mycompany.com","owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Update account","description":{"type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "patch api-method" +info_path: api/v2/engagement/unified-engagement-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Update account

+ + + + + + + +Update account + +## Request + +

Path Parameters

Header Parameters

Body

required
    record objectrequired
    custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
+ +Account updated + +
Schema
    errors object[]
  • Array [
  • ]
    • warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.12/api/v2/engagement/update-contact.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/update-contact.api.mdx new file mode 100644 index 000000000..fe83a7f5a --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/engagement/update-contact.api.mdx @@ -0,0 +1,46 @@ +--- +id: update-contact +title: "Update contact" +description: "Update contact" +sidebar_label: "Update contact" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateContact","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"outreach"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"example":"George"},"last_name":{"type":"string","nullable":true,"example":"Xing"},"job_title":{"type":"string","nullable":true,"example":"CEO"},"address":{"type":"object","nullable":true,"properties":{"city":{"type":"string","nullable":true,"example":"San Francisco"},"country":{"type":"string","nullable":true,"example":"USA"},"postal_code":{"type":"string","nullable":true,"example":"94107"},"state":{"type":"string","nullable":true,"example":"CA"},"street_1":{"type":"string","nullable":true,"example":"525 Brannan"},"street_2":{"type":"string","nullable":true,"example":null}},"required":["city","country","postal_code","state","street_1","street_2"],"example":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"title":"address"},"email_addresses":{"type":"array","items":{"type":"object","properties":{"email_address":{"type":"string","example":"hello@supaglue.com"},"email_address_type":{"type":"string","nullable":true,"enum":["primary","personal","work"]}},"required":["email_address","email_address_type"]},"example":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"title":"email_addresses"},"owner_id":{"type":"string","nullable":true,"example":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5"},"account_id":{"type":"string","nullable":true,"example":"ae4be028-9078-4850-a0bf-d2112b7c4d11"},"custom_fields":{"type":"object","additionalProperties":true,"description":"Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API.","title":"custom_fields"}},"title":"create_contact"}},"required":["record"]},"examples":{"Example":{"value":{"record":{"id":1234,"address":{"city":"San Francisco","country":"USA","street_1":"525 Brannan St","street_2":null,"postalCode":"94107","state":"CA"},"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"workline2"}],"first_name":"George","last_name":"Xing","phone_numbers":[{"phone_number":"+14151234567","phone_number_type":"mobile"}],"created_at":"2023-02-27T00:00:00Z"}}}}}}},"responses":{"200":{"description":"Contact updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update contact","method":"patch","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/engagement/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"first_name":"George","last_name":"Xing","job_title":"CEO","address":[{"city":"San Francisco","country":"US","postal_code":"94107","state":"CA","street_1":"525 Brannan","street_2":null}],"email_addresses":[{"email_address":"hello@supaglue.com","email_address_type":"work"}],"owner_id":"9f3e97fd-4d5d-4efc-959d-bbebfac079f5","account_id":"ae4be028-9078-4850-a0bf-d2112b7c4d11","custom_fields":{}}},"info":{"version":"0.14.12","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API documentation for Engagement. You can use this API to write to multiple third-party providers within the Engagement category.\n\n[View common schema for Engagement](https://docs.supaglue.com/platform/common-schemas/engagement)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/engagement/v2\n```\n"},"postman":{"name":"Update contact","description":{"type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "patch api-method" +info_path: api/v2/engagement/unified-engagement-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Update contact

+ + + + + + + +Update contact + +## Request + +

Path Parameters

Header Parameters

Body

required
    record objectrequired
    address objectnullable
    email_addresses object[]
  • Array [
  • ]
    • custom_fields object
    + +Custom properties to be inserted that are not covered by the common object. Object keys must match exactly to the corresponding provider API. + +
+ +Contact updated + +
Schema
    errors object[]
  • Array [
  • ]
    • warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.10/api/v2/engagement/users.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/engagement/users.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/engagement/users.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/engagement/users.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/enrichment/enrich-person.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/enrichment/enrich-person.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/enrichment/enrich-person.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/enrichment/enrich-person.api.mdx index 453a8e0af..adfe88df1 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/enrichment/enrich-person.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/enrichment/enrich-person.api.mdx @@ -5,7 +5,7 @@ description: "Enrich person" sidebar_label: "Enrich person" hide_title: true hide_table_of_contents: true -api: {"operationId":"enrichPerson","tags":["Persons"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"PersonEnrichmentData","content":{"application/json":{"schema":{"type":"object","properties":{"company":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"6sense"},"industry":{"type":"string","nullable":true,"example":"Software and Technology"},"annual_revenue":{"type":"number","nullable":true,"example":104000000},"domain":{"type":"string","nullable":true,"example":"6sense.com"},"employee_count":{"type":"number","nullable":true,"example":1192}},"required":["name","industry","annual_revenue","domain","employee_count"],"title":"enriched_company"}},"required":["company"]}}}}},"description":"Enrich person","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"email","in":"query","required":true,"schema":{"type":"string","example":"alicesmith@gmail.com"}}],"method":"get","path":"/persons","servers":[{"url":"https://api.supaglue.io/enrichment/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Enrichment API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Enrichment) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Enrichment](https://docs.supaglue.com/platform/common-schemas/enrichment)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/enrichment/v2\n```\n"},"postman":{"name":"Enrich person","description":{"type":"text/plain"},"url":{"path":["persons"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"email","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"enrichPerson","tags":["Persons"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"PersonEnrichmentData","content":{"application/json":{"schema":{"type":"object","properties":{"company":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"6sense"},"industry":{"type":"string","nullable":true,"example":"Software and Technology"},"annual_revenue":{"type":"number","nullable":true,"example":104000000},"domain":{"type":"string","nullable":true,"example":"6sense.com"},"employee_count":{"type":"number","nullable":true,"example":1192}},"required":["name","industry","annual_revenue","domain","employee_count"],"title":"enriched_company"}},"required":["company"]}}}}},"description":"Enrich person","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"email","in":"query","required":true,"schema":{"type":"string","example":"alicesmith@gmail.com"}}],"method":"get","path":"/persons","servers":[{"url":"https://api.supaglue.io/enrichment/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Enrichment API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Enrichment) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Enrichment](https://docs.supaglue.com/platform/common-schemas/enrichment)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/enrichment/v2\n```\n"},"postman":{"name":"Enrich person","description":{"type":"text/plain"},"url":{"path":["persons"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"email","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/enrichment/unified-enrichment-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/enrichment/persons.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/enrichment/persons.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/enrichment/persons.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/enrichment/persons.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/enrichment/sidebar.js b/docs/versioned_docs/version-0.14.12/api/v2/enrichment/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/enrichment/sidebar.js rename to docs/versioned_docs/version-0.14.12/api/v2/enrichment/sidebar.js diff --git a/docs/versioned_docs/version-0.14.10/api/v2/enrichment/unified-enrichment-api.info.mdx b/docs/versioned_docs/version-0.14.12/api/v2/enrichment/unified-enrichment-api.info.mdx similarity index 98% rename from docs/versioned_docs/version-0.14.10/api/v2/enrichment/unified-enrichment-api.info.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/enrichment/unified-enrichment-api.info.mdx index 27cd5c116..2ecc7b14b 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/enrichment/unified-enrichment-api.info.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/enrichment/unified-enrichment-api.info.mdx @@ -13,7 +13,7 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 0.14.10 +Version: 0.14.12 diff --git a/docs/versioned_docs/version-0.14.10/api/v2/marketing-automation/forms.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/marketing-automation/forms.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/marketing-automation/forms.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/marketing-automation/forms.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/marketing-automation/get-form-fields.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/marketing-automation/get-form-fields.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/marketing-automation/get-form-fields.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/marketing-automation/get-form-fields.api.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/marketing-automation/list-forms.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/marketing-automation/list-forms.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/marketing-automation/list-forms.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/marketing-automation/list-forms.api.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/marketing-automation/sidebar.js b/docs/versioned_docs/version-0.14.12/api/v2/marketing-automation/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/marketing-automation/sidebar.js rename to docs/versioned_docs/version-0.14.12/api/v2/marketing-automation/sidebar.js diff --git a/docs/versioned_docs/version-0.14.10/api/v2/marketing-automation/submit-form.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/marketing-automation/submit-form.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/marketing-automation/submit-form.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/marketing-automation/submit-form.api.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/marketing-automation/unified-enrichment-api.info.mdx b/docs/versioned_docs/version-0.14.12/api/v2/marketing-automation/unified-enrichment-api.info.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/marketing-automation/unified-enrichment-api.info.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/marketing-automation/unified-enrichment-api.info.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/metadata/association-types.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/metadata/association-types.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/metadata/association-types.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/metadata/association-types.tag.mdx diff --git a/docs/versioned_docs/version-0.14.12/api/v2/metadata/create-association-type.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/metadata/create-association-type.api.mdx new file mode 100644 index 000000000..6552e39e4 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/metadata/create-association-type.api.mdx @@ -0,0 +1,42 @@ +--- +id: create-association-type +title: "Create associationType" +description: "Create associationType" +sidebar_label: "Create associationType" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createAssociationType","tags":["AssociationTypes"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"source_entity_id":{"type":"string"},"target_entity_id":{"type":"string"},"suggested_key_name":{"type":"string"},"display_name":{"type":"string"},"cardinality":{"type":"string","enum":["ONE_TO_MANY"],"title":"association_type_cardinality"}},"required":["source_entity_id","target_entity_id","suggested_key_name","display_name","cardinality"],"title":"create_update_association_type"}}}},"responses":{"201":{"description":"AssociationType created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"association_type":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create associationType","method":"post","path":"/association-types","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"source_entity_id":"string","target_entity_id":"string","suggested_key_name":"string","display_name":"string","cardinality":"ONE_TO_MANY"},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Create associationType","description":{"type":"text/plain"},"url":{"path":["association-types"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/metadata/metadata-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Create associationType

+ + + + + + + +Create associationType + +## Request + +

Header Parameters

Body

required
+ +AssociationType created + +
Schema
    errors object[]
  • Array [
  • ]
    • association_type object
    warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.12/api/v2/metadata/create-custom-object.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/metadata/create-custom-object.api.mdx new file mode 100644 index 000000000..998c0aa90 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/metadata/create-custom-object.api.mdx @@ -0,0 +1,42 @@ +--- +id: create-custom-object +title: "Create customObject" +description: "Create customObject" +sidebar_label: "Create customObject" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createCustomObject","tags":["CustomObjects"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"object","properties":{"suggested_name":{"type":"string","example":"ticket","description":"The name you'd like to use for the custom object. For Salesforce, we will append `__c` if necessary. For HubSpot, it will pass through as-is."},"description":{"type":"string","nullable":true,"example":"Ticket object"},"labels":{"type":"object","properties":{"singular":{"type":"string","example":"Ticket"},"plural":{"type":"string","example":"Tickets"}},"required":["singular","plural"]},"primary_field_key_name":{"type":"string","description":"The key name of the \"primary\" field. For example, in HubSpot, this is the field that will be displayed for a record in the UI by default. For Salesforce, this will be referenced as the \"Name\" field.","example":"ticket_id"},"fields":{"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string","example":"Ticket ID"},"key_name":{"type":"string","example":"ticket_id","description":"In Salesforce, this must end with `__c`."},"is_required":{"type":"boolean","example":false},"field_type":{"type":"string","enum":["string","number"],"description":"In Salesforce, when this is set to 'string', the max length will be set to 255 by default. In Salesforce, when it is set to 'number', the precision and scale will be set to 18 and 0, respectively."}},"required":["display_name","key_name","is_required","field_type"],"title":"custom_object_field"}}},"required":["suggested_name","description","labels","primary_field_key_name","fields"],"title":"create_update_custom_object"}},"required":["object"]}}}},"responses":{"201":{"description":"CustomObject created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"object":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Create customObject","method":"post","path":"/objects/custom","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"object":{"suggested_name":"ticket","description":"Ticket object","labels":{"singular":"Ticket","plural":"Tickets"},"primary_field_key_name":"ticket_id","fields":[{"display_name":"Ticket ID","key_name":"ticket_id","is_required":false,"field_type":"string"}]}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Create customObject","description":{"type":"text/plain"},"url":{"path":["objects","custom"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/metadata/metadata-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Create customObject

+ + + + + + + +Create customObject + +## Request + +

Header Parameters

Body

required
    object objectrequired
    labels objectrequired
    fields object[]required
  • Array [
  • ]
+ +CustomObject created + +
Schema
    errors object[]
  • Array [
  • ]
    • object object
    warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.10/api/v2/metadata/custom-objects.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/metadata/custom-objects.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/metadata/custom-objects.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/metadata/custom-objects.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/metadata/get-association-types.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/metadata/get-association-types.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/metadata/get-association-types.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/metadata/get-association-types.api.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/metadata/get-custom-object.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/metadata/get-custom-object.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/metadata/get-custom-object.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/metadata/get-custom-object.api.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/metadata/list-custom-objects.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/metadata/list-custom-objects.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/metadata/list-custom-objects.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/metadata/list-custom-objects.api.mdx diff --git a/docs/versioned_docs/version-0.14.12/api/v2/metadata/list-properties.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/metadata/list-properties.api.mdx new file mode 100644 index 000000000..793beb983 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/metadata/list-properties.api.mdx @@ -0,0 +1,42 @@ +--- +id: list-properties +title: "List properties" +description: "List properties" +sidebar_label: "List properties" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"listProperties","tags":["Properties"],"security":[{"x-api-key":[]}],"parameters":[{"name":"type","in":"query","required":true,"schema":{"type":"string","enum":["standard","custom"]}},{"name":"name","in":"query","required":true,"schema":{"type":"string","description":"The name of the object for which you want to list properties."}},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of properties","content":{"application/json":{"schema":{"type":"object","properties":{"properties":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The machine name of the property as it appears in the third-party Provider.","example":"FirstName"},"label":{"type":"string","description":"The human-readable name of the property as provided by the third-party Provider.","example":"First Name"},"type":{"type":"string","description":"The type of the property as provided by the third-party Provider. For Intercom, this is string, integer, boolean, or object.","example":"string"}},"required":["id","label"],"title":"property"}}},"required":["properties"]}}}}},"description":"List properties","method":"get","path":"/properties","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"List properties","description":{"type":"text/plain"},"url":{"path":["properties"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"type","value":""},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"name","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "get api-method" +info_path: api/v2/metadata/metadata-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

List properties

+ + + + + + + +List properties + +## Request + +

Query Parameters

Header Parameters

+ +List of properties + +
Schema
    properties object[]required
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.10/api/v2/metadata/list-standard-objects.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/metadata/list-standard-objects.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/metadata/list-standard-objects.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/metadata/list-standard-objects.api.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/metadata/metadata-api.info.mdx b/docs/versioned_docs/version-0.14.12/api/v2/metadata/metadata-api.info.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/metadata/metadata-api.info.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/metadata/metadata-api.info.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/metadata/properties.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/metadata/properties.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/metadata/properties.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/metadata/properties.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/metadata/sidebar.js b/docs/versioned_docs/version-0.14.12/api/v2/metadata/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/metadata/sidebar.js rename to docs/versioned_docs/version-0.14.12/api/v2/metadata/sidebar.js diff --git a/docs/versioned_docs/version-0.14.10/api/v2/metadata/standard-objects.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/metadata/standard-objects.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/metadata/standard-objects.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/metadata/standard-objects.tag.mdx diff --git a/docs/versioned_docs/version-0.14.12/api/v2/metadata/update-custom-object.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/metadata/update-custom-object.api.mdx new file mode 100644 index 000000000..d1f356abe --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/metadata/update-custom-object.api.mdx @@ -0,0 +1,42 @@ +--- +id: update-custom-object +title: "Update customObject" +description: "Update customObject" +sidebar_label: "Update customObject" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateCustomObject","tags":["CustomObjects"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"custom_object_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"object","properties":{"suggested_name":{"type":"string","example":"ticket","description":"The name you'd like to use for the custom object. For Salesforce, we will append `__c` if necessary. For HubSpot, it will pass through as-is."},"description":{"type":"string","nullable":true,"example":"Ticket object"},"labels":{"type":"object","properties":{"singular":{"type":"string","example":"Ticket"},"plural":{"type":"string","example":"Tickets"}},"required":["singular","plural"]},"primary_field_key_name":{"type":"string","description":"The key name of the \"primary\" field. For example, in HubSpot, this is the field that will be displayed for a record in the UI by default. For Salesforce, this will be referenced as the \"Name\" field.","example":"ticket_id"},"fields":{"type":"array","items":{"type":"object","properties":{"display_name":{"type":"string","example":"Ticket ID"},"key_name":{"type":"string","example":"ticket_id","description":"In Salesforce, this must end with `__c`."},"is_required":{"type":"boolean","example":false},"field_type":{"type":"string","enum":["string","number"],"description":"In Salesforce, when this is set to 'string', the max length will be set to 255 by default. In Salesforce, when it is set to 'number', the precision and scale will be set to 18 and 0, respectively."}},"required":["display_name","key_name","is_required","field_type"],"title":"custom_object_field"}}},"required":["suggested_name","description","labels","primary_field_key_name","fields"],"title":"create_update_custom_object"}},"required":["object"]}}}},"responses":{"200":{"description":"CustomObject updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]},"title":"errors"},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}},"title":"warnings"}}}}}}},"description":"Update customObject","method":"put","path":"/objects/custom/{custom_object_id}","servers":[{"url":"https://api.supaglue.io/metadata/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"object":{"suggested_name":"ticket","description":"Ticket object","labels":{"singular":"Ticket","plural":"Tickets"},"primary_field_key_name":"ticket_id","fields":[{"display_name":"Ticket ID","key_name":"ticket_id","is_required":false,"field_type":"string"}]}},"info":{"version":"0.13.1","title":"Metadata API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Metadata API documentation for CRM. You can use this API to operate on metadata across multiple third-party providers.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/metadata/v2\n```\n"},"postman":{"name":"Update customObject","description":{"type":"text/plain"},"url":{"path":["objects","custom",":custom_object_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"custom_object_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "put api-method" +info_path: api/v2/metadata/metadata-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

Update customObject

+ + + + + + + +Update customObject + +## Request + +

Path Parameters

Header Parameters

Body

required
    object objectrequired
    labels objectrequired
    fields object[]required
  • Array [
  • ]
+ +CustomObject updated + +
Schema
    errors object[]
  • Array [
  • ]
    • warnings object[]
  • Array [
  • ]
+ diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/connection-created.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/connection-created.api.mdx similarity index 98% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/connection-created.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/connection-created.api.mdx index 4950619c0..2a11b9330 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/connection-created.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/connection-created.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the creation of a connection for a customer" sidebar_label: "Customer connection created" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of the creation of a connection for a customer","operationId":"connectionCreated","x-event-type":"connection.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"connection.created","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"salesforce","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["connection.created"],"example":"connection.created"},"customer_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"provider_id":{"type":"string","example":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]}},"required":["webhook_event_type","customer_id","provider_id","category","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"connection.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"connection.created","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"hubspot","result":"SUCCESS"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of the creation of a connection for a customer","operationId":"connectionCreated","x-event-type":"connection.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"connection.created","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"salesforce","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["connection.created"],"example":"connection.created"},"customer_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"provider_id":{"type":"string","example":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]}},"required":["webhook_event_type","customer_id","provider_id","category","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"connection.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"connection.created","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"hubspot","result":"SUCCESS"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/connection-deleted.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/connection-deleted.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/connection-deleted.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/connection-deleted.api.mdx index ab9ab42e1..e8e98eb7e 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/connection-deleted.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/connection-deleted.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the deletion of a connection for a customer" sidebar_label: "Customer connection deleted" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of the deletion of a connection for a customer","operationId":"connectionDeleted","x-event-type":"connection.deleted","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"connection.deleted","connection_id":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"salesforce","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["connection.deleted"],"example":"connection.deleted"},"connection_id":{"type":"string","example":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b"},"customer_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"provider_id":{"type":"string","example":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]}},"required":["webhook_event_type","connection_id","customer_id","provider_id","category","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"connection.deleted"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"connection.deleted","connection_id":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"hubspot","result":"SUCCESS"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of the deletion of a connection for a customer","operationId":"connectionDeleted","x-event-type":"connection.deleted","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"connection.deleted","connection_id":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"salesforce","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["connection.deleted"],"example":"connection.deleted"},"connection_id":{"type":"string","example":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b"},"customer_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"provider_id":{"type":"string","example":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]}},"required":["webhook_event_type","connection_id","customer_id","provider_id","category","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"connection.deleted"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"connection.deleted","connection_id":"6b0abaf8-076d-48e7-9cdf-f12c68e86e2b","customer_id":"e30cbb93-5b05-4186-b6de-1acc10013795","provider_id":"5a4dbac6-3a56-4ad9-8aa3-e7b7f00be024","category":"crm","provider_name":"hubspot","result":"SUCCESS"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/connection-sync-configs.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/connection-sync-configs.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/connection-sync-configs.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/connection-sync-configs.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/connections.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/connections.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/connections.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/connections.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-connection.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-connection.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-connection.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-connection.api.mdx index 96ca8eeb5..48abb4b8d 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-connection.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-connection.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint is for providers that use API key or access key for sidebar_label: "Create a connection" hide_title: true hide_table_of_contents: true -api: {"operationId":"createConnection","description":"This endpoint is for providers that use API key or access key for authentication. Please use [Embedded Links](https://docs.supaglue.com/platform/managed-auth#oauth-20) for providers that support Oauth2 for authentication.","tags":["Connections"],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"apollo","properties":{"provider_name":{"type":"string","enum":["apollo"],"example":"apollo"},"type":{"type":"string","enum":["api_key"],"example":"api_key"},"api_key":{"type":"string","description":"API key for the connected customer.","example":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"}},"required":["provider_name","type","api_key"]},{"type":"object","title":"gong","properties":{"provider_name":{"type":"string","enum":["gong"],"example":"gong"},"type":{"type":"string","enum":["access_key_secret"],"example":"access_key_secret"},"access_key":{"type":"string","description":"Access key for the connected customer.","example":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"},"access_key_secret":{"type":"string","description":"Access key secret for the connected customer.","example":"258a80aa-2e9b-40b0-8d7a-28f858a856f3"}},"required":["provider_name","type","access_key","access_key_secret"]},{"type":"object","title":"salesforce","properties":{"provider_name":{"type":"string","enum":["salesforce"],"example":"salesforce"},"type":{"type":"string","enum":["oauth2"],"example":"oauth2"},"refresh_token":{"type":"string"},"instance_url":{"type":"string"},"login_url":{"type":"string"}},"required":["provider_name","type","refresh_token","instance_url"]},{"type":"object","title":"hubspot","properties":{"provider_name":{"type":"string","enum":["hubspot"],"example":"hubspot"},"type":{"type":"string","enum":["oauth2"],"example":"oauth2"},"refresh_token":{"type":"string"}},"required":["provider_name","type","refresh_token"]}]}}}},"responses":{"200":{"description":"Connection created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}}}},"method":"post","path":"/customers/{customer_id}/connections","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"provider_name":"apollo","type":"api_key","api_key":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create a connection","description":{"content":"This endpoint is for providers that use API key or access key for authentication. Please use [Embedded Links](https://docs.supaglue.com/platform/managed-auth#oauth-20) for providers that support Oauth2 for authentication.","type":"text/plain"},"url":{"path":["customers",":customer_id","connections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createConnection","description":"This endpoint is for providers that use API key or access key for authentication. Please use [Embedded Links](https://docs.supaglue.com/platform/managed-auth#oauth-20) for providers that support Oauth2 for authentication.","tags":["Connections"],"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"apollo","properties":{"provider_name":{"type":"string","enum":["apollo"],"example":"apollo"},"type":{"type":"string","enum":["api_key"],"example":"api_key"},"api_key":{"type":"string","description":"API key for the connected customer.","example":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"}},"required":["provider_name","type","api_key"]},{"type":"object","title":"gong","properties":{"provider_name":{"type":"string","enum":["gong"],"example":"gong"},"type":{"type":"string","enum":["access_key_secret"],"example":"access_key_secret"},"access_key":{"type":"string","description":"Access key for the connected customer.","example":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"},"access_key_secret":{"type":"string","description":"Access key secret for the connected customer.","example":"258a80aa-2e9b-40b0-8d7a-28f858a856f3"}},"required":["provider_name","type","access_key","access_key_secret"]},{"type":"object","title":"salesforce","properties":{"provider_name":{"type":"string","enum":["salesforce"],"example":"salesforce"},"type":{"type":"string","enum":["oauth2"],"example":"oauth2"},"refresh_token":{"type":"string"},"instance_url":{"type":"string"},"login_url":{"type":"string"}},"required":["provider_name","type","refresh_token","instance_url"]},{"type":"object","title":"hubspot","properties":{"provider_name":{"type":"string","enum":["hubspot"],"example":"hubspot"},"type":{"type":"string","enum":["oauth2"],"example":"oauth2"},"refresh_token":{"type":"string"}},"required":["provider_name","type","refresh_token"]}]}}}},"responses":{"200":{"description":"Connection created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}}}},"method":"post","path":"/customers/{customer_id}/connections","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"provider_name":"apollo","type":"api_key","api_key":"e0c5545d-77b8-458d-b4bf-fc701a9cecac"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create a connection","description":{"content":"This endpoint is for providers that use API key or access key for authentication. Please use [Embedded Links](https://docs.supaglue.com/platform/managed-auth#oauth-20) for providers that support Oauth2 for authentication.","type":"text/plain"},"url":{"path":["customers",":customer_id","connections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-destination.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-destination.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-destination.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-destination.api.mdx index c84c46140..daa074afc 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-destination.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-destination.api.mdx @@ -5,7 +5,7 @@ description: "Create destination" sidebar_label: "Create destination" hide_title: true hide_table_of_contents: true -api: {"operationId":"createDestination","tags":["Destinations"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"postgres","properties":{"type":{"type":"string","enum":["supaglue"],"example":"supaglue"}},"required":["type"]},{"type":"object","title":"postgres","properties":{"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","port","database","schema","user","password"],"title":"postgres_config_unsafe"}},"required":["name","type","config"]},{"type":"object","title":"s3","properties":{"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"},"secret_access_key":{"type":"string","example":"A1lciPB09K2iqNHTLAftxTHy0SKGxNcO4QecAsZS"}},"required":["region","bucket","access_key_id","secret_access_key"],"title":"s3_config_unsafe"}},"required":["name","type","config"]},{"type":"object","title":"bigquery","properties":{"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"},"private_key":{"type":"string","example":"-----BEGIN PRIVATE KEY-----\\nMII..."}},"required":["client_email","private_key"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_unsafe"}},"required":["name","type","config"]},{"type":"object","title":"mongodb","properties":{"name":{"type":"string","example":"My MongoDB Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","database","user","password"],"title":"mongodb_config_unsafe"}},"required":["name","type","config"]}],"title":"create_destination"}}}},"responses":{"201":{"description":"Destination created","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Create destination","method":"post","path":"/destinations","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"type":"supaglue"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create destination","description":{"type":"text/plain"},"url":{"path":["destinations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createDestination","tags":["Destinations"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"postgres","properties":{"type":{"type":"string","enum":["supaglue"],"example":"supaglue"}},"required":["type"]},{"type":"object","title":"postgres","properties":{"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","port","database","schema","user","password"],"title":"postgres_config_unsafe"}},"required":["name","type","config"]},{"type":"object","title":"s3","properties":{"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"},"secret_access_key":{"type":"string","example":"A1lciPB09K2iqNHTLAftxTHy0SKGxNcO4QecAsZS"}},"required":["region","bucket","access_key_id","secret_access_key"],"title":"s3_config_unsafe"}},"required":["name","type","config"]},{"type":"object","title":"bigquery","properties":{"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"},"private_key":{"type":"string","example":"-----BEGIN PRIVATE KEY-----\\nMII..."}},"required":["client_email","private_key"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_unsafe"}},"required":["name","type","config"]},{"type":"object","title":"mongodb","properties":{"name":{"type":"string","example":"My MongoDB Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","database","user","password"],"title":"mongodb_config_unsafe"}},"required":["name","type","config"]}],"title":"create_destination"}}}},"responses":{"201":{"description":"Destination created","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Create destination","method":"post","path":"/destinations","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"type":"supaglue"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create destination","description":{"type":"text/plain"},"url":{"path":["destinations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-entity.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-entity.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-entity.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-entity.api.mdx index 5aeb807b0..de1948f41 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-entity.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-entity.api.mdx @@ -5,7 +5,7 @@ description: "Create entity" sidebar_label: "Create entity" hide_title: true hide_table_of_contents: true -api: {"operationId":"createEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["name","config"],"title":"create_update_entity"}}}},"responses":{"201":{"description":"Entity created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Create entity","method":"post","path":"/entities","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-entity","config":{"fields":[{"name":"apolla_first_name"}],"allow_additional_field_mappings":true}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create entity","description":{"type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["name","config"],"title":"create_update_entity"}}}},"responses":{"201":{"description":"Entity created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Create entity","method":"post","path":"/entities","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-entity","config":{"fields":[{"name":"apolla_first_name"}],"allow_additional_field_mappings":true}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create entity","description":{"type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-magic-link.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-magic-link.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-magic-link.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-magic-link.api.mdx index 71319cb49..9e8181cd9 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-magic-link.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-magic-link.api.mdx @@ -5,7 +5,7 @@ description: "Create magic link" sidebar_label: "Create magic link" hide_title: true hide_table_of_contents: true -api: {"operationId":"createMagicLink","tags":["Magic Links"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expiration_secs":{"type":"number","example":18000}},"required":["customer_id","provider_name","expiration_secs","return_url"],"title":"create_magic_link"}}}},"responses":{"201":{"description":"Entity created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"ec208408-db29-4705-b39e-4d33070b4ef6"},"status":{"type":"string","example":"created"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"url":{"type":"string","description":"The magic link URL.","example":"https://app.hubspot.com/contacts/123456"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expires_at":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00Z"}},"required":["id","status","application_id","customer_id","provider_id","provider_name","expires_at","url","return_url"],"title":"magic_link"}}}}},"description":"Create magic link","method":"post","path":"/magic_links","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"customer_id":"my-customer-1","provider_name":"hubspot","return_url":"https://app.myapp.com/connections/123456","expiration_secs":18000},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create magic link","description":{"type":"text/plain"},"url":{"path":["magic_links"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createMagicLink","tags":["Magic Links"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expiration_secs":{"type":"number","example":18000}},"required":["customer_id","provider_name","expiration_secs","return_url"],"title":"create_magic_link"}}}},"responses":{"201":{"description":"Entity created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"ec208408-db29-4705-b39e-4d33070b4ef6"},"status":{"type":"string","example":"created"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"url":{"type":"string","description":"The magic link URL.","example":"https://app.hubspot.com/contacts/123456"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expires_at":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00Z"}},"required":["id","status","application_id","customer_id","provider_id","provider_name","expires_at","url","return_url"],"title":"magic_link"}}}}},"description":"Create magic link","method":"post","path":"/magic_links","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"customer_id":"my-customer-1","provider_name":"hubspot","return_url":"https://app.myapp.com/connections/123456","expiration_secs":18000},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create magic link","description":{"type":"text/plain"},"url":{"path":["magic_links"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-provider.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-provider.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-provider.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-provider.api.mdx index 2526b9d2c..ff38a1064 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-provider.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-provider.api.mdx @@ -5,7 +5,7 @@ description: "Create provider" sidebar_label: "Create provider" hide_title: true hide_table_of_contents: true -api: {"operationId":"createProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"crm","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"category":{"type":"string","enum":["crm"]},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule"],"title":"provider_name_crm"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"engagement","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"category":{"type":"string","enum":["engagement"]},"name":{"type":"string","enum":["outreach","apollo","salesloft"],"title":"provider_name_engagement"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"no category","properties":{"auth_type":{"type":"string","enum":["api_key"]},"category":{"type":"string","enum":["no_category"]},"name":{"type":"string","enum":["intercom","gong","linear"],"title":"provider_name_no_category"}},"required":["auth_type"]}],"title":"create_provider"}}}},"responses":{"201":{"description":"Provider created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Create provider","method":"post","path":"/providers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"auth_type":"oauth2","config":{"provider_app_id":"my_app_id","use_managed_oauth":true,"oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"objects":{"common":[{"name":"account","schema_id":"328a8cb3-8345-4b02-b661-ee13b4f76806"}],"standard":[{"name":"Account","schema_id":"777ea826-5776-4347-9ece-47bbb17ccdd4"}]},"category":"crm","name":"hubspot"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create provider","description":{"type":"text/plain"},"url":{"path":["providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"crm","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"category":{"type":"string","enum":["crm"]},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule"],"title":"provider_name_crm"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"engagement","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"category":{"type":"string","enum":["engagement"]},"name":{"type":"string","enum":["outreach","apollo","salesloft"],"title":"provider_name_engagement"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"no category","properties":{"auth_type":{"type":"string","enum":["api_key"]},"category":{"type":"string","enum":["no_category"]},"name":{"type":"string","enum":["intercom","gong","linear"],"title":"provider_name_no_category"}},"required":["auth_type"]}],"title":"create_provider"}}}},"responses":{"201":{"description":"Provider created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Create provider","method":"post","path":"/providers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"auth_type":"oauth2","config":{"provider_app_id":"my_app_id","use_managed_oauth":true,"oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"objects":{"common":[{"name":"account","schema_id":"328a8cb3-8345-4b02-b661-ee13b4f76806"}],"standard":[{"name":"Account","schema_id":"777ea826-5776-4347-9ece-47bbb17ccdd4"}]},"category":"crm","name":"hubspot"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create provider","description":{"type":"text/plain"},"url":{"path":["providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-schema.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-schema.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-schema.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-schema.api.mdx index ec05b21d7..e17a59e6f 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-schema.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-schema.api.mdx @@ -5,7 +5,7 @@ description: "Create schema" sidebar_label: "Create schema" hide_title: true hide_table_of_contents: true -api: {"operationId":"createSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["name","config"],"title":"create_update_schema"}}}},"responses":{"201":{"description":"Schema created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Create schema","method":"post","path":"/schemas","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-schema","config":{"fields":[{"name":"apolla_first_name","mapped_name":"FirstName"}],"allow_additional_field_mappings":false}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create schema","description":{"type":"text/plain"},"url":{"path":["schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["name","config"],"title":"create_update_schema"}}}},"responses":{"201":{"description":"Schema created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Create schema","method":"post","path":"/schemas","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-schema","config":{"fields":[{"name":"apolla_first_name","mapped_name":"FirstName"}],"allow_additional_field_mappings":false}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create schema","description":{"type":"text/plain"},"url":{"path":["schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-sync-config.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-sync-config.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-sync-config.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-sync-config.api.mdx index 84c972a72..060a55209 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/create-sync-config.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/create-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Create Sync Config" sidebar_label: "Create Sync Config" hide_title: true hide_table_of_contents: true -api: {"operationId":"createSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["destination_id","provider_id","config"],"title":"create_update_sync_config"}}}},"responses":{"201":{"description":"SyncConfig created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Create Sync Config","method":"post","path":"/sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_id":"6e7baa88-84dd-4dbc-902a-14522c2984eb","provider_id":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af","config":{"default_config":{"period_ms":60000,"strategy":"full then incremental","auto_start_on_connection":true},"common_objects":[{"object":"contact"}],"standard_objects":[{"object":"Contact"}],"entities":[{"entity_id":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}]}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"createSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["destination_id","provider_id","config"],"title":"create_update_sync_config"}}}},"responses":{"201":{"description":"SyncConfig created","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Create Sync Config","method":"post","path":"/sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_id":"6e7baa88-84dd-4dbc-902a-14522c2984eb","provider_id":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af","config":{"default_config":{"period_ms":60000,"strategy":"full then incremental","auto_start_on_connection":true},"common_objects":[{"object":"contact"}],"standard_objects":[{"object":"Contact"}],"entities":[{"entity_id":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}]}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Create Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/customers.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/customers.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/customers.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/customers.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-connection-sync-config.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-connection-sync-config.api.mdx similarity index 98% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-connection-sync-config.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-connection-sync-config.api.mdx index 807d9c585..bdbb51d69 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-connection-sync-config.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-connection-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Delete connection sync config" sidebar_label: "Delete connection sync config" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteConnectionSyncConfig","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Connection Sync Config"}},"description":"Delete connection sync config","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"delete","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete connection sync config","description":{"type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteConnectionSyncConfig","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Connection Sync Config"}},"description":"Delete connection sync config","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"delete","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete connection sync config","description":{"type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-connection.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-connection.api.mdx similarity index 98% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-connection.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-connection.api.mdx index d7647e8d5..5f1604111 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-connection.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-connection.api.mdx @@ -5,7 +5,7 @@ description: "Delete connection" sidebar_label: "Delete connection" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteConnection","tags":["Connections"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"An empty body is returned on successful deletion."}},"description":"Delete connection","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/customers/{customer_id}/connections/{connection_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete connection","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id","connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"connection_id"}]},"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteConnection","tags":["Connections"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"An empty body is returned on successful deletion."}},"description":"Delete connection","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/customers/{customer_id}/connections/{connection_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete connection","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id","connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"connection_id"}]},"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-customer.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-customer.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-customer.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-customer.api.mdx index ddd5c2869..c185dc1c2 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-customer.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-customer.api.mdx @@ -5,7 +5,7 @@ description: "Delete customer" sidebar_label: "Delete customer" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Customer","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"},"examples":{"Example":{"value":{"application_id":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69","name":"MyCompany Inc","email":"contact@mycompany.com","customer_id":"your-customers-unique-application-id"}}}}}}},"description":"Delete customer","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","example":"your-customers-unique-application-id"}}],"method":"delete","path":"/customers/{customer_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete customer","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Customer","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"},"examples":{"Example":{"value":{"application_id":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69","name":"MyCompany Inc","email":"contact@mycompany.com","customer_id":"your-customers-unique-application-id"}}}}}}},"description":"Delete customer","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","example":"your-customers-unique-application-id"}}],"method":"delete","path":"/customers/{customer_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete customer","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-entity-mapping.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-entity-mapping.api.mdx similarity index 98% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-entity-mapping.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-entity-mapping.api.mdx index 461542435..f557a8ca1 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-entity-mapping.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-entity-mapping.api.mdx @@ -5,7 +5,7 @@ description: "Delete entity mapping" sidebar_label: "Delete entity mapping" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteEntityMapping","tags":["EntityMappings"],"security":[{"ApiKeyAuth":[]}],"responses":{"204":{"description":"Entity Mapping"}},"description":"Delete entity mapping","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"method":"delete","path":"/entity_mappings/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete entity mapping","description":{"type":"text/plain"},"url":{"path":["entity_mappings",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""}],"method":"DELETE"}} +api: {"operationId":"deleteEntityMapping","tags":["EntityMappings"],"security":[{"ApiKeyAuth":[]}],"responses":{"204":{"description":"Entity Mapping"}},"description":"Delete entity mapping","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"method":"delete","path":"/entity_mappings/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete entity mapping","description":{"type":"text/plain"},"url":{"path":["entity_mappings",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""}],"method":"DELETE"}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-entity.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-entity.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-entity.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-entity.api.mdx index 9621953dc..7c2bd3365 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-entity.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-entity.api.mdx @@ -5,7 +5,7 @@ description: "Delete entity" sidebar_label: "Delete entity" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Delete entity","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Delete entity","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-magic-link.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-magic-link.api.mdx similarity index 97% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-magic-link.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-magic-link.api.mdx index 0016cd141..a9a7f837c 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-magic-link.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-magic-link.api.mdx @@ -5,7 +5,7 @@ description: "Delete magic link" sidebar_label: "Delete magic link" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteMagicLink","tags":["Magic Links"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Magic Link deleted"}},"description":"Delete magic link","parameters":[{"name":"magic_link_id","in":"path","required":true,"schema":{"type":"string","example":"6bf954f9-dba3-4c34-9275-3830dccb0030"}}],"method":"delete","path":"/magic_links/{magic_link_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete magic link","description":{"type":"text/plain"},"url":{"path":["magic_links",":magic_link_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"magic_link_id"}]},"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteMagicLink","tags":["Magic Links"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Magic Link deleted"}},"description":"Delete magic link","parameters":[{"name":"magic_link_id","in":"path","required":true,"schema":{"type":"string","example":"6bf954f9-dba3-4c34-9275-3830dccb0030"}}],"method":"delete","path":"/magic_links/{magic_link_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete magic link","description":{"type":"text/plain"},"url":{"path":["magic_links",":magic_link_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"magic_link_id"}]},"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-provider.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-provider.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-provider.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-provider.api.mdx index f0bdbe3f4..bd35b6030 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-provider.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-provider.api.mdx @@ -5,7 +5,7 @@ description: "Delete provider" sidebar_label: "Delete provider" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Delete provider","parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Delete provider","parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"delete","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-schema.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-schema.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-schema.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-schema.api.mdx index cfdad059a..24b848307 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-schema.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-schema.api.mdx @@ -5,7 +5,7 @@ description: "Delete schema" sidebar_label: "Delete schema" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"deleteSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Delete schema","parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"method":"delete","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"deleteSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"responses":{"204":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Delete schema","parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"method":"delete","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-sync-config.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-sync-config.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-sync-config.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-sync-config.api.mdx index 2ddd328e6..9087621da 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/delete-sync-config.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/delete-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Delete Sync Config" sidebar_label: "Delete Sync Config" hide_title: true hide_table_of_contents: true -api: {"operationId":"deleteSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Delete Sync Config","parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"method":"delete","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"deleteSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Delete Sync Config","parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"method":"delete","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Delete Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "delete api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/destinations.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/destinations.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/destinations.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/destinations.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/entities.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/entities.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/entities.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/entities.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/entity-entity-mapping-created.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/entity-entity-mapping-created.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/entity-entity-mapping-created.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/entity-entity-mapping-created.api.mdx index d9863296c..9fa7d3449 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/entity-entity-mapping-created.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/entity-entity-mapping-created.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the creation of an entity mapping" sidebar_label: "Entity mapping created" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of the creation of an entity mapping","operationId":"entityEntityMappingCreated","x-event-type":"entity.entity_mapping.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.created","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.created"],"example":"entity.entity_mapping.created"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.created","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of the creation of an entity mapping","operationId":"entityEntityMappingCreated","x-event-type":"entity.entity_mapping.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.created","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.created"],"example":"entity.entity_mapping.created"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.created","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx index 012269cc9..ae436160a 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the deletion of an entity mapping" sidebar_label: "Entity mapping deleted" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of the deletion of an entity mapping","operationId":"entityEntityMappingDeleted","x-event-type":"entity.entity_mapping.deleted","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.deleted","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.deleted"],"example":"entity.entity_mapping.deleted"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.deleted"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.deleted","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of the deletion of an entity mapping","operationId":"entityEntityMappingDeleted","x-event-type":"entity.entity_mapping.deleted","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.deleted","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.deleted"],"example":"entity.entity_mapping.deleted"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.deleted"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.deleted","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/entity-entity-mapping-updated.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/entity-entity-mapping-updated.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/entity-entity-mapping-updated.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/entity-entity-mapping-updated.api.mdx index c3ad2c0d9..0abc392f5 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/entity-entity-mapping-updated.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/entity-entity-mapping-updated.api.mdx @@ -5,7 +5,7 @@ description: "Notification of an update to an entity mapping" sidebar_label: "Entity mapping updated" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of an update to an entity mapping","operationId":"entityEntityMappingUpdated","x-event-type":"entity.entity_mapping.updated","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.updated","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.updated"],"example":"entity.entity_mapping.updated"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.updated"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.updated","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of an update to an entity mapping","operationId":"entityEntityMappingUpdated","x-event-type":"entity.entity_mapping.updated","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"entity.entity_mapping.updated","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["entity.entity_mapping.updated"],"example":"entity.entity_mapping.updated"},"entity_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"connection_id":{"type":"string","example":"a7052919-e024-4985-bd08-856056b66f59"},"customer_id":{"type":"string","example":"1a2b3c4d5e6f"},"provider_name":{"type":"string","example":"salesforce"},"object_name":{"type":"string","example":"opportunity"},"object_type":{"type":"string","enum":["standard","custom"],"example":"standard"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","entity_id","application_id","connection_id","customer_id","provider_name","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"entity.entity_mapping.updated"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"entity.entity_mapping.updated","entity_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","connection_id":"a7052919-e024-4985-bd08-856056b66f59","customer_id":"1a2b3c4d5e6f","provider_name":"salesforce","object_name":"opportunity","object_type":"standard","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/entity-mappings.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/entity-mappings.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/entity-mappings.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/entity-mappings.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-connection-sync-config.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-connection-sync-config.api.mdx similarity index 53% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-connection-sync-config.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-connection-sync-config.api.mdx index 26c51045f..bd998a1aa 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-connection-sync-config.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-connection-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Get connection sync config" sidebar_label: "Get connection sync config" hide_title: true hide_table_of_contents: true -api: {"operationId":"getConnectionSyncConfig","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"Connection Sync Config","content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"oneOf":[{"description":"Config specific to postgres destination","type":"object","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. If not specified, the schema specified in the postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to bigquery destination","type":"object","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. If not specified, the dataset specified in the bigquery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"custom_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name (case sensitive)","example":"Contact__c"}},"required":["object"]}}},"title":"connection_sync_config"}}}}},"description":"Get connection sync config","method":"get","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get connection sync config","description":{"type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getConnectionSyncConfig","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"Connection Sync Config","content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"oneOf":[{"description":"Config specific to postgres destination","type":"object","title":"postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to bigquery destination","type":"object","title":"bigquery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the bigquery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"custom_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name (case sensitive)","example":"Contact__c"}},"required":["object"]}}},"title":"connection_sync_config"}}}}},"description":"Get connection sync config","method":"get","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get connection sync config","description":{"type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -38,7 +38,7 @@ Get connection sync config Connection Sync Config -
Schema
    destination_config object
    oneOf
    standard_objects object[]
    +
    Schema
      destination_config object
      oneOf
      standard_objects object[]
      A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig. diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-connection.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-connection.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-connection.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-connection.api.mdx index d36043827..a4b33bbdd 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-connection.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-connection.api.mdx @@ -5,7 +5,7 @@ description: "Get connection" sidebar_label: "Get connection" hide_title: true hide_table_of_contents: true -api: {"operationId":"getConnection","tags":["Connections"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Connection","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"},{"type":"object","properties":{"user_id":{"type":"string","description":"The id of the user associated with this connection. This is sometimes also known as the owner."}}}]}}}}},"description":"Get connection","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/customers/{customer_id}/connections/{connection_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get connection","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id","connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"connection_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getConnection","tags":["Connections"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Connection","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"},{"type":"object","properties":{"user_id":{"type":"string","description":"The id of the user associated with this connection. This is sometimes also known as the owner."}}}]}}}}},"description":"Get connection","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"connection_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/customers/{customer_id}/connections/{connection_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get connection","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id","connections",":connection_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"},{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"connection_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-connections.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-connections.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-connections.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-connections.api.mdx index 65db7a82a..d3aacb2b1 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-connections.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-connections.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of connections" sidebar_label: "List connections" hide_title: true hide_table_of_contents: true -api: {"operationId":"getConnections","tags":["Connections"],"security":[{"x-api-key":[]}],"description":"Get a list of connections","responses":{"200":{"description":"Connections","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}}}}},"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/customers/{customer_id}/connections","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List connections","description":{"content":"Get a list of connections","type":"text/plain"},"url":{"path":["customers",":customer_id","connections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getConnections","tags":["Connections"],"security":[{"x-api-key":[]}],"description":"Get a list of connections","responses":{"200":{"description":"Connections","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}}}}},"parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/customers/{customer_id}/connections","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List connections","description":{"content":"Get a list of connections","type":"text/plain"},"url":{"path":["customers",":customer_id","connections"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-customer.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-customer.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-customer.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-customer.api.mdx index b7bee4f0d..a05b1b2eb 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-customer.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-customer.api.mdx @@ -5,7 +5,7 @@ description: "Get customer" sidebar_label: "Get customer" hide_title: true hide_table_of_contents: true -api: {"operationId":"getCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Customer","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"},"examples":{"Example":{"value":{"application_id":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69","name":"MyCompany Inc","email":"contact@mycompany.com","customer_id":"your-customers-unique-application-id"}}}}}}},"description":"Get customer","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","example":"your-customers-unique-application-id"}}],"method":"get","path":"/customers/{customer_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get customer","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Customer","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"},"examples":{"Example":{"value":{"application_id":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69","name":"MyCompany Inc","email":"contact@mycompany.com","customer_id":"your-customers-unique-application-id"}}}}}}},"description":"Get customer","parameters":[{"name":"customer_id","in":"path","required":true,"schema":{"type":"string","example":"your-customers-unique-application-id"}}],"method":"get","path":"/customers/{customer_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get customer","description":{"type":"text/plain"},"url":{"path":["customers",":customer_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-customers.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-customers.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-customers.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-customers.api.mdx index 3f5f6190d..0e7f3278f 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-customers.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-customers.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of customers" sidebar_label: "List customers" hide_title: true hide_table_of_contents: true -api: {"operationId":"getCustomers","tags":["Customers"],"security":[{"x-api-key":[]}],"description":"Get a list of customers","responses":{"200":{"description":"Customers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"}}}}}},"method":"get","path":"/customers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List customers","description":{"content":"Get a list of customers","type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getCustomers","tags":["Customers"],"security":[{"x-api-key":[]}],"description":"Get a list of customers","responses":{"200":{"description":"Customers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"}}}}}},"method":"get","path":"/customers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List customers","description":{"content":"Get a list of customers","type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-destination.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-destination.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-destination.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-destination.api.mdx index d1d1f9a48..685c45855 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-destination.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-destination.api.mdx @@ -5,7 +5,7 @@ description: "Get destination" sidebar_label: "Get destination" hide_title: true hide_table_of_contents: true -api: {"operationId":"getDestination","tags":["Destinations"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Destination","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Get destination","parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/destinations/{destination_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get destination","description":{"type":"text/plain"},"url":{"path":["destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"destination_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getDestination","tags":["Destinations"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Destination","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Get destination","parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/destinations/{destination_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get destination","description":{"type":"text/plain"},"url":{"path":["destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"destination_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-destinations.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-destinations.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-destinations.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-destinations.api.mdx index b031a899c..4c9a35c63 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-destinations.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-destinations.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of destinations" sidebar_label: "List destinations" hide_title: true hide_table_of_contents: true -api: {"operationId":"getDestinations","tags":["Destinations"],"security":[{"x-api-key":[]}],"description":"Get a list of destinations","responses":{"200":{"description":"Destinations","content":{"application/json":{"schema":{"type":"array","items":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"},"example":[{"id":"0a292508-d254-4929-98d3-dc23416efff8","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My S3 Destination","type":"s3","config":{"region":"us-west-2","bucket":"my-bucket","access_key_id":"MY_ACCESS_KEY_ID"}},{"id":"92bc3460-a301-4116-8d1f-6e5f8252c2e2","application_id":"9b9a31bb-9fe4-4fa5-ba84-4c035a27f258","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"my_database","schema":"public","user":"user","password":"password"}}]}}}}},"method":"get","path":"/destinations","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List destinations","description":{"content":"Get a list of destinations","type":"text/plain"},"url":{"path":["destinations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getDestinations","tags":["Destinations"],"security":[{"x-api-key":[]}],"description":"Get a list of destinations","responses":{"200":{"description":"Destinations","content":{"application/json":{"schema":{"type":"array","items":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"},"example":[{"id":"0a292508-d254-4929-98d3-dc23416efff8","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My S3 Destination","type":"s3","config":{"region":"us-west-2","bucket":"my-bucket","access_key_id":"MY_ACCESS_KEY_ID"}},{"id":"92bc3460-a301-4116-8d1f-6e5f8252c2e2","application_id":"9b9a31bb-9fe4-4fa5-ba84-4c035a27f258","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"my_database","schema":"public","user":"user","password":"password"}}]}}}}},"method":"get","path":"/destinations","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List destinations","description":{"content":"Get a list of destinations","type":"text/plain"},"url":{"path":["destinations"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-entities.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-entities.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-entities.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-entities.api.mdx index 649598b81..bc4951c45 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-entities.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-entities.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of entities" sidebar_label: "List entities" hide_title: true hide_table_of_contents: true -api: {"operationId":"getEntities","tags":["Entities"],"security":[{"x-api-key":[]}],"description":"Get a list of entities","responses":{"200":{"description":"Entities","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}}},"method":"get","path":"/entities","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List entities","description":{"content":"Get a list of entities","type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getEntities","tags":["Entities"],"security":[{"x-api-key":[]}],"description":"Get a list of entities","responses":{"200":{"description":"Entities","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}}},"method":"get","path":"/entities","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List entities","description":{"content":"Get a list of entities","type":"text/plain"},"url":{"path":["entities"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-entity.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-entity.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-entity.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-entity.api.mdx index 98f841422..f29523e34 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-entity.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-entity.api.mdx @@ -5,7 +5,7 @@ description: "Get entity" sidebar_label: "Get entity" hide_title: true hide_table_of_contents: true -api: {"operationId":"getEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Get entity","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getEntity","tags":["Entities"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Get entity","parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-magic-links.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-magic-links.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-magic-links.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-magic-links.api.mdx index bb67420ef..b99762508 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-magic-links.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-magic-links.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of magic links" sidebar_label: "List magic links" hide_title: true hide_table_of_contents: true -api: {"operationId":"getMagicLinks","tags":["Magic Links"],"security":[{"x-api-key":[]}],"description":"Get a list of magic links","responses":{"200":{"description":"Magic Links","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ec208408-db29-4705-b39e-4d33070b4ef6"},"status":{"type":"string","example":"created"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"url":{"type":"string","description":"The magic link URL.","example":"https://app.hubspot.com/contacts/123456"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expires_at":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00Z"}},"required":["id","status","application_id","customer_id","provider_id","provider_name","expires_at","url","return_url"],"title":"magic_link"}}}}}},"method":"get","path":"/magic_links","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List magic links","description":{"content":"Get a list of magic links","type":"text/plain"},"url":{"path":["magic_links"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getMagicLinks","tags":["Magic Links"],"security":[{"x-api-key":[]}],"description":"Get a list of magic links","responses":{"200":{"description":"Magic Links","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"ec208408-db29-4705-b39e-4d33070b4ef6"},"status":{"type":"string","example":"created"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"url":{"type":"string","description":"The magic link URL.","example":"https://app.hubspot.com/contacts/123456"},"return_url":{"type":"string","description":"URL to redirect to after the connection is authorized.","example":"https://app.myapp.com/connections/123456"},"expires_at":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00Z"}},"required":["id","status","application_id","customer_id","provider_id","provider_name","expires_at","url","return_url"],"title":"magic_link"}}}}}},"method":"get","path":"/magic_links","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List magic links","description":{"content":"Get a list of magic links","type":"text/plain"},"url":{"path":["magic_links"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-provider-user-id.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-provider-user-id.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-provider-user-id.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-provider-user-id.api.mdx index bc4ae4916..f3f9ad863 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-provider-user-id.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-provider-user-id.api.mdx @@ -5,7 +5,7 @@ description: "This endpoint returns the ID of the logged in user (this is someti sidebar_label: "Get logged in user ID and details" hide_title: true hide_table_of_contents: true -api: {"operationId":"getProviderUserId","description":"This endpoint returns the ID of the logged in user (this is sometimes known as the owner ID) and details.","tags":["Connections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"provider_name","in":"query","required":true,"schema":{"type":"string","enum":["hubspot","ms_dynamics_365_sales","intercom"],"example":"hubspot"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"UserId","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of the logged in user. The ID originates from your customer's third-party Provider."},"raw_details":{"type":"object","additionalProperties":true,"description":"The raw data from the your customer's third-party Provider."}},"example":{"user_id":"70115e3c-2700-4112-b28f-2706e08570e6","raw_details":{"user_id":"70115e3c-2700-4112-b28f-2706e08570e6","user":"test@something.com","scopes":["contacts","automation","oauth"]}}}}}}},"method":"get","path":"/customers/{customer_id}/connections/_provider_user_id","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get logged in user ID and details","description":{"content":"This endpoint returns the ID of the logged in user (this is sometimes known as the owner ID) and details.","type":"text/plain"},"url":{"path":["customers",":customer_id","connections","_provider_user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"provider_name","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getProviderUserId","description":"This endpoint returns the ID of the logged in user (this is sometimes known as the owner ID) and details.","tags":["Connections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"provider_name","in":"query","required":true,"schema":{"type":"string","enum":["hubspot","ms_dynamics_365_sales","intercom"],"example":"hubspot"}},{"name":"customer_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"UserId","content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"string","description":"The ID of the logged in user. The ID originates from your customer's third-party Provider."},"raw_details":{"type":"object","additionalProperties":true,"description":"The raw data from the your customer's third-party Provider."}},"example":{"user_id":"70115e3c-2700-4112-b28f-2706e08570e6","raw_details":{"user_id":"70115e3c-2700-4112-b28f-2706e08570e6","user":"test@something.com","scopes":["contacts","automation","oauth"]}}}}}}},"method":"get","path":"/customers/{customer_id}/connections/_provider_user_id","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get logged in user ID and details","description":{"content":"This endpoint returns the ID of the logged in user (this is sometimes known as the owner ID) and details.","type":"text/plain"},"url":{"path":["customers",":customer_id","connections","_provider_user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"key":"provider_name","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"customer_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-provider.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-provider.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-provider.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-provider.api.mdx index 98039bc5f..b6308c0bc 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-provider.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-provider.api.mdx @@ -5,7 +5,7 @@ description: "Get provider" sidebar_label: "Get provider" hide_title: true hide_table_of_contents: true -api: {"operationId":"getProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Get provider","parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getProvider","tags":["Providers"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Get provider","parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"method":"get","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-providers.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-providers.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-providers.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-providers.api.mdx index 7339da9f8..e709998c7 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-providers.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-providers.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of providers" sidebar_label: "List providers" hide_title: true hide_table_of_contents: true -api: {"operationId":"getProviders","tags":["Providers"],"security":[{"x-api-key":[]}],"description":"Get a list of providers","responses":{"200":{"description":"Providers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}}},"method":"get","path":"/providers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List providers","description":{"content":"Get a list of providers","type":"text/plain"},"url":{"path":["providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getProviders","tags":["Providers"],"security":[{"x-api-key":[]}],"description":"Get a list of providers","responses":{"200":{"description":"Providers","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}}},"method":"get","path":"/providers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List providers","description":{"content":"Get a list of providers","type":"text/plain"},"url":{"path":["providers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-schema.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-schema.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-schema.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-schema.api.mdx index dc1745b88..72eb6889a 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-schema.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-schema.api.mdx @@ -5,7 +5,7 @@ description: "Get schema" sidebar_label: "Get schema" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"getSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Get schema","parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"method":"get","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"getSchema","tags":["Schemas"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Get schema","parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"method":"get","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-schemas.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-schemas.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-schemas.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-schemas.api.mdx index a1d6d9dbd..3ec6d0421 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-schemas.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-schemas.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of schemas" sidebar_label: "List schemas" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"getSchemas","tags":["Schemas"],"security":[{"x-api-key":[]}],"description":"Get a list of schemas","responses":{"200":{"description":"Schemas","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}}},"method":"get","path":"/schemas","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List schemas","description":{"content":"Get a list of schemas","type":"text/plain"},"url":{"path":["schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"getSchemas","tags":["Schemas"],"security":[{"x-api-key":[]}],"description":"Get a list of schemas","responses":{"200":{"description":"Schemas","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}}},"method":"get","path":"/schemas","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List schemas","description":{"content":"Get a list of schemas","type":"text/plain"},"url":{"path":["schemas"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-sync-config.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-sync-config.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-sync-config.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-sync-config.api.mdx index 8d680cc47..c54d5fb87 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-sync-config.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Get Sync Config" sidebar_label: "Get Sync Config" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Get Sync Config","parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"method":"get","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSyncConfig","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Get Sync Config","parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"method":"get","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-sync-configs.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-sync-configs.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-sync-configs.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-sync-configs.api.mdx index f4a7ff0a3..bed37aae4 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-sync-configs.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-sync-configs.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of Sync Configs" sidebar_label: "List Sync Configs" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSyncConfigs","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"description":"Get a list of Sync Configs","responses":{"200":{"description":"SyncConfigs","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}}},"method":"get","path":"/sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List Sync Configs","description":{"content":"Get a list of Sync Configs","type":"text/plain"},"url":{"path":["sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSyncConfigs","tags":["SyncConfigs"],"security":[{"x-api-key":[]}],"description":"Get a list of Sync Configs","responses":{"200":{"description":"SyncConfigs","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}}},"method":"get","path":"/sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List Sync Configs","description":{"content":"Get a list of Sync Configs","type":"text/plain"},"url":{"path":["sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-sync-runs.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-sync-runs.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-sync-runs.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-sync-runs.api.mdx index 3507caae7..bc686d94c 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-sync-runs.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-sync-runs.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of SyncRuns." sidebar_label: "Get SyncRuns" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSyncRuns","tags":["SyncRuns"],"security":[{"x-api-key":[]}],"description":"Get a list of SyncRuns.","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page"},{"name":"customer_id","in":"query","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application"},{"name":"provider_name","in":"query","schema":{"type":"string","example":"salesforce"},"description":"The provider name"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["common","standard","custom"],"example":"standard"}},{"name":"object","in":"query","schema":{"type":"string","example":"account"},"description":"The object to filter by"},{"name":"entity_id","in":"query","schema":{"type":"string","example":"e74b5a4f-f252-4a6c-940c-f35873498543"},"description":"The entity id to filter by"},{"name":"status","in":"query","schema":{"type":"string","example":"SUCCESS"},"description":"The status to filter by (case-insensitive)"},{"name":"start_timestamp","in":"query","schema":{"type":"string","example":">2021-01-06T03:24:53.434326Z"},"description":"The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp."},{"name":"end_timestamp","in":"query","schema":{"type":"string","example":">2021-01-06T03:24:53.434326Z"},"description":"The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp."}],"responses":{"200":{"description":"SyncRun","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"]},"object":{"type":"string"},"error_message":{"type":"string","nullable":true},"start_timestamp":{"type":"string","example":"2023-02-22T19:55:17.559Z"},"end_timestamp":{"type":"string","nullable":true,"example":"2023-02-22T20:55:17.559Z"},"application_id":{"type":"string","example":"974125fa-ffb6-47fc-b12f-44c566fc5da1"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"status":{"type":"string","enum":["SUCCESS","IN_PROGRESS","FAILURE"]},"num_records_synced":{"type":"number","nullable":true,"example":100}},"required":["object_type","object","start_timestamp","end_timestamp","application_id","customer_id","status","error_message","provider_name","category","connection_id","num_records_synced"]},{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string"},"error_message":{"type":"string","nullable":true},"start_timestamp":{"type":"string","example":"2023-02-22T19:55:17.559Z"},"end_timestamp":{"type":"string","nullable":true,"example":"2023-02-22T20:55:17.559Z"},"application_id":{"type":"string","example":"974125fa-ffb6-47fc-b12f-44c566fc5da1"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"status":{"type":"string","enum":["SUCCESS","IN_PROGRESS","FAILURE"]},"num_records_synced":{"type":"number","nullable":true,"example":100}},"required":["entity_id","start_timestamp","end_timestamp","application_id","customer_id","status","error_message","provider_name","category","connection_id","num_records_synced"]}],"title":"sync_run"}}}}]}}}}},"method":"get","path":"/sync-runs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get SyncRuns","description":{"content":"Get a list of SyncRuns.","type":"text/plain"},"url":{"path":["sync-runs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"Number of results to return per page","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"customer_id","value":""},{"disabled":false,"description":{"content":"The provider name","type":"text/plain"},"key":"provider_name","value":""},{"disabled":false,"key":"object_type","value":""},{"disabled":false,"description":{"content":"The object to filter by","type":"text/plain"},"key":"object","value":""},{"disabled":false,"description":{"content":"The entity id to filter by","type":"text/plain"},"key":"entity_id","value":""},{"disabled":false,"description":{"content":"The status to filter by (case-insensitive)","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp.","type":"text/plain"},"key":"start_timestamp","value":""},{"disabled":false,"description":{"content":"The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp.","type":"text/plain"},"key":"end_timestamp","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSyncRuns","tags":["SyncRuns"],"security":[{"x-api-key":[]}],"description":"Get a list of SyncRuns.","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page"},{"name":"customer_id","in":"query","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application"},{"name":"provider_name","in":"query","schema":{"type":"string","example":"salesforce"},"description":"The provider name"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["common","standard","custom"],"example":"standard"}},{"name":"object","in":"query","schema":{"type":"string","example":"account"},"description":"The object to filter by"},{"name":"entity_id","in":"query","schema":{"type":"string","example":"e74b5a4f-f252-4a6c-940c-f35873498543"},"description":"The entity id to filter by"},{"name":"status","in":"query","schema":{"type":"string","example":"SUCCESS"},"description":"The status to filter by (case-insensitive)"},{"name":"start_timestamp","in":"query","schema":{"type":"string","example":">2021-01-06T03:24:53.434326Z"},"description":"The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp."},{"name":"end_timestamp","in":"query","schema":{"type":"string","example":">2021-01-06T03:24:53.434326Z"},"description":"The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp."}],"responses":{"200":{"description":"SyncRun","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"]},"object":{"type":"string"},"error_message":{"type":"string","nullable":true},"start_timestamp":{"type":"string","example":"2023-02-22T19:55:17.559Z"},"end_timestamp":{"type":"string","nullable":true,"example":"2023-02-22T20:55:17.559Z"},"application_id":{"type":"string","example":"974125fa-ffb6-47fc-b12f-44c566fc5da1"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"status":{"type":"string","enum":["SUCCESS","IN_PROGRESS","FAILURE"]},"num_records_synced":{"type":"number","nullable":true,"example":100}},"required":["object_type","object","start_timestamp","end_timestamp","application_id","customer_id","status","error_message","provider_name","category","connection_id","num_records_synced"]},{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string"},"error_message":{"type":"string","nullable":true},"start_timestamp":{"type":"string","example":"2023-02-22T19:55:17.559Z"},"end_timestamp":{"type":"string","nullable":true,"example":"2023-02-22T20:55:17.559Z"},"application_id":{"type":"string","example":"974125fa-ffb6-47fc-b12f-44c566fc5da1"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"status":{"type":"string","enum":["SUCCESS","IN_PROGRESS","FAILURE"]},"num_records_synced":{"type":"number","nullable":true,"example":100}},"required":["entity_id","start_timestamp","end_timestamp","application_id","customer_id","status","error_message","provider_name","category","connection_id","num_records_synced"]}],"title":"sync_run"}}}}]}}}}},"method":"get","path":"/sync-runs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get SyncRuns","description":{"content":"Get a list of SyncRuns.","type":"text/plain"},"url":{"path":["sync-runs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"Number of results to return per page","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"customer_id","value":""},{"disabled":false,"description":{"content":"The provider name","type":"text/plain"},"key":"provider_name","value":""},{"disabled":false,"key":"object_type","value":""},{"disabled":false,"description":{"content":"The object to filter by","type":"text/plain"},"key":"object","value":""},{"disabled":false,"description":{"content":"The entity id to filter by","type":"text/plain"},"key":"entity_id","value":""},{"disabled":false,"description":{"content":"The status to filter by (case-insensitive)","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"The start time to filter by. Should start with one of [>, <] followed by an ISO 8601 timestamp.","type":"text/plain"},"key":"start_timestamp","value":""},{"disabled":false,"description":{"content":"The end time to filter by. Should start with [>, <] followed by an ISO 8601 timestamp.","type":"text/plain"},"key":"end_timestamp","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-syncs.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-syncs.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-syncs.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-syncs.api.mdx index f5acac7c9..006bcaa23 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/get-syncs.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/get-syncs.api.mdx @@ -5,7 +5,7 @@ description: "Get a list of Syncs." sidebar_label: "Get Syncs" hide_title: true hide_table_of_contents: true -api: {"operationId":"getSyncs","tags":["Syncs"],"security":[{"x-api-key":[]}],"description":"Get a list of Syncs.","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page"},{"name":"customer_id","in":"query","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application"},{"name":"provider_name","in":"query","schema":{"type":"string","example":"salesforce"},"description":"The provider name"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"description":"The object type to filter by"},{"name":"object","in":"query","schema":{"type":"string","example":"contact"},"description":"The object to filter by"},{"name":"entity_id","in":"query","schema":{"type":"string","example":"e74b5a4f-f252-4a6c-940c-f35873498543"},"description":"The entity id to filter by"}],"responses":{"200":{"description":"Sync","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"971cb76d-9558-42fe-8f3b-8a531c32bd5f"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"70da3830-b717-49cb-91f0-22fb3f09a97a"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false},"provider_name":{"type":"string","example":"hubspot"},"customer_id":{"type":"string","example":"my-customer-1"}},"required":["id","type","entity_id","connection_id","sync_config_id","paused","provider_name","customer_id"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"971cb76d-9558-42fe-8f3b-8a531c32bd5f"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false},"provider_name":{"type":"string","example":"hubspot"},"customer_id":{"type":"string","example":"my-customer-1"}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused","provider_name","customer_id"]}],"title":"sync_with_provider_and_customer"}}}}]}}}}},"method":"get","path":"/syncs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get Syncs","description":{"content":"Get a list of Syncs.","type":"text/plain"},"url":{"path":["syncs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"Number of results to return per page","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"customer_id","value":""},{"disabled":false,"description":{"content":"The provider name","type":"text/plain"},"key":"provider_name","value":""},{"disabled":false,"description":{"content":"The object type to filter by","type":"text/plain"},"key":"object_type","value":""},{"disabled":false,"description":{"content":"The object to filter by","type":"text/plain"},"key":"object","value":""},{"disabled":false,"description":{"content":"The entity id to filter by","type":"text/plain"},"key":"entity_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getSyncs","tags":["Syncs"],"security":[{"x-api-key":[]}],"description":"Get a list of Syncs.","parameters":[{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"page_size","in":"query","schema":{"type":"string","example":"100"},"description":"Number of results to return per page"},{"name":"customer_id","in":"query","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application"},{"name":"provider_name","in":"query","schema":{"type":"string","example":"salesforce"},"description":"The provider name"},{"name":"object_type","in":"query","schema":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"description":"The object type to filter by"},{"name":"object","in":"query","schema":{"type":"string","example":"contact"},"description":"The object to filter by"},{"name":"entity_id","in":"query","schema":{"type":"string","example":"e74b5a4f-f252-4a6c-940c-f35873498543"},"description":"The entity id to filter by"}],"responses":{"200":{"description":"Sync","content":{"application/json":{"schema":{"allOf":[{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"],"title":"pagination"},{"type":"object","properties":{"results":{"type":"array","items":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"971cb76d-9558-42fe-8f3b-8a531c32bd5f"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"70da3830-b717-49cb-91f0-22fb3f09a97a"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false},"provider_name":{"type":"string","example":"hubspot"},"customer_id":{"type":"string","example":"my-customer-1"}},"required":["id","type","entity_id","connection_id","sync_config_id","paused","provider_name","customer_id"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"971cb76d-9558-42fe-8f3b-8a531c32bd5f"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false},"provider_name":{"type":"string","example":"hubspot"},"customer_id":{"type":"string","example":"my-customer-1"}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused","provider_name","customer_id"]}],"title":"sync_with_provider_and_customer"}}}}]}}}}},"method":"get","path":"/syncs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Get Syncs","description":{"content":"Get a list of Syncs.","type":"text/plain"},"url":{"path":["syncs"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""},{"disabled":false,"description":{"content":"Number of results to return per page","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"customer_id","value":""},{"disabled":false,"description":{"content":"The provider name","type":"text/plain"},"key":"provider_name","value":""},{"disabled":false,"description":{"content":"The object type to filter by","type":"text/plain"},"key":"object_type","value":""},{"disabled":false,"description":{"content":"The object to filter by","type":"text/plain"},"key":"object","value":""},{"disabled":false,"description":{"content":"The entity id to filter by","type":"text/plain"},"key":"entity_id","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/list-entity-mappings.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/list-entity-mappings.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/list-entity-mappings.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/list-entity-mappings.api.mdx index 550d3b939..9f373d62f 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/list-entity-mappings.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/list-entity-mappings.api.mdx @@ -5,7 +5,7 @@ description: "List entity mappings." sidebar_label: "List entity mappings." hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"listEntityMappings","tags":["EntityMappings"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of entity mappings","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string"},"entity_name":{"type":"string"},"allow_additional_field_mappings":{"type":"boolean"},"object":{"allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},{"type":"object","properties":{"from":{"type":"string","enum":["developer","customer"]}},"required":["from"]}]},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string"},"mapped_field":{"type":"string"},"from":{"type":"string","enum":["developer","customer"]},"is_additional":{"type":"boolean"}},"required":["entity_field","is_additional"]}}},"required":["entity_id","entity_name","allow_additional_field_mappings","field_mappings"],"title":"merged_entity_mapping"}}}}}},"description":"List entity mappings.","method":"get","path":"/entity_mappings","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List entity mappings.","description":{"type":"text/plain"},"url":{"path":["entity_mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} +api: {"deprecated":true,"operationId":"listEntityMappings","tags":["EntityMappings"],"security":[{"ApiKeyAuth":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of entity mappings","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string"},"entity_name":{"type":"string"},"allow_additional_field_mappings":{"type":"boolean"},"object":{"allOf":[{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},{"type":"object","properties":{"from":{"type":"string","enum":["developer","customer"]}},"required":["from"]}]},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string"},"mapped_field":{"type":"string"},"from":{"type":"string","enum":["developer","customer"]},"is_additional":{"type":"boolean"}},"required":["entity_field","is_additional"]}}},"required":["entity_id","entity_name","allow_additional_field_mappings","field_mappings"],"title":"merged_entity_mapping"}}}}}},"description":"List entity mappings.","method":"get","path":"/entity_mappings","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List entity mappings.","description":{"type":"text/plain"},"url":{"path":["entity_mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET"}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/list-field-mappings.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/list-field-mappings.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/list-field-mappings.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/list-field-mappings.api.mdx index 8dd930c84..4e35fee79 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/list-field-mappings.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/list-field-mappings.api.mdx @@ -5,7 +5,7 @@ description: "List schema mappings" sidebar_label: "List schema mappings" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"listFieldMappings","tags":["SchemaMappings"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of objects and their field mappings (if set)","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"object_name":{"type":"string","example":"contact"},"object_type":{"type":"string","enum":["common","standard"]},"allow_additional_field_mappings":{"type":"boolean","example":true},"schema_id":{"type":"string","example":"51797e8d-f081-496d-99ec-5e41b467df4b"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field as set in the schema","example":"email"},"is_added_by_customer":{"type":"boolean","description":"Whether the field was added by the customer (only applicable if the schema has allow_additional_field_mappings set to true)"},"schema_mapped_name":{"type":"string","description":"The mapped named of the field as set in the schema by the developer. If set, the customer cannot override. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."},"customer_mapped_name":{"type":"string","description":"The mapped name of the field as set by the customer. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."}},"required":["name","is_added_by_customer"],"title":"merged_field_map"}}},"required":["object_name","object_type","allow_additional_field_mappings","schema_id","fields"],"title":"object_field_mappings"}}}}}},"description":"List schema mappings","method":"get","path":"/field_mappings","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List schema mappings","description":{"type":"text/plain"},"url":{"path":["field_mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"listFieldMappings","tags":["SchemaMappings"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"List of objects and their field mappings (if set)","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"object_name":{"type":"string","example":"contact"},"object_type":{"type":"string","enum":["common","standard"]},"allow_additional_field_mappings":{"type":"boolean","example":true},"schema_id":{"type":"string","example":"51797e8d-f081-496d-99ec-5e41b467df4b"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field as set in the schema","example":"email"},"is_added_by_customer":{"type":"boolean","description":"Whether the field was added by the customer (only applicable if the schema has allow_additional_field_mappings set to true)"},"schema_mapped_name":{"type":"string","description":"The mapped named of the field as set in the schema by the developer. If set, the customer cannot override. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."},"customer_mapped_name":{"type":"string","description":"The mapped name of the field as set by the customer. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."}},"required":["name","is_added_by_customer"],"title":"merged_field_map"}}},"required":["object_name","object_type","allow_additional_field_mappings","schema_id","fields"],"title":"object_field_mappings"}}}}}},"description":"List schema mappings","method":"get","path":"/field_mappings","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"List schema mappings","description":{"type":"text/plain"},"url":{"path":["field_mappings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/magic-links.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/magic-links.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/magic-links.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/magic-links.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/management-api.info.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/management-api.info.mdx similarity index 98% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/management-api.info.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/management-api.info.mdx index 98857f1f9..c80de153b 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/management-api.info.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/management-api.info.mdx @@ -13,7 +13,7 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 0.14.10 +Version: 0.14.12 diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/object-field-mapping-created.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/object-field-mapping-created.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/object-field-mapping-created.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/object-field-mapping-created.api.mdx index 25d996cd7..9be485ad0 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/object-field-mapping-created.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/object-field-mapping-created.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the creation of am object field mapping" sidebar_label: "Object field mapping created" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of the creation of am object field mapping","operationId":"objectFieldMappingCreated","x-event-type":"object.field_mapping.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"object.field_mapping.created","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"salesforce","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"ERROR","error_message":"Error message"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["object.field_mapping.created"],"example":"object.field_mapping.created"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"customer_id":{"type":"string","example":"c7c5204a-61d3-44a7-b581-a1f29b239f89"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"object_name":{"type":"string","example":"Contact"},"object_type":{"type":"string","enum":["common","standard"]},"schema_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","connection_id","application_id","customer_id","provider_name","object_name","object_type","schema_id","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"object.field_mapping.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"object.field_mapping.created","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"hubspot","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of the creation of am object field mapping","operationId":"objectFieldMappingCreated","x-event-type":"object.field_mapping.created","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"object.field_mapping.created","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"salesforce","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"ERROR","error_message":"Error message"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["object.field_mapping.created"],"example":"object.field_mapping.created"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"customer_id":{"type":"string","example":"c7c5204a-61d3-44a7-b581-a1f29b239f89"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"object_name":{"type":"string","example":"Contact"},"object_type":{"type":"string","enum":["common","standard"]},"schema_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","connection_id","application_id","customer_id","provider_name","object_name","object_type","schema_id","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"object.field_mapping.created"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"object.field_mapping.created","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"hubspot","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/object-field-mapping-updated.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/object-field-mapping-updated.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/object-field-mapping-updated.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/object-field-mapping-updated.api.mdx index 8870de0f8..0a674ec06 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/object-field-mapping-updated.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/object-field-mapping-updated.api.mdx @@ -5,7 +5,7 @@ description: "Notification of an update to an object field mapping" sidebar_label: "Object field mapping updated" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of an update to an object field mapping","operationId":"objectFieldMappingUpdated","x-event-type":"object.field_mapping.updated","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"object.field_mapping.updated","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"salesforce","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"ERROR","error_message":"Error message"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["object.field_mapping.updated"],"example":"object.field_mapping.updated"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"customer_id":{"type":"string","example":"c7c5204a-61d3-44a7-b581-a1f29b239f89"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"object_name":{"type":"string","example":"Contact"},"object_type":{"type":"string","enum":["common","standard"]},"schema_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","connection_id","application_id","customer_id","provider_name","object_name","object_type","schema_id","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"object.field_mapping.updated"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"object.field_mapping.updated","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"hubspot","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of an update to an object field mapping","operationId":"objectFieldMappingUpdated","x-event-type":"object.field_mapping.updated","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"object.field_mapping.updated","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"salesforce","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"ERROR","error_message":"Error message"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","enum":["object.field_mapping.updated"],"example":"object.field_mapping.updated"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"application_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"customer_id":{"type":"string","example":"c7c5204a-61d3-44a7-b581-a1f29b239f89"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"object_name":{"type":"string","example":"Contact"},"object_type":{"type":"string","enum":["common","standard"]},"schema_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"error_message":{"type":"string","example":"Error message"}},"required":["webhook_event_type","connection_id","application_id","customer_id","provider_name","object_name","object_type","schema_id","result"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"object.field_mapping.updated"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"object.field_mapping.updated","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","application_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","customer_id":"c7c5204a-61d3-44a7-b581-a1f29b239f89","provider_name":"hubspot","object_name":"Contact","object_type":"common","schema_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","result":"SUCCESS","error_message":"Error message"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/pause-sync.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/pause-sync.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/pause-sync.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/pause-sync.api.mdx index 1021cace2..6b9283d39 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/pause-sync.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/pause-sync.api.mdx @@ -5,7 +5,7 @@ description: "Pause sync" sidebar_label: "Pause sync" hide_title: true hide_table_of_contents: true -api: {"operationId":"pauseSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","description":"The entity id to filter by"}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard","description":"The object type to filter by"},"object":{"type":"string","example":"Contact","description":"The Provider object to filter by (case sensitive)"}},"required":["object_type","object"]},{"type":"object","title":"Data model: Common Schema","properties":{"object_type":{"type":"string","enum":["common"],"example":"common","description":"The object type to filter by"},"object":{"type":"string","example":"contact","description":"The Supaglue object to filter by"}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync paused","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"}}}}},"description":"Pause sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_pause","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Pause sync","description":{"type":"text/plain"},"url":{"path":["syncs","_pause"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"pauseSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","description":"The entity id to filter by"}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard","description":"The object type to filter by"},"object":{"type":"string","example":"Contact","description":"The Provider object to filter by (case sensitive)"}},"required":["object_type","object"]},{"type":"object","title":"Data model: Common Schema","properties":{"object_type":{"type":"string","enum":["common"],"example":"common","description":"The object type to filter by"},"object":{"type":"string","example":"contact","description":"The Supaglue object to filter by"}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync paused","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"}}}}},"description":"Pause sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_pause","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Pause sync","description":{"type":"text/plain"},"url":{"path":["syncs","_pause"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/providers.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/providers.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/providers.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/providers.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/resume-sync.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/resume-sync.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/resume-sync.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/resume-sync.api.mdx index 09038e776..ec31e336d 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/resume-sync.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/resume-sync.api.mdx @@ -5,7 +5,7 @@ description: "Resume sync" sidebar_label: "Resume sync" hide_title: true hide_table_of_contents: true -api: {"operationId":"resumeSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","example":"cfba6060-c43a-4a63-8a8c-501c6099f8b0","description":"The entity id to filter by"}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard","description":"The object type to filter by"},"object":{"type":"string","example":"contact","description":"The object to filter by"}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync resumed","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"},"example":{"id":"2caab904-3c7c-4894-8c82-4c28913b3419","type":"entity","entity_id":"db602f88-7a8c-44f0-8932-c92f1e033494","connection_id":"da732713-2ff7-4f3b-8728-257a026177cd","sync_config_id":"f2b3ea2a-6a1e-4983-91f1-92a4db4d7abd","paused":false}}}}},"description":"Resume sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_resume","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"cfba6060-c43a-4a63-8a8c-501c6099f8b0"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Resume sync","description":{"type":"text/plain"},"url":{"path":["syncs","_resume"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"resumeSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","example":"cfba6060-c43a-4a63-8a8c-501c6099f8b0","description":"The entity id to filter by"}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard","description":"The object type to filter by"},"object":{"type":"string","example":"contact","description":"The object to filter by"}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync resumed","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"},"example":{"id":"2caab904-3c7c-4894-8c82-4c28913b3419","type":"entity","entity_id":"db602f88-7a8c-44f0-8932-c92f1e033494","connection_id":"da732713-2ff7-4f3b-8728-257a026177cd","sync_config_id":"f2b3ea2a-6a1e-4983-91f1-92a4db4d7abd","paused":false}}}}},"description":"Resume sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_resume","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"cfba6060-c43a-4a63-8a8c-501c6099f8b0"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Resume sync","description":{"type":"text/plain"},"url":{"path":["syncs","_resume"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/salesforce-cdc-create.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/salesforce-cdc-create.api.mdx similarity index 98% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/salesforce-cdc-create.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/salesforce-cdc-create.api.mdx index 906412518..563b131e3 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/salesforce-cdc-create.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/salesforce-cdc-create.api.mdx @@ -5,7 +5,7 @@ description: "When a record is created in a customer's Salesforce (beta)" sidebar_label: "Salesforce record created (beta)" hide_title: true hide_table_of_contents: true -api: {"description":"When a record is created in a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcCreate","x-event-type":"salesforce_cdc.create","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.create"},"id":{"type":"string","description":"The Salesforce ID of the record that was created","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"},"fields":{"type":"object","description":"The fields that were set when the record was created","example":{"Name":"Acme"}}},"required":["webhook_event_type","id","entity_name","fields"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.create"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.create","id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"When a record is created in a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcCreate","x-event-type":"salesforce_cdc.create","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.create"},"id":{"type":"string","description":"The Salesforce ID of the record that was created","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"},"fields":{"type":"object","description":"The fields that were set when the record was created","example":{"Name":"Acme"}}},"required":["webhook_event_type","id","entity_name","fields"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.create"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.create","id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/salesforce-cdc-delete.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/salesforce-cdc-delete.api.mdx similarity index 98% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/salesforce-cdc-delete.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/salesforce-cdc-delete.api.mdx index c30719bc9..63e4ad0c5 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/salesforce-cdc-delete.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/salesforce-cdc-delete.api.mdx @@ -5,7 +5,7 @@ description: "When a record is deleted from a customer's Salesforce (beta)" sidebar_label: "Salesforce record deleted (beta)" hide_title: true hide_table_of_contents: true -api: {"description":"When a record is deleted from a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcDelete","x-event-type":"salesforce_cdc.delete","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.delete"},"id":{"type":"string","description":"The Salesforce ID of the record that was deleted","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"}},"required":["webhook_event_type","id","entity_name"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.delete"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.delete","id":"0011t00000B0G6uAAF","entity_name":"Account"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"When a record is deleted from a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcDelete","x-event-type":"salesforce_cdc.delete","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account"},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.delete"},"id":{"type":"string","description":"The Salesforce ID of the record that was deleted","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"}},"required":["webhook_event_type","id","entity_name"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.delete"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.delete","id":"0011t00000B0G6uAAF","entity_name":"Account"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/salesforce-cdc-undelete.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/salesforce-cdc-undelete.api.mdx similarity index 98% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/salesforce-cdc-undelete.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/salesforce-cdc-undelete.api.mdx index f607db26f..db8dc183d 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/salesforce-cdc-undelete.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/salesforce-cdc-undelete.api.mdx @@ -5,7 +5,7 @@ description: "When a record is undeleted in a customer's Salesforce (beta)" sidebar_label: "Salesforce record undeleted (beta)" hide_title: true hide_table_of_contents: true -api: {"description":"When a record is undeleted in a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcUndelete","x-event-type":"salesforce_cdc.undelete","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.undelete"},"id":{"type":"string","description":"The Salesforce ID of the record that was undeleted","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"},"fields":{"type":"object","description":"The fields that were set when the record was undeleted","example":{"Name":"Acme"}}},"required":["webhook_event_type","id","entity_name","fields"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.undelete"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.undelete","id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"When a record is undeleted in a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcUndelete","x-event-type":"salesforce_cdc.undelete","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.undelete"},"id":{"type":"string","description":"The Salesforce ID of the record that was undeleted","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"},"fields":{"type":"object","description":"The fields that were set when the record was undeleted","example":{"Name":"Acme"}}},"required":["webhook_event_type","id","entity_name","fields"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.undelete"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.undelete","id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/salesforce-cdc-update.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/salesforce-cdc-update.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/salesforce-cdc-update.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/salesforce-cdc-update.api.mdx index a04bf0ebe..289f0415c 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/salesforce-cdc-update.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/salesforce-cdc-update.api.mdx @@ -5,7 +5,7 @@ description: "When a record is updated in a customer's Salesforce (beta)" sidebar_label: "Salesforce record updated (beta)" hide_title: true hide_table_of_contents: true -api: {"description":"When a record is updated in a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcUpdate","x-event-type":"salesforce_cdc.update","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"},"nulled_fields":[],"changed_fields":["Name"],"diff_fields":[]},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.update"},"id":{"type":"string","description":"The Salesforce ID of the record that was updated","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"},"nulled_fields":{"type":"array","description":"The fields that were set to null when the record was updated","example":["PhoneNumber2"],"items":{"type":"string"}},"changed_fields":{"type":"array","description":"The fields that were changed when the record was updated","example":["Name"],"items":{"type":"string"}},"diff_fields":{"type":"array","description":"The fields that were changed when the record was updated and the value in the fields object is a diff to be applied to the existing value","example":["Description"],"items":{"type":"string"}},"fields":{"type":"object","description":"The fields that were set when the record was created"}},"required":["webhook_event_type","id","entity_name","fields","nulled_fields","changed_fields","diff_fields"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.update"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.update","id":"0011t00000B0G6uAAF","entity_name":"Account","nulled_fields":["PhoneNumber2"],"changed_fields":["Name"],"diff_fields":["Description"],"fields":{}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"When a record is updated in a customer's Salesforce (beta)\n\nThis feature is in private beta in Supaglue Cloud. Please [register](https://m8ndtm64l4g.typeform.com/to/ovOUDxGj) if you'd like early access.","operationId":"salesforceCdcUpdate","x-event-type":"salesforce_cdc.update","tags":["Salesforce CDC Events (beta)"],"requestBody":{"content":{"application/json":{"example":{"id":"0011t00000B0G6uAAF","entity_name":"Account","fields":{"Name":"Acme"},"nulled_fields":[],"changed_fields":["Name"],"diff_fields":[]},"schema":{"type":"object","properties":{"webhook_event_type":{"type":"string","description":"The type of webhook event","example":"salesforce_cdc.update"},"id":{"type":"string","description":"The Salesforce ID of the record that was updated","example":"0011t00000B0G6uAAF"},"entity_name":{"type":"string","description":"The name of the Salesforce object that the record belongs to","example":"Account"},"nulled_fields":{"type":"array","description":"The fields that were set to null when the record was updated","example":["PhoneNumber2"],"items":{"type":"string"}},"changed_fields":{"type":"array","description":"The fields that were changed when the record was updated","example":["Name"],"items":{"type":"string"}},"diff_fields":{"type":"array","description":"The fields that were changed when the record was updated and the value in the fields object is a diff to be applied to the existing value","example":["Description"],"items":{"type":"string"}},"fields":{"type":"object","description":"The fields that were set when the record was created"}},"required":["webhook_event_type","id","entity_name","fields","nulled_fields","changed_fields","diff_fields"]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"salesforce_cdc.update"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"salesforce_cdc.update","id":"0011t00000B0G6uAAF","entity_name":"Account","nulled_fields":["PhoneNumber2"],"changed_fields":["Name"],"diff_fields":["Description"],"fields":{}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/schema-mappings.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/schema-mappings.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/schema-mappings.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/schema-mappings.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/schemas.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/schemas.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/schemas.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/schemas.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/sidebar.js b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/sidebar.js rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/sidebar.js diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/sync-complete.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/sync-complete.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/sync-complete.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/sync-complete.api.mdx index 2408029bc..db01f84c2 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/sync-complete.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/sync-complete.api.mdx @@ -5,7 +5,7 @@ description: "Notification of the completion of a sync" sidebar_label: "Sync complete" hide_title: true hide_table_of_contents: true -api: {"description":"Notification of the completion of a sync","operationId":"syncComplete","x-event-type":"sync.complete","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"sync.complete","run_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","customer_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","provider_name":"salesforce","type":"object","object_type":"standard","object":"contact","result":"ERROR","error_message":"Error message"},"schema":{"oneOf":[{"type":"object","title":"Object Sync Complete","properties":{"webhook_event_type":{"type":"string","enum":["sync.complete"],"example":"sync.complete"},"run_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"customer_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"num_records_synced":{"type":"integer","example":100},"error_message":{"type":"string","example":"Error message"},"type":{"type":"string","enum":["object"]},"object_type":{"type":"string","enum":["common","standard","custom"]},"object":{"type":"string","example":"contact"}},"required":["webhook_event_type","run_id","connection_id","customer_id","provider_name","result","type","object_type","object"]},{"type":"object","title":"Entity Sync Complete","properties":{"webhook_event_type":{"type":"string","enum":["sync.complete"],"example":"sync.complete"},"run_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"customer_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"num_records_synced":{"type":"integer","example":100},"error_message":{"type":"string","example":"Error message"},"type":{"type":"string","enum":["entity"]},"entity_id":{"type":"string"},"entity_name":{"type":"string"}},"required":["webhook_event_type","run_id","connection_id","customer_id","provider_name","result","type","entity_id","entity_name"]}]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"sync.complete"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"sync.complete","run_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","customer_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","provider_name":"hubspot","result":"SUCCESS","num_records_synced":100,"error_message":"Error message","type":"object","object_type":"common","object":"contact"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} +api: {"description":"Notification of the completion of a sync","operationId":"syncComplete","x-event-type":"sync.complete","tags":["Webhook Events"],"requestBody":{"content":{"application/json":{"example":{"webhook_event_type":"sync.complete","run_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","customer_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","provider_name":"salesforce","type":"object","object_type":"standard","object":"contact","result":"ERROR","error_message":"Error message"},"schema":{"oneOf":[{"type":"object","title":"Object Sync Complete","properties":{"webhook_event_type":{"type":"string","enum":["sync.complete"],"example":"sync.complete"},"run_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"customer_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"num_records_synced":{"type":"integer","example":100},"error_message":{"type":"string","example":"Error message"},"type":{"type":"string","enum":["object"]},"object_type":{"type":"string","enum":["common","standard","custom"]},"object":{"type":"string","example":"contact"}},"required":["webhook_event_type","run_id","connection_id","customer_id","provider_name","result","type","object_type","object"]},{"type":"object","title":"Entity Sync Complete","properties":{"webhook_event_type":{"type":"string","enum":["sync.complete"],"example":"sync.complete"},"run_id":{"type":"string","example":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d"},"connection_id":{"type":"string","example":"e30cbb93-5b05-4186-b6de-1acc10013795"},"customer_id":{"type":"string","example":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"result":{"type":"string","enum":["SUCCESS","ERROR"]},"num_records_synced":{"type":"integer","example":100},"error_message":{"type":"string","example":"Error message"},"type":{"type":"string","enum":["entity"]},"entity_id":{"type":"string"},"entity_name":{"type":"string"}},"required":["webhook_event_type","run_id","connection_id","customer_id","provider_name","result","type","entity_id","entity_name"]}]}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully"}},"extensions":[{"key":"x-event-type","value":"sync.complete"}],"method":"event","path":"webhook","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"webhook_event_type":"sync.complete","run_id":"2fdbd03d-11f2-4e66-a5e6-2b731c71a12d","connection_id":"e30cbb93-5b05-4186-b6de-1acc10013795","customer_id":"7bfcc74d-c98b-49de-8e8f-3dc7a17273f6","provider_name":"hubspot","result":"SUCCESS","num_records_synced":100,"error_message":"Error message","type":"object","object_type":"common","object":"contact"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"}} sidebar_class_name: "event api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/sync-configs.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/sync-configs.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/sync-configs.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/sync-configs.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/sync-runs.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/sync-runs.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/sync-runs.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/sync-runs.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/syncs.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/syncs.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/syncs.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/syncs.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/trigger-sync.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/trigger-sync.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/trigger-sync.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/trigger-sync.api.mdx index 2a75c3bcc..d8cec4137 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/trigger-sync.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/trigger-sync.api.mdx @@ -5,7 +5,7 @@ description: "Trigger sync" sidebar_label: "Trigger sync" hide_title: true hide_table_of_contents: true -api: {"operationId":"triggerSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","description":"The entity id to filter by"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["standard","custom"],"description":"The object type to filter by","example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider object to filter by (case sensitive)"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["object_type","object"]},{"type":"object","title":"Data model: Common Schema","properties":{"object_type":{"type":"string","enum":["common"],"description":"The object type to filter by","example":"common"},"object":{"type":"string","example":"contact","description":"The Supaglue object to filter by"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync triggered","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"}}}}},"description":"Trigger sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_trigger","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string","perform_full_refresh":true},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Trigger sync","description":{"type":"text/plain"},"url":{"path":["syncs","_trigger"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"triggerSync","tags":["Syncs"],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"entity_id":{"type":"string","description":"The entity id to filter by"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["entity_id"]},{"type":"object","title":"Data model: Objects","properties":{"object_type":{"type":"string","enum":["standard","custom"],"description":"The object type to filter by","example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider object to filter by (case sensitive)"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["object_type","object"]},{"type":"object","title":"Data model: Common Schema","properties":{"object_type":{"type":"string","enum":["common"],"description":"The object type to filter by","example":"common"},"object":{"type":"string","example":"contact","description":"The Supaglue object to filter by"},"perform_full_refresh":{"type":"boolean","example":true}},"required":["object_type","object"]}]}}}},"responses":{"200":{"description":"Sync triggered","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Data model: Entities","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["entity"],"example":"entity"},"entity_id":{"type":"string","example":"94e6cb6c-0ec8-423f-8873-21054979a6b1"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","entity_id","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Objects","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common","standard","custom"],"example":"standard"},"object":{"type":"string","example":"contact","description":"The Provider's object name (case sensitive)"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]},{"type":"object","title":"Data model: Common Schema","properties":{"id":{"type":"string","example":"7026e4e8-15d7-48d8-b997-f2592b654619"},"type":{"type":"string","enum":["object"],"example":"object"},"object_type":{"type":"string","enum":["common"],"example":"standard"},"object":{"type":"string","example":"contact","description":"Supaglue's object name"},"connection_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e4"},"sync_config_id":{"type":"string","example":"3217ea51-11c8-43c9-9547-6f197e02e5e5"},"paused":{"type":"boolean","example":false}},"required":["id","type","object_type","object","connection_id","sync_config_id","paused"]}],"title":"sync"}}}}},"description":"Trigger sync","parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"method":"post","path":"/syncs/_trigger","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string","perform_full_refresh":true},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Trigger sync","description":{"type":"text/plain"},"url":{"path":["syncs","_trigger"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "post api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-destination.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-destination.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-destination.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-destination.api.mdx index 093d54b28..e4a142f22 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-destination.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-destination.api.mdx @@ -5,7 +5,7 @@ description: "Update destination" sidebar_label: "Update destination" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateDestination","tags":["Destinations"],"parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser","password":"mysensitivepassword"}},"oneOf":[{"type":"object","title":"postgres","properties":{"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","port","database","schema","user"],"title":"postgres_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]},{"type":"object","title":"s3","properties":{"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"},"secret_access_key":{"type":"string","example":"A1lciPB09K2iqNHTLAftxTHy0SKGxNcO4QecAsZS"}},"required":["region","bucket","access_key_id"],"title":"s3_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"},"private_key":{"type":"string","example":"-----BEGIN PRIVATE KEY-----\\nMII..."}},"required":["client_email","private_key"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"name":{"type":"string","example":"My MongoDB Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","database","user"],"title":"mongodb_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]}],"title":"update_destination"}}}},"responses":{"200":{"description":"Destination","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Update destination","method":"put","path":"/destinations/{destination_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser","password":"mysensitivepassword"}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update destination","description":{"type":"text/plain"},"url":{"path":["destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"destination_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"operationId":"updateDestination","tags":["Destinations"],"parameters":[{"name":"destination_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"example":{"name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser","password":"mysensitivepassword"}},"oneOf":[{"type":"object","title":"postgres","properties":{"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","port","database","schema","user"],"title":"postgres_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]},{"type":"object","title":"s3","properties":{"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"},"secret_access_key":{"type":"string","example":"A1lciPB09K2iqNHTLAftxTHy0SKGxNcO4QecAsZS"}},"required":["region","bucket","access_key_id"],"title":"s3_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"},"private_key":{"type":"string","example":"-----BEGIN PRIVATE KEY-----\\nMII..."}},"required":["client_email","private_key"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"name":{"type":"string","example":"My MongoDB Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"},"password":{"type":"string","example":"mysensitivepassword"}},"required":["host","database","user"],"title":"mongodb_config_at_least_safe"},"version":{"type":"number","example":"number"}},"required":["name","type","config","version"]}],"title":"update_destination"}}}},"responses":{"200":{"description":"Destination","content":{"application/json":{"schema":{"example":{"id":"2cce5aed-e8fc-41b2-bff6-6ddbc1f99285","application_id":"e52286c9-3038-4fa2-a2b8-3ec9759d20cb","name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser"}},"oneOf":[{"type":"object","title":"supaglue","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"type":{"type":"string","enum":["supaglue"],"example":"supaglue"},"version":{"type":"number"}},"required":["id","application_id","type","version"]},{"type":"object","title":"postgres","properties":{"id":{"type":"string","example":"d455d20b-f6dc-4bc3-ab14-b4f21c4b4835"},"application_id":{"type":"string","example":"726fb798-d854-4c59-9a23-57e3e2f73eae"},"name":{"type":"string","example":"My Postgres Destination"},"type":{"type":"string","enum":["postgres"],"example":"postgres"},"config":{"type":"object","properties":{"host":{"type":"string","example":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com"},"port":{"type":"number","example":5432},"database":{"type":"string","example":"postgres_prod_db"},"schema":{"type":"string","example":"public"},"user":{"type":"string","example":"myuser"},"ssl_mode":{"type":"string","enum":["disable","allow","prefer","require"],"example":"disable"}},"required":["host","port","database","schema","user"],"title":"postgres_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"s3","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My S3 Destination"},"type":{"type":"string","enum":["s3"],"example":"s3"},"config":{"type":"object","properties":{"region":{"type":"string","example":"us-west-2"},"bucket":{"type":"string","example":"my-test-bucket"},"access_key_id":{"type":"string","example":"AKIAIOSFODNN7EXAMPLE"}},"required":["region","bucket","access_key_id"],"title":"s3_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"bigquery","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My BigQuery Destination"},"type":{"type":"string","enum":["bigquery"],"example":"bigquery"},"config":{"type":"object","properties":{"project_id":{"type":"string","example":"my-gcp-project-id"},"dataset":{"type":"string","example":"my_bigquery_dataset"},"credentials":{"type":"object","properties":{"client_email":{"type":"string","example":"my_bigquery_service_account@my_project.iam.gserviceaccount.com"}},"required":["client_email"]}},"required":["project_id","dataset","credentials"],"title":"bigquery_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]},{"type":"object","title":"mongodb","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"name":{"type":"string","example":"My Mongo Destination"},"type":{"type":"string","enum":["mongodb"],"example":"mongodb"},"config":{"type":"object","properties":{"host":{"type":"string","example":"my-cluster.z31wcmj.mongodb.net"},"database":{"type":"string","example":"my-cluster"},"user":{"type":"string","example":"myuser"}},"required":["host","database","user"],"title":"mongodb_config_safe"},"version":{"type":"number"}},"required":["id","application_id","name","type","config","version"]}],"title":"destination"}}}}},"description":"Update destination","method":"put","path":"/destinations/{destination_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"My Postgres Destination","type":"postgres","config":{"host":"production-db-new.cluster-cdhnnutnlctj.us-west-2.rds.amazonaws.com","port":5432,"database":"postgres_prod_db","schema":"public","user":"myuser","password":"mysensitivepassword"}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update destination","description":{"type":"text/plain"},"url":{"path":["destinations",":destination_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"destination_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-entity.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-entity.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-entity.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-entity.api.mdx index 6a190704e..3269a4f5b 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-entity.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-entity.api.mdx @@ -5,7 +5,7 @@ description: "Update entity" sidebar_label: "Update entity" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateEntity","tags":["Entities"],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["name","config"],"title":"create_update_entity"}}}},"responses":{"200":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Update entity","method":"put","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-entity","config":{"fields":[{"name":"apolla_first_name"}],"allow_additional_field_mappings":true}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"operationId":"updateEntity","tags":["Entities"],"parameters":[{"name":"entity_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["name","config"],"title":"create_update_entity"}}}},"responses":{"200":{"description":"Entity","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-entity"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name"}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean"}},"required":["fields","allow_additional_field_mappings"],"title":"entity_config"}},"required":["id","application_id","name","config"],"title":"entity"}}}}},"description":"Update entity","method":"put","path":"/entities/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-entity","config":{"fields":[{"name":"apolla_first_name"}],"allow_additional_field_mappings":true}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update entity","description":{"type":"text/plain"},"url":{"path":["entities",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-object-field-mappings.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-object-field-mappings.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-object-field-mappings.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-object-field-mappings.api.mdx index a61d1050a..649bfb1ad 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-object-field-mappings.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-object-field-mappings.api.mdx @@ -5,7 +5,7 @@ description: "Update schema mappings" sidebar_label: "Update schema mappings" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"updateObjectFieldMappings","tags":["SchemaMappings"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"contact"},"type":{"type":"string","enum":["common","standard"]},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["name","type","field_mappings"],"title":"update_object_field_mapping"}}}},"responses":{"200":{"description":"List of objects and their field mappings (if set)","content":{"application/json":{"schema":{"type":"object","properties":{"object_name":{"type":"string","example":"contact"},"object_type":{"type":"string","enum":["common","standard"]},"allow_additional_field_mappings":{"type":"boolean","example":true},"schema_id":{"type":"string","example":"51797e8d-f081-496d-99ec-5e41b467df4b"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field as set in the schema","example":"email"},"is_added_by_customer":{"type":"boolean","description":"Whether the field was added by the customer (only applicable if the schema has allow_additional_field_mappings set to true)"},"schema_mapped_name":{"type":"string","description":"The mapped named of the field as set in the schema by the developer. If set, the customer cannot override. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."},"customer_mapped_name":{"type":"string","description":"The mapped name of the field as set by the customer. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."}},"required":["name","is_added_by_customer"],"title":"merged_field_map"}}},"required":["object_name","object_type","allow_additional_field_mappings","schema_id","fields"],"title":"object_field_mappings"}}}}},"description":"Update schema mappings","method":"put","path":"/field_mappings/_update_object","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"contact","type":"common","field_mappings":[{"schema_field":"apolla_first_name","mapped_field":"FirstName"}]},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update schema mappings","description":{"type":"text/plain"},"url":{"path":["field_mappings","_update_object"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"deprecated":true,"operationId":"updateObjectFieldMappings","tags":["SchemaMappings"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"contact"},"type":{"type":"string","enum":["common","standard"]},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["name","type","field_mappings"],"title":"update_object_field_mapping"}}}},"responses":{"200":{"description":"List of objects and their field mappings (if set)","content":{"application/json":{"schema":{"type":"object","properties":{"object_name":{"type":"string","example":"contact"},"object_type":{"type":"string","enum":["common","standard"]},"allow_additional_field_mappings":{"type":"boolean","example":true},"schema_id":{"type":"string","example":"51797e8d-f081-496d-99ec-5e41b467df4b"},"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"The name of the field as set in the schema","example":"email"},"is_added_by_customer":{"type":"boolean","description":"Whether the field was added by the customer (only applicable if the schema has allow_additional_field_mappings set to true)"},"schema_mapped_name":{"type":"string","description":"The mapped named of the field as set in the schema by the developer. If set, the customer cannot override. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."},"customer_mapped_name":{"type":"string","description":"The mapped name of the field as set by the customer. Only one of `schema_mapped_name` or `customer_mapped_name` should be set."}},"required":["name","is_added_by_customer"],"title":"merged_field_map"}}},"required":["object_name","object_type","allow_additional_field_mappings","schema_id","fields"],"title":"object_field_mappings"}}}}},"description":"Update schema mappings","method":"put","path":"/field_mappings/_update_object","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"contact","type":"common","field_mappings":[{"schema_field":"apolla_first_name","mapped_field":"FirstName"}]},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update schema mappings","description":{"type":"text/plain"},"url":{"path":["field_mappings","_update_object"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-provider.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-provider.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-provider.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-provider.api.mdx index dfd84e7d6..b6369c8bd 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-provider.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-provider.api.mdx @@ -5,7 +5,7 @@ description: "Update provider" sidebar_label: "Update provider" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateProvider","tags":["Providers"],"parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"crm","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["crm"]},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule"],"title":"provider_name_crm"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"engagement","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["engagement"]},"name":{"type":"string","enum":["outreach","apollo","salesloft"],"title":"provider_name_engagement"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"no category","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["no_category"]},"name":{"type":"string","enum":["intercom","gong","linear"],"title":"provider_name_no_category"}},"required":["auth_type","config","category","name"]}],"title":"update_provider"}}}},"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Update provider","method":"put","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"auth_type":"oauth2","config":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"objects":{"common":[{"name":"account","schema_id":"328a8cb3-8345-4b02-b661-ee13b4f76806"}],"standard":[{"name":"Account","schema_id":"777ea826-5776-4347-9ece-47bbb17ccdd4"}]},"entity_mappings":[{"entity_id":"apolla_contact","object":{"type":"standard","name":"Contact"},"field_mappings":[{"entity_field":"apolla_first_name","mapped_field":"FirstName"}]}],"category":"crm","name":"hubspot"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"operationId":"updateProvider","tags":["Providers"],"parameters":[{"name":"provider_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"crm","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["crm"]},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule"],"title":"provider_name_crm"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"engagement","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["engagement"]},"name":{"type":"string","enum":["outreach","apollo","salesloft"],"title":"provider_name_engagement"}},"required":["auth_type","config","category","name"]},{"type":"object","title":"no category","properties":{"auth_type":{"type":"string","enum":["oauth2"]},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string"},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"}},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string"},"oauth_client_secret":{"type":"string"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"example":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"title":"update_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}},"category":{"type":"string","enum":["no_category"]},"name":{"type":"string","enum":["intercom","gong","linear"],"title":"provider_name_no_category"}},"required":["auth_type","config","category","name"]}],"title":"update_provider"}}}},"responses":{"200":{"description":"Provider","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"0c4cb91f-e392-46f5-8934-17496371f932"},"application_id":{"type":"string","example":"273e1c75-3b6d-439a-9b8e-c6ac407df92a"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"auth_type":{"type":"string","enum":["oauth2","api_key"],"example":"oauth2"},"name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"config":{"type":"object","description":"An object that stores Oauth2/API key/access key related credentials.","properties":{"provider_app_id":{"type":"string","example":"my_app_id"},"use_managed_oauth":{"type":"boolean","description":"True: use Supaglue's OAuth application credentials. False: Use the provided OAuth application credentials.","example":true},"oauth":{"type":"object","properties":{"oauth_scopes":{"type":"array","items":{"type":"string"},"example":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"]},"credentials":{"type":"object","properties":{"oauth_client_id":{"type":"string","example":"7393b5a4-5e20-4648-87af-b7b297793fd1"},"oauth_client_secret":{"type":"string","example":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}},"required":["oauth_client_id","oauth_client_secret"]}},"required":["oauth_scopes","credentials"]}},"required":["provider_app_id","oauth"],"title":"create_provider_config"},"objects":{"type":"object","description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview). The field mappings (aka [Schemas](https://docs.supaglue.com/platform/objects/overview#schemas)) here are set by you, the developer, and the mappings apply for all your customers.","properties":{"common":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"account"},"schema_id":{"type":"string","description":"If set, will sync these mapped fields into the raw_data column in addition to the common object. If not set, will fetch all fields as is.","example":"328a8cb3-8345-4b02-b661-ee13b4f76806"}},"required":["name"]}},"standard":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Account"},"schema_id":{"type":"string","example":"777ea826-5776-4347-9ece-47bbb17ccdd4"}},"required":["name"]}}},"title":"objects"},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview). The object/field mappings (aka [Entity Mappings](https://docs.supaglue.com/platform/entities/overview#entity-mapping)) here are set by you, the developer, and the mappings apply for all your customers.","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"apolla_contact"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard"],"example":"standard"},"name":{"type":"string","example":"Contact"}},"required":["type","name"],"title":"standard_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"provider_entity_mapping"}}},"required":["id","application_id","category","auth_type","name"],"title":"provider"}}}}},"description":"Update provider","method":"put","path":"/providers/{provider_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"auth_type":"oauth2","config":{"provider_app_id":"my_app_id","oauth":{"oauth_scopes":["crm.objects.contacts.read","crm.objects.companies.read","crm.objects.deals.read","crm.objects.owners.read","crm.objects.contacts.write","crm.objects.companies.write","crm.objects.deals.write"],"credentials":{"oauth_client_id":"7393b5a4-5e20-4648-87af-b7b297793fd1","oauth_client_secret":"941b846a-5a8c-48b8-b0e1-41b6d4bc4f1a"}}},"objects":{"common":[{"name":"account","schema_id":"328a8cb3-8345-4b02-b661-ee13b4f76806"}],"standard":[{"name":"Account","schema_id":"777ea826-5776-4347-9ece-47bbb17ccdd4"}]},"entity_mappings":[{"entity_id":"apolla_contact","object":{"type":"standard","name":"Contact"},"field_mappings":[{"entity_field":"apolla_first_name","mapped_field":"FirstName"}]}],"category":"crm","name":"hubspot"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update provider","description":{"type":"text/plain"},"url":{"path":["providers",":provider_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"provider_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-schema.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-schema.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-schema.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-schema.api.mdx index 3ecf7b16d..660f16bbd 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-schema.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-schema.api.mdx @@ -5,7 +5,7 @@ description: "Update schema" sidebar_label: "Update schema" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"updateSchema","tags":["Schemas"],"parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["name","config"],"title":"create_update_schema"}}}},"responses":{"200":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Update schema","method":"put","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-schema","config":{"fields":[{"name":"apolla_first_name","mapped_name":"FirstName"}],"allow_additional_field_mappings":false}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"deprecated":true,"operationId":"updateSchema","tags":["Schemas"],"parameters":[{"name":"schema_id","in":"path","required":true,"schema":{"type":"string","example":"a821d59d-8b4c-4ad9-aeec-1292d2e28701"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["name","config"],"title":"create_update_schema"}}}},"responses":{"200":{"description":"Schema","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"649b1e49-2722-46a3-a7e7-10caae78a43f"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"name":{"type":"string","example":"my-schema"},"config":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"apolla_first_name","description":"Your application field name."},"mapped_name":{"type":"string","example":"FirstName","description":"The field your customer maps. This is a Provider-specified field name. E.g. FirstName for Salesforce."}},"required":["name"]}},"allow_additional_field_mappings":{"type":"boolean","description":"Specifies whether your customer can add new application field names.","example":false}},"required":["fields","allow_additional_field_mappings"],"title":"schema_config"}},"required":["id","application_id","name","config"],"title":"schema"}}}}},"description":"Update schema","method":"put","path":"/schemas/{schema_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"name":"my-schema","config":{"fields":[{"name":"apolla_first_name","mapped_name":"FirstName"}],"allow_additional_field_mappings":false}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update schema","description":{"type":"text/plain"},"url":{"path":["schemas",":schema_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"schema_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-sync-config.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-sync-config.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-sync-config.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-sync-config.api.mdx index 0a51388df..97e259022 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/update-sync-config.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/update-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Update Sync Config" sidebar_label: "Update Sync Config" hide_title: true hide_table_of_contents: true -api: {"operationId":"updateSyncConfig","tags":["SyncConfigs"],"parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["destination_id","provider_id","config"],"title":"create_update_sync_config"}}}},"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Update Sync Config","method":"put","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_id":"6e7baa88-84dd-4dbc-902a-14522c2984eb","provider_id":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af","config":{"default_config":{"period_ms":60000,"strategy":"full then incremental","auto_start_on_connection":true},"common_objects":[{"object":"contact"}],"standard_objects":[{"object":"Contact"}],"entities":[{"entity_id":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}]}},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"operationId":"updateSyncConfig","tags":["SyncConfigs"],"parameters":[{"name":"sync_config_id","in":"path","required":true,"schema":{"type":"string","example":"d583ec72-55d4-4f35-9668-f6c759674cc1"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["destination_id","provider_id","config"],"title":"create_update_sync_config"}}}},"responses":{"200":{"description":"SyncConfig","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","example":"465fdcb7-26b4-4090-894c-67cab41022bb"},"application_id":{"type":"string","example":"9572d08b-f19f-48cc-a992-1eb7031d3f6a"},"destination_id":{"type":"string","example":"6e7baa88-84dd-4dbc-902a-14522c2984eb"},"provider_id":{"type":"string","example":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af"},"config":{"type":"object","properties":{"default_config":{"type":"object","description":"Configuration options for \"how\" to sync.","properties":{"period_ms":{"type":"integer","minimum":60000,"example":60000,"description":"The period (in milliseconds) to run the sync."},"strategy":{"type":"string","enum":["full then incremental","full only"],"description":"\\\"full then incremental\\\" will run a full sync on the first run, then incremental syncs. \\\"full only\\\" will run a full sync on every run."},"auto_start_on_connection":{"type":"boolean","description":"If true, the sync will start automatically when the connection is created.\nDefault: true\n"}},"required":["period_ms","strategy"]},"common_objects":{"description":"A list of Supaglue objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name","example":"contact"}},"required":["object"]}},"standard_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"entities":{"type":"array","items":{"type":"object","properties":{"entity_id":{"type":"string","example":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}},"required":["entity_id"]}}},"required":["default_config"],"title":"sync_config_data"}},"required":["id","application_id","destination_id","provider_id","config"],"title":"sync_config"}}}}},"description":"Update Sync Config","method":"put","path":"/sync_configs/{sync_config_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_id":"6e7baa88-84dd-4dbc-902a-14522c2984eb","provider_id":"7f72ec07-e5c1-47fd-8cf5-e71dd13873af","config":{"default_config":{"period_ms":60000,"strategy":"full then incremental","auto_start_on_connection":true},"common_objects":[{"object":"contact"}],"standard_objects":[{"object":"Contact"}],"entities":[{"entity_id":"3a82409f-c98f-4d25-bbd8-3335de3f12cc"}]}},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Update Sync Config","description":{"type":"text/plain"},"url":{"path":["sync_configs",":sync_config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"sync_config_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/upsert-connection-sync-config.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/upsert-connection-sync-config.api.mdx similarity index 52% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/upsert-connection-sync-config.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/upsert-connection-sync-config.api.mdx index da688fd1e..f09bf7449 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/upsert-connection-sync-config.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/upsert-connection-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Upsert connection sync config" sidebar_label: "Upsert connection sync config" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertConnectionSyncConfig","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"oneOf":[{"description":"Config specific to postgres destination","type":"object","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. If not specified, the schema specified in the postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to bigquery destination","type":"object","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. If not specified, the dataset specified in the bigquery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"custom_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name (case sensitive)","example":"Contact__c"}},"required":["object"]}}},"title":"upsert_connection_sync_config"}}}},"responses":{"200":{"description":"Connection Sync Config","content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"oneOf":[{"description":"Config specific to postgres destination","type":"object","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. If not specified, the schema specified in the postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to bigquery destination","type":"object","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. If not specified, the dataset specified in the bigquery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"custom_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name (case sensitive)","example":"Contact__c"}},"required":["object"]}}},"title":"connection_sync_config"}}}}},"description":"Upsert connection sync config","method":"put","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_config":{"type":"postgres","schema":"customer_1_schema"},"standard_objects":[{"object":"Contact"}],"custom_objects":[{"object":"Contact__c"}]},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert connection sync config","description":{"type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"upsertConnectionSyncConfig","tags":["ConnectionSyncConfigs"],"security":[{"x-api-key":[]}],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"oneOf":[{"description":"Config specific to postgres destination","type":"object","title":"postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to bigquery destination","type":"object","title":"bigquery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the bigquery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"custom_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name (case sensitive)","example":"Contact__c"}},"required":["object"]}}},"title":"upsert_connection_sync_config"}}}},"responses":{"200":{"description":"Connection Sync Config","content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"oneOf":[{"description":"Config specific to postgres destination","type":"object","title":"postgres","properties":{"type":{"type":"string","enum":["postgres"]},"schema":{"type":"string","description":"The schema you'd like to sync to. This schema must already exist. Supaglue will not create it. If not specified, the schema specified in the postgres Destination will be used.","example":"customer_1_schema"}},"required":["type","schema"]},{"description":"Config specific to bigquery destination","type":"object","title":"bigquery","properties":{"type":{"type":"string","enum":["bigquery"]},"dataset":{"type":"string","description":"The dataset you'd like to sync to. This dataset must already exist. Supaglue will not create it. If not specified, the dataset specified in the bigquery Destination will be used.","example":"customer_1_dataset"}},"required":["type","dataset"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]}},"custom_objects":{"description":"A list of case-sensitive Provider objects to be synced.","type":"array","items":{"type":"object","properties":{"object":{"type":"string","description":"The Supaglue object name (case sensitive)","example":"Contact__c"}},"required":["object"]}}},"title":"connection_sync_config"}}}}},"description":"Upsert connection sync config","method":"put","path":"/connection_sync_configs","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"destination_config":{"type":"postgres","schema":"customer_1_schema"},"standard_objects":[{"object":"Contact"}],"custom_objects":[{"object":"Contact__c"}]},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert connection sync config","description":{"type":"text/plain"},"url":{"path":["connection_sync_configs"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null @@ -34,7 +34,7 @@ Upsert connection sync config ## Request -

      Header Parameters

      Body

      required
        destination_config object
        oneOf
        standard_objects object[]
        +

        Header Parameters

        Body

        required
          destination_config object
          oneOf
          standard_objects object[]
          A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig. @@ -46,7 +46,7 @@ A list of case-sensitive Provider objects to be synced. Connection Sync Config -
          Schema
            destination_config object
            oneOf
            standard_objects object[]
            +
            Schema
              destination_config object
              oneOf
              standard_objects object[]
              A list of case-sensitive Provider standard objects to be synced. If specified, this list will take override the standard_objects list in SyncConfig. diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/upsert-customer.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/upsert-customer.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/upsert-customer.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/upsert-customer.api.mdx index d41cfc620..8e381e981 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/upsert-customer.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/upsert-customer.api.mdx @@ -5,7 +5,7 @@ description: "Upsert customer" sidebar_label: "Upsert customer" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"}},"required":["name","email","customer_id"],"title":"create_update_customer"}}}},"responses":{"200":{"description":"Customer upserted","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"}}}}},"description":"Upsert customer","method":"put","path":"/customers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"customer_id":"your-customers-unique-application-id","name":"MyCompany Inc","email":"contact@mycompany.com"},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert customer","description":{"type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"upsertCustomer","tags":["Customers"],"security":[{"x-api-key":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"}},"required":["name","email","customer_id"],"title":"create_update_customer"}}}},"responses":{"200":{"description":"Customer upserted","content":{"application/json":{"schema":{"type":"object","properties":{"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"your-customers-unique-application-id"},"name":{"type":"string","example":"MyCompany Inc"},"email":{"type":"string","example":"contact@mycompany.com"},"connections":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"e888cedf-e9d0-42c5-9485-2d72984faef2"},"application_id":{"type":"string","example":"d8ceb3ff-8b7f-4fa7-b8de-849292f6ca69"},"customer_id":{"type":"string","example":"my-customer-1"},"provider_id":{"type":"string","example":"677fcfca-cf89-4387-a189-71c885be67bc"},"provider_name":{"type":"string","enum":["hubspot","salesforce","pipedrive","zendesk_sell","ms_dynamics_365_sales","zoho_crm","capsule","outreach","gong","apollo","salesloft","intercom","linear","clearbit","6sense","marketo","salesforce_marketing_cloud_account_engagement"],"example":"hubspot","title":"provider_name"},"category":{"type":"string","enum":["crm","engagement","enrichment","marketing_automation","no_category"],"example":"crm","title":"category"},"instance_url":{"type":"string","example":"https://app.hubspot.com/contacts/123456","description":"Instance URL for the connected customer."},"schema_mappings_config":{"description":"This is for field mappings when you data model using [Objects](https://docs.supaglue.com/platform/objects/overview#schemas). The field mappings here are set by your customers using the [Field Mappings API](https://docs.supaglue.com/api/v2/mgmt/update-object-field-mappings).","type":"object","properties":{"common_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact__c"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"required":["object","field_mappings"]}},"standard_objects":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","example":"Contact"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"schema_field":{"type":"string","example":"apolla_first_name"},"mapped_field":{"type":"string","example":"FirstName"}},"required":["schema_field"],"title":"object_field_mapping"}}},"example":null,"required":["object","field_mappings"]}}}},"entity_mappings":{"type":"array","description":"This is for object/field mappings when you data model using [Entities](https://docs.supaglue.com/platform/entities/overview#entity-mapping). The object/field mappings here are set by your customers using the [Entity Mappings API](https://docs.supaglue.com/api/v2/mgmt/upsert-entity-mapping).","items":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"},"example":[]}},"required":["id","application_id","customer_id","provider_id","provider_name","category","instance_url"],"title":"connection"}}},"required":["application_id","name","email","customer_id"],"title":"customer"}}}}},"description":"Upsert customer","method":"put","path":"/customers","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"customer_id":"your-customers-unique-application-id","name":"MyCompany Inc","email":"contact@mycompany.com"},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert customer","description":{"type":"text/plain"},"url":{"path":["customers"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/upsert-entity-mapping.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/upsert-entity-mapping.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/mgmt/upsert-entity-mapping.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/mgmt/upsert-entity-mapping.api.mdx index 904373ee0..fa2dcb1ba 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/mgmt/upsert-entity-mapping.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/mgmt/upsert-entity-mapping.api.mdx @@ -5,7 +5,7 @@ description: "Upsert entity mapping" sidebar_label: "Upsert entity mapping" hide_title: true hide_table_of_contents: true -api: {"deprecated":true,"operationId":"upsertEntityMapping","tags":["EntityMappings"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"}}}},"responses":{"200":{"description":"Entity Mapping"}},"description":"Upsert entity mapping","method":"put","path":"/entity_mappings/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string","object":{"type":"standard","name":"string"},"field_mappings":[{"entity_field":"apolla_first_name","mapped_field":"FirstName"}]},"info":{"version":"0.14.10","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert entity mapping","description":{"type":"text/plain"},"url":{"path":["entity_mappings",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} +api: {"deprecated":true,"operationId":"upsertEntityMapping","tags":["EntityMappings"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"entity_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"entity_id":{"type":"string"},"object":{"type":"object","properties":{"type":{"type":"string","enum":["standard","custom"]},"name":{"type":"string"}},"required":["type","name"],"title":"standard_or_custom_object"},"field_mappings":{"type":"array","items":{"type":"object","properties":{"entity_field":{"type":"string","description":"The name of the field in your application.","example":"apolla_first_name"},"mapped_field":{"type":"string","description":"The name of the field in your customer's third-party Provider tool (e.g. Salesforce).","example":"FirstName"}},"required":["entity_field","mapped_field"],"title":"entity_field_mapping"}}},"required":["entity_id"],"title":"connection_entity_mapping"}}}},"responses":{"200":{"description":"Entity Mapping"}},"description":"Upsert entity mapping","method":"put","path":"/entity_mappings/{entity_id}","servers":[{"url":"https://api.supaglue.io/mgmt/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"entity_id":"string","object":{"type":"standard","name":"string"},"field_mappings":[{"entity_field":"apolla_first_name","mapped_field":"FirstName"}]},"info":{"version":"0.14.12","title":"Management API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Management API documentation. You can use this API to manage customer integrations and connections.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n\n```\nhttps://api.supaglue.io/mgmt/v2\n```\n"},"postman":{"name":"Upsert entity mapping","description":{"type":"text/plain"},"url":{"path":["entity_mappings",":entity_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"entity_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}}}} sidebar_class_name: "put api-method" info_path: api/v2/mgmt/management-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/accounts.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/accounts.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/accounts.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/accounts.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/attachments.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/attachments.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/attachments.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/attachments.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/collections.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/collections.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/collections.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/collections.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/comments.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/comments.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/comments.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/comments.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/contacts.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/contacts.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/contacts.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/contacts.tag.mdx diff --git a/docs/versioned_docs/version-0.14.12/api/v2/ticketing/create-attachment.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/create-attachment.api.mdx new file mode 100644 index 000000000..960fb2a11 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/create-attachment.api.mdx @@ -0,0 +1,42 @@ +--- +id: create-attachment +title: "Create attachment" +description: "Creates a Attachment object with the given values." +sidebar_label: "Create attachment" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createAttachment","description":"Creates a Attachment object with the given values.","tags":["Attachments"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}},"required":["record"]}}}},"responses":{"201":{"description":"Attachment created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"post","path":"/attachments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"file_name":"Screenshot.png","ticket":"0958cbc6-6040-430a-848e-aafacbadf4ae","file_url":"http://alturl.com/p749b","content_type":"jpeg","uploaded_by":"28b54125-287f-494d-965e-3c5b330c9a68"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create attachment","description":{"content":"Creates a Attachment object with the given values.","type":"text/plain"},"url":{"path":["attachments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/ticketing/unified-ticketing-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

              Create attachment

              + + + + + + + +Creates a Attachment object with the given values. + +## Request + +

              Header Parameters

              Body

              required
                record objectrequired
              + +Attachment created + +
              Schema
                errors object[]
              • Array [
              • ]
                • record object
                warnings object[]
              • Array [
              • ]
              + diff --git a/docs/versioned_docs/version-0.14.12/api/v2/ticketing/create-comment.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/create-comment.api.mdx new file mode 100644 index 000000000..04847cec2 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/create-comment.api.mdx @@ -0,0 +1,42 @@ +--- +id: create-comment +title: "Create comment" +description: "Creates a Comment object with the given values." +sidebar_label: "Create comment" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createComment","description":"Creates a Comment object with the given values.","tags":["Comments"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"user":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"},"contact":{"type":"string","example":"dde3fb16-b8eb-483d-81c4-b78100816f15"},"body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"html_body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"ticket":{"type":"string","nullable":true,"example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"},"is_private":{"type":"boolean","example":true}},"required":["user","body","ticket","is_private"]}},"required":["record"]}}}},"responses":{"201":{"description":"Comment created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"post","path":"/comments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"user":"17a54124-287f-494d-965e-3c5b330c9a68","contact":"dde3fb16-b8eb-483d-81c4-b78100816f15","body":"When will these integrations be done? You all should use Supaglue.","html_body":"When will these integrations be done? You all should use Supaglue.","ticket":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d","is_private":true}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create comment","description":{"content":"Creates a Comment object with the given values.","type":"text/plain"},"url":{"path":["comments"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/ticketing/unified-ticketing-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

              Create comment

              + + + + + + + +Creates a Comment object with the given values. + +## Request + +

              Header Parameters

              Body

              required
                record objectrequired
                Supaglue."}}>
              + +Comment created + +
              Schema
                errors object[]
              • Array [
              • ]
                • record object
                warnings object[]
              • Array [
              • ]
              + diff --git a/docs/versioned_docs/version-0.14.12/api/v2/ticketing/create-ticket.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/create-ticket.api.mdx new file mode 100644 index 000000000..34a7c8ac7 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/create-ticket.api.mdx @@ -0,0 +1,42 @@ +--- +id: create-ticket +title: "Create ticket" +description: "Creates a Ticket object with the given values." +sidebar_label: "Create ticket" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"createTicket","description":"Creates a Ticket object with the given values.","tags":["Tickets"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"create_ticket"}},"required":["record"]}}}},"responses":{"201":{"description":"Ticket created","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"record":{"type":"object","properties":{"id":{"type":"string"}},"required":["id"]},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"post","path":"/tickets","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"Please add more integrations","assignees":["17a54124-287f-494d-965e-3c5b330c9a68"],"creator":"3fa85f64-5717-4562-b3fc-2c963f66afa6","due_date":"2022-10-11T00:00:00Z","status":"OPEN","description":"Can you please add more integrations? It'll make syncing data much easier!","collections":["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],"ticket_type":"incident","account":"0958cbc6-6040-430a-848e-aafacbadf4ae","contact":"65c345ba-6870-4974-87ba-dd31509c367a","parent_ticket":"75b33d04-30d2-4f3e-be45-27838bc94342","tags":["enterprise"],"completed_at":"2021-12-09T00:00:00Z","ticket_url":"https://thirdpartysoftware.com/project/3/issue/1","priority":"HIGH"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Create ticket","description":{"content":"Creates a Ticket object with the given values.","type":"text/plain"},"url":{"path":["tickets"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "post api-method" +info_path: api/v2/ticketing/unified-ticketing-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

              Create ticket

              + + + + + + + +Creates a Ticket object with the given values. + +## Request + +

              Header Parameters

              Body

              required
                record objectrequired
              + +Ticket created + +
              Schema
                errors object[]
              • Array [
              • ]
                • record object
                warnings object[]
              • Array [
              • ]
              + diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-account.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-account.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-account.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-account.api.mdx index 62f9d6dfa..bf90920c6 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-account.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-account.api.mdx @@ -5,7 +5,7 @@ description: "Returns an Account object with the given id." sidebar_label: "Get account" hide_title: true hide_table_of_contents: true -api: {"operationId":"getAccount","description":"Returns an Account object with the given id.","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"AccountData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Waystar Royco"},"domains":{"type":"array","items":{"type":"string","example":"waystar-royco.com"}}},"required":["name","domains"],"title":"account"}}}}},"method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get account","description":{"content":"Returns an Account object with the given id.","type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getAccount","description":"Returns an Account object with the given id.","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"account_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"AccountData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Waystar Royco"},"domains":{"type":"array","items":{"type":"string","example":"waystar-royco.com"}}},"required":["name","domains"],"title":"account"}}}}},"method":"get","path":"/accounts/{account_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get account","description":{"content":"Returns an Account object with the given id.","type":"text/plain"},"url":{"path":["accounts",":account_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"account_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-attachment.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-attachment.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-attachment.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-attachment.api.mdx index 3b5f2ec48..341dbe1c3 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-attachment.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-attachment.api.mdx @@ -5,7 +5,7 @@ description: "Returns an Attachment object with the given id." sidebar_label: "Get attachment" hide_title: true hide_table_of_contents: true -api: {"operationId":"getAttachment","description":"Returns an Attachment object with the given id.","tags":["Attachments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"attachment_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"attachmentData","content":{"application/json":{"schema":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}}}}},"method":"get","path":"/attachments/{attachment_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get attachment","description":{"content":"Returns an Attachment object with the given id.","type":"text/plain"},"url":{"path":["attachments",":attachment_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"attachment_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getAttachment","description":"Returns an Attachment object with the given id.","tags":["Attachments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"attachment_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"attachmentData","content":{"application/json":{"schema":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}}}}},"method":"get","path":"/attachments/{attachment_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get attachment","description":{"content":"Returns an Attachment object with the given id.","type":"text/plain"},"url":{"path":["attachments",":attachment_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"attachment_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-collection.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-collection.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-collection.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-collection.api.mdx index 639853e0f..e01d2d04e 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-collection.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-collection.api.mdx @@ -5,7 +5,7 @@ description: "Returns a Collection object with the given id." sidebar_label: "Get collection" hide_title: true hide_table_of_contents: true -api: {"operationId":"getCollection","description":"Returns a Collection object with the given id.","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"CollectionData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Q1 Platform"},"description":{"type":"string","nullable":true,"example":"For tracking all tasks related to Platform for Q1"},"collection_type":{"type":"string","nullable":true,"example":"LIST"},"parent_collection":{"type":"string","nullable":true,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"},"access_level":{"type":"string","nullable":true,"example":"PUBLIC"}},"required":["name"],"title":"collection"}}}}},"method":"get","path":"/collections/{collection_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get collection","description":{"content":"Returns a Collection object with the given id.","type":"text/plain"},"url":{"path":["collections",":collection_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"collection_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getCollection","description":"Returns a Collection object with the given id.","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"collection_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"CollectionData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Q1 Platform"},"description":{"type":"string","nullable":true,"example":"For tracking all tasks related to Platform for Q1"},"collection_type":{"type":"string","nullable":true,"example":"LIST"},"parent_collection":{"type":"string","nullable":true,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"},"access_level":{"type":"string","nullable":true,"example":"PUBLIC"}},"required":["name"],"title":"collection"}}}}},"method":"get","path":"/collections/{collection_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get collection","description":{"content":"Returns a Collection object with the given id.","type":"text/plain"},"url":{"path":["collections",":collection_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"collection_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-contact.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-contact.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-contact.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-contact.api.mdx index 35c90867d..f4ab3d739 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-contact.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-contact.api.mdx @@ -5,7 +5,7 @@ description: "Returns a Contact object with the given id." sidebar_label: "Get contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"getContact","description":"Returns a Contact object with the given id.","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"ContactData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Cousin Greg"},"email_address":{"type":"string","example":"greg@waystar-royco.com"},"phone_number":{"type":"string","nullable":true,"example":"5108890293"},"details":{"type":"string","nullable":true,"example":"Executive Assistant to Tom Wambsgans"},"account":{"type":"string","nullable":true,"example":"8998e1ed-1c76-4b64-9097-9d37ee88bf6f"}},"required":["name","email_address"],"title":"contact"}}}}},"method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get contact","description":{"content":"Returns a Contact object with the given id.","type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getContact","description":"Returns a Contact object with the given id.","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"contact_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"ContactData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Cousin Greg"},"email_address":{"type":"string","example":"greg@waystar-royco.com"},"phone_number":{"type":"string","nullable":true,"example":"5108890293"},"details":{"type":"string","nullable":true,"example":"Executive Assistant to Tom Wambsgans"},"account":{"type":"string","nullable":true,"example":"8998e1ed-1c76-4b64-9097-9d37ee88bf6f"}},"required":["name","email_address"],"title":"contact"}}}}},"method":"get","path":"/contacts/{contact_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get contact","description":{"content":"Returns a Contact object with the given id.","type":"text/plain"},"url":{"path":["contacts",":contact_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"contact_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-tag.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-tag.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-tag.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-tag.api.mdx index 32544896d..0de63152b 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-tag.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-tag.api.mdx @@ -5,7 +5,7 @@ description: "Returns a Tag object with the given id." sidebar_label: "Get tag" hide_title: true hide_table_of_contents: true -api: {"operationId":"getTag","description":"Returns a Tag object with the given id.","tags":["Tags"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"tag_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TagData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Ticketing API"}},"required":["name"],"title":"tag"}}}}},"method":"get","path":"/tags/{tag_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get tag","description":{"content":"Returns a Tag object with the given id.","type":"text/plain"},"url":{"path":["tags",":tag_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"tag_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getTag","description":"Returns a Tag object with the given id.","tags":["Tags"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"tag_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TagData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","example":"Ticketing API"}},"required":["name"],"title":"tag"}}}}},"method":"get","path":"/tags/{tag_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get tag","description":{"content":"Returns a Tag object with the given id.","type":"text/plain"},"url":{"path":["tags",":tag_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"tag_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-team.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-team.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-team.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-team.api.mdx index 13f8a234a..d99e22d19 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-team.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-team.api.mdx @@ -5,7 +5,7 @@ description: "Returns an Team object with the given id." sidebar_label: "Get team" hide_title: true hide_table_of_contents: true -api: {"operationId":"getTeam","description":"Returns an Team object with the given id.","tags":["Teams"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"team_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TeamData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Platform"},"decription":{"type":"string","nullable":true,"example":"Platform and Integrations Team"}},"required":["name"]}}}}},"method":"get","path":"/teams/{team_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get team","description":{"content":"Returns an Team object with the given id.","type":"text/plain"},"url":{"path":["teams",":team_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"team_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getTeam","description":"Returns an Team object with the given id.","tags":["Teams"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"team_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TeamData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Platform"},"decription":{"type":"string","nullable":true,"example":"Platform and Integrations Team"}},"required":["name"]}}}}},"method":"get","path":"/teams/{team_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get team","description":{"content":"Returns an Team object with the given id.","type":"text/plain"},"url":{"path":["teams",":team_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"team_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-ticket.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-ticket.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-ticket.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-ticket.api.mdx index cef60830a..b0874e06c 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-ticket.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-ticket.api.mdx @@ -5,7 +5,7 @@ description: "Returns an Ticket object with the given id." sidebar_label: "Get ticket" hide_title: true hide_table_of_contents: true -api: {"operationId":"getTicket","description":"Returns an Ticket object with the given id.","tags":["Tickets"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"ticket_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TicketData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"ticket"}}}}},"method":"get","path":"/tickets/{ticket_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get ticket","description":{"content":"Returns an Ticket object with the given id.","type":"text/plain"},"url":{"path":["tickets",":ticket_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"ticket_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getTicket","description":"Returns an Ticket object with the given id.","tags":["Tickets"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"ticket_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"TicketData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"ticket"}}}}},"method":"get","path":"/tickets/{ticket_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get ticket","description":{"content":"Returns an Ticket object with the given id.","type":"text/plain"},"url":{"path":["tickets",":ticket_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"ticket_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-user.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-user.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-user.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-user.api.mdx index 9a3013fe7..3de3ee7ad 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/get-user.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/get-user.api.mdx @@ -5,7 +5,7 @@ description: "Returns a User object with the given id." sidebar_label: "Get user" hide_title: true hide_table_of_contents: true -api: {"operationId":"getUser","description":"Returns a User object with the given id.","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"UserData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}}}},"method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get user","description":{"content":"Returns a User object with the given id.","type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"getUser","description":"Returns a User object with the given id.","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"include_raw_data","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to include raw data fetched from the 3rd party provider."},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"UserData","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}}}},"method":"get","path":"/users/{user_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Get user","description":{"content":"Returns a User object with the given id.","type":"text/plain"},"url":{"path":["users",":user_id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Whether to include raw data fetched from the 3rd party provider.","type":"text/plain"},"key":"include_raw_data","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"user_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-accounts.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-accounts.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-accounts.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-accounts.api.mdx index a425a7ddf..8932af71d 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-accounts.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-accounts.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Account objects." sidebar_label: "List accounts" hide_title: true hide_table_of_contents: true -api: {"operationId":"listAccounts","description":"Returns a list of Account objects.","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"AccountsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Waystar Royco"},"domains":{"type":"array","items":{"type":"string","example":"waystar-royco.com"}}},"required":["name","domains"],"title":"account"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/accounts","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List accounts","description":{"content":"Returns a list of Account objects.","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listAccounts","description":"Returns a list of Account objects.","tags":["Accounts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"AccountsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Waystar Royco"},"domains":{"type":"array","items":{"type":"string","example":"waystar-royco.com"}}},"required":["name","domains"],"title":"account"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/accounts","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List accounts","description":{"content":"Returns a list of Account objects.","type":"text/plain"},"url":{"path":["accounts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-attachments.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-attachments.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-attachments.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-attachments.api.mdx index ab15ea019..f55ec14ec 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-attachments.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-attachments.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Attachment objects." sidebar_label: "List attachments" hide_title: true hide_table_of_contents: true -api: {"operationId":"listAttachments","description":"Returns a list of Attachment objects.","tags":["Attachments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"AttachmentsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}}},"required":["pagination","records"]}}}}},"method":"get","path":"/attachments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List attachments","description":{"content":"Returns a list of Attachment objects.","type":"text/plain"},"url":{"path":["attachments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listAttachments","description":"Returns a list of Attachment objects.","tags":["Attachments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"AttachmentsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"file_name":{"type":"string","example":"Screenshot.png"},"ticket":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"file_url":{"type":"string","example":"http://alturl.com/p749b"},"content_type":{"type":"string","example":"jpeg"},"uploaded_by":{"type":"string","example":"28b54125-287f-494d-965e-3c5b330c9a68"}},"required":["file_name","ticket","file_url","content_type","uploaded_by"]}}},"required":["pagination","records"]}}}}},"method":"get","path":"/attachments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List attachments","description":{"content":"Returns a list of Attachment objects.","type":"text/plain"},"url":{"path":["attachments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-collection-users.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-collection-users.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-collection-users.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-collection-users.api.mdx index ff401a3a1..29d479cbb 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-collection-users.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-collection-users.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of User objects." sidebar_label: "List collection users" hide_title: true hide_table_of_contents: true -api: {"operationId":"listCollectionUsers","description":"Returns a list of User objects.","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"parent_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"CollectionUsersData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/collections/{parent_id}/users","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List collection users","description":{"content":"Returns a list of User objects.","type":"text/plain"},"url":{"path":["collections",":parent_id","users"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"parent_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listCollectionUsers","description":"Returns a list of User objects.","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"parent_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"responses":{"200":{"description":"CollectionUsersData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/collections/{parent_id}/users","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List collection users","description":{"content":"Returns a list of User objects.","type":"text/plain"},"url":{"path":["collections",":parent_id","users"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"parent_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-collections.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-collections.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-collections.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-collections.api.mdx index b5bd029e5..7e06bf7d9 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-collections.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-collections.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Collection objects." sidebar_label: "List collections" hide_title: true hide_table_of_contents: true -api: {"operationId":"listCollections","description":"Returns a list of Collection objects.","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"CollectionsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Q1 Platform"},"description":{"type":"string","nullable":true,"example":"For tracking all tasks related to Platform for Q1"},"collection_type":{"type":"string","nullable":true,"example":"LIST"},"parent_collection":{"type":"string","nullable":true,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"},"access_level":{"type":"string","nullable":true,"example":"PUBLIC"}},"required":["name"],"title":"collection"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/collections","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List collections","description":{"content":"Returns a list of Collection objects.","type":"text/plain"},"url":{"path":["collections"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listCollections","description":"Returns a list of Collection objects.","tags":["Collections"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"CollectionsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Q1 Platform"},"description":{"type":"string","nullable":true,"example":"For tracking all tasks related to Platform for Q1"},"collection_type":{"type":"string","nullable":true,"example":"LIST"},"parent_collection":{"type":"string","nullable":true,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"},"access_level":{"type":"string","nullable":true,"example":"PUBLIC"}},"required":["name"],"title":"collection"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/collections","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List collections","description":{"content":"Returns a list of Collection objects.","type":"text/plain"},"url":{"path":["collections"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-comments.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-comments.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-comments.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-comments.api.mdx index e9451b6d1..8f26dd423 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-comments.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-comments.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Comment objects." sidebar_label: "List comments" hide_title: true hide_table_of_contents: true -api: {"operationId":"listComments","description":"Returns a list of Comment objects.","tags":["Comments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"CommentsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"user":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"},"contact":{"type":"string","example":"dde3fb16-b8eb-483d-81c4-b78100816f15"},"body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"html_body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"ticket":{"type":"string","nullable":true,"example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"},"is_private":{"type":"boolean","example":true}},"required":["user","body","ticket","is_private"],"title":"comment"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/comments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List comments","description":{"content":"Returns a list of Comment objects.","type":"text/plain"},"url":{"path":["comments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listComments","description":"Returns a list of Comment objects.","tags":["Comments"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"CommentsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"user":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"},"contact":{"type":"string","example":"dde3fb16-b8eb-483d-81c4-b78100816f15"},"body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"html_body":{"type":"string","nullable":true,"example":"When will these integrations be done? You all should use Supaglue."},"ticket":{"type":"string","nullable":true,"example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"},"is_private":{"type":"boolean","example":true}},"required":["user","body","ticket","is_private"],"title":"comment"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/comments","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List comments","description":{"content":"Returns a list of Comment objects.","type":"text/plain"},"url":{"path":["comments"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-contacts.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-contacts.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-contacts.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-contacts.api.mdx index eed9e7bb7..8d11391f4 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-contacts.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-contacts.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Contact objects." sidebar_label: "List contacts" hide_title: true hide_table_of_contents: true -api: {"operationId":"listContacts","description":"Returns a list of Contact objects.","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"ContactsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Cousin Greg"},"email_address":{"type":"string","example":"greg@waystar-royco.com"},"phone_number":{"type":"string","nullable":true,"example":"5108890293"},"details":{"type":"string","nullable":true,"example":"Executive Assistant to Tom Wambsgans"},"account":{"type":"string","nullable":true,"example":"8998e1ed-1c76-4b64-9097-9d37ee88bf6f"}},"required":["name","email_address"],"title":"contact"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/contacts","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List contacts","description":{"content":"Returns a list of Contact objects.","type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listContacts","description":"Returns a list of Contact objects.","tags":["Contacts"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"ContactsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Cousin Greg"},"email_address":{"type":"string","example":"greg@waystar-royco.com"},"phone_number":{"type":"string","nullable":true,"example":"5108890293"},"details":{"type":"string","nullable":true,"example":"Executive Assistant to Tom Wambsgans"},"account":{"type":"string","nullable":true,"example":"8998e1ed-1c76-4b64-9097-9d37ee88bf6f"}},"required":["name","email_address"],"title":"contact"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/contacts","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List contacts","description":{"content":"Returns a list of Contact objects.","type":"text/plain"},"url":{"path":["contacts"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-tags.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-tags.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-tags.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-tags.api.mdx index 17e3d866d..75056ee8f 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-tags.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-tags.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Tag objects." sidebar_label: "List tags" hide_title: true hide_table_of_contents: true -api: {"operationId":"listTags","description":"Returns a list of Tag objects.","tags":["Tags"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TagsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Ticketing API"}},"required":["name"],"title":"tag"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/tags","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List tags","description":{"content":"Returns a list of Tag objects.","type":"text/plain"},"url":{"path":["tags"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listTags","description":"Returns a list of Tag objects.","tags":["Tags"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TagsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Ticketing API"}},"required":["name"],"title":"tag"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/tags","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List tags","description":{"content":"Returns a list of Tag objects.","type":"text/plain"},"url":{"path":["tags"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-teams.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-teams.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-teams.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-teams.api.mdx index 1270eeb48..684fb2b31 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-teams.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-teams.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Team objects." sidebar_label: "List teams" hide_title: true hide_table_of_contents: true -api: {"operationId":"listTeams","description":"Returns a list of Team objects.","tags":["Teams"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TeamsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Platform"},"decription":{"type":"string","nullable":true,"example":"Platform and Integrations Team"}},"required":["name"]}}},"required":["pagination","records"]}}}}},"method":"get","path":"/teams","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List teams","description":{"content":"Returns a list of Team objects.","type":"text/plain"},"url":{"path":["teams"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listTeams","description":"Returns a list of Team objects.","tags":["Teams"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TeamsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Platform"},"decription":{"type":"string","nullable":true,"example":"Platform and Integrations Team"}},"required":["name"]}}},"required":["pagination","records"]}}}}},"method":"get","path":"/teams","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List teams","description":{"content":"Returns a list of Team objects.","type":"text/plain"},"url":{"path":["teams"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-tickets.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-tickets.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-tickets.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-tickets.api.mdx index 8f1f69376..2d022e9e4 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-tickets.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-tickets.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of Ticket objects." sidebar_label: "List tickets" hide_title: true hide_table_of_contents: true -api: {"operationId":"listTickets","description":"Returns a list of Ticket objects.","tags":["Tickets"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TicketsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"ticket"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/tickets","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List tickets","description":{"content":"Returns a list of Ticket objects.","type":"text/plain"},"url":{"path":["tickets"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listTickets","description":"Returns a list of Ticket objects.","tags":["Tickets"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"TicketsData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"ticket"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/tickets","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List tickets","description":{"content":"Returns a list of Ticket objects.","type":"text/plain"},"url":{"path":["tickets"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-users.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-users.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-users.api.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-users.api.mdx index 140162445..4422bb211 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/list-users.api.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/list-users.api.mdx @@ -5,7 +5,7 @@ description: "Returns a list of User objects." sidebar_label: "List users" hide_title: true hide_table_of_contents: true -api: {"operationId":"listUsers","description":"Returns a list of User objects.","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"UsersData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/users","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.10","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List users","description":{"content":"Returns a list of User objects.","type":"text/plain"},"url":{"path":["users"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +api: {"operationId":"listUsers","description":"Returns a list of User objects.","tags":["Users"],"security":[{"x-api-key":[]}],"parameters":[{"name":"modified_after","in":"query","schema":{"type":"string","format":"date-time","example":"2023-02-23T00:00:00.000Z"},"description":"If provided, will only return objects modified after this datetime"},{"name":"page_size","in":"query","schema":{"type":"string","example":"123"},"description":"Number of results to return per page. (Max: 1000)"},{"name":"cursor","in":"query","schema":{"type":"string","example":"cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw"},"description":"The pagination cursor value"},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true}],"responses":{"200":{"description":"UsersData","content":{"application/json":{"schema":{"type":"object","properties":{"pagination":{"type":"object","properties":{"next":{"type":"string","nullable":true,"example":"eyJpZCI6IjQyNTc5ZjczLTg1MjQtNDU3MC05YjY3LWVjYmQ3MDJjNmIxNCIsInJldmVyc2UiOmZhbHNlfQ=="},"previous":{"type":"string","nullable":true,"example":"eyJpZCI6IjBjZDhmYmZkLWU5NmQtNDEwZC05ZjQxLWIwMjU1YjdmNGI4NyIsInJldmVyc2UiOnRydWV9"},"total_count":{"type":"number","example":100}},"required":["next","previous","total_count"]},"records":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Hil Feig"},"email_address":{"type":"string","example":"help@supaglue.com"},"is_active":{"type":"boolean","example":false},"teams":{"type":"array","items":{"type":"string","nullable":false,"example":"681b0fd7-40e6-4b91-8e23-2814872090be"}},"avatar":{"type":"string","nullable":true,"example":"https://supaglue.io/user_profile_pic.png"}},"required":["name","email_address","is_active"],"title":"user"}}},"required":["pagination","records"]}}}}},"method":"get","path":"/users","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"List users","description":{"content":"Returns a list of User objects.","type":"text/plain"},"url":{"path":["users"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If provided, will only return objects modified after this datetime","type":"text/plain"},"key":"modified_after","value":""},{"disabled":false,"description":{"content":"Number of results to return per page. (Max: 1000)","type":"text/plain"},"key":"page_size","value":""},{"disabled":false,"description":{"content":"The pagination cursor value","type":"text/plain"},"key":"cursor","value":""}],"variable":[]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} sidebar_class_name: "get api-method" info_path: api/v2/ticketing/unified-ticketing-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/sidebar.js b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/sidebar.js rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/sidebar.js diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/tags.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/tags.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/tags.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/tags.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/teams.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/teams.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/teams.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/teams.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/tickets.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/tickets.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/tickets.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/tickets.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/unified-ticketing-api.info.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/unified-ticketing-api.info.mdx similarity index 98% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/unified-ticketing-api.info.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/unified-ticketing-api.info.mdx index 74332a9b9..697637942 100644 --- a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/unified-ticketing-api.info.mdx +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/unified-ticketing-api.info.mdx @@ -13,7 +13,7 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 0.14.10 +Version: 0.14.12 diff --git a/docs/versioned_docs/version-0.14.12/api/v2/ticketing/update-ticket.api.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/update-ticket.api.mdx new file mode 100644 index 000000000..7bb2d0247 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/update-ticket.api.mdx @@ -0,0 +1,42 @@ +--- +id: update-ticket +title: "Update ticket" +description: "Updates a Ticket object with the given values." +sidebar_label: "Update ticket" +hide_title: true +hide_table_of_contents: true +api: {"operationId":"updateTicket","description":"Updates a Ticket object with the given values.","tags":["Tickets"],"parameters":[{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"description":"The customer ID that uniquely identifies the customer in your application","required":true},{"name":"x-provider-name","in":"header","schema":{"type":"string","example":"salesforce"},"description":"The provider name","required":true},{"name":"ticket_id","in":"path","required":true,"schema":{"type":"string","example":"0258cbc6-6020-430a-848e-aafacbadf4ae"}}],"security":[{"x-api-key":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"record":{"type":"object","properties":{"name":{"type":"string","nullable":true,"example":"Please add more integrations"},"assignees":{"type":"array","items":{"type":"string","example":"17a54124-287f-494d-965e-3c5b330c9a68"}},"creator":{"type":"string","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"due_date":{"type":"string","example":"2022-10-11T00:00:00Z"},"status":{"type":"string","example":"OPEN"},"description":{"type":"string","example":"Can you please add more integrations? It'll make syncing data much easier!"},"collections":{"type":"array","items":{"type":"string","example":"fb8c55b6-1cb8-4b4c-9fb6-17924231619d"}},"ticket_type":{"type":"string","example":"incident"},"account":{"type":"string","example":"0958cbc6-6040-430a-848e-aafacbadf4ae"},"contact":{"type":"string","example":"65c345ba-6870-4974-87ba-dd31509c367a"},"parent_ticket":{"type":"string","example":"75b33d04-30d2-4f3e-be45-27838bc94342"},"tags":{"type":"array","items":{"type":"string","example":"enterprise"}},"completed_at":{"type":"string","example":"2021-12-09T00:00:00Z"},"ticket_url":{"type":"string","example":"https://thirdpartysoftware.com/project/3/issue/1"},"priority":{"type":"string","example":"HIGH"}},"required":["name","creator"],"title":"update_ticket"}},"required":["record"]}}}},"responses":{"200":{"description":"Ticket updated","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string","description":"The full error message from the remote Provider. The schema and level of detail will vary by Provider.","example":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n"},"problem_type":{"type":"string","description":"The Supaglue error code associated with the error.","example":"MISSING_REQUIRED_FIELD"},"title":{"type":"string","description":"A brief description of the error. The schema and type of message will vary by Provider.","example":"Property values were not valid\n"}},"example":[{"detail":"{\"code\":400,\"body\":{\"status\":\"error\",\"message\":\"Property values were not valid: [{\\\\\"isValid\\\\\":false,\\\\\"message\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\",\\\\\"error\\\\\":\\\\\"PROPERTY_DOESNT_EXIST\\\\\",\\\\\"name\\\\\":\\\\\"__about_us\\\\\",\\\\\"localizedErrorMessage\\\\\":\\\\\"Property \\\\\\\\\\\\\"__about_us\\\\\\\\\\\\\" does not exist\\\\\"}]\",\"correlationId\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"category\":\"VALIDATION_ERROR\"},\"headers\":{\"access-control-allow-credentials\":\"false\",\"cf-cache-status\":\"DYNAMIC\",\"cf-ray\":\"8053d17b9dae9664-SJC\",\"connection\":\"close\",\"content-length\":\"361\",\"content-type\":\"application/json;charset=utf-8\",\"date\":\"Mon, 11 Sep 2023 23:51:22 GMT\",\"nel\":\"{\\\\\"success_fraction\\\\\":0.01,\\\\\"report_to\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"report-to\":\"{\\\\\"endpoints\\\\\":[{\\\\\"url\\\\\":\\\\\"https://a.nel.cloudflare.com/report/v3?s=FgwuXObO%2Fz6ahUJKsxjDLaXTWjooJ8tB0w4%2B%2BKaulGStx0FGkn1PoJoOx2KrFMfihzNdfAqikq7CmgbdlmwKB8hkmp3eTb68qpg10LXFlRgiSqRhbWM7yYSfo8CXmPBc\\\\\"}],\\\\\"group\\\\\":\\\\\"cf-nel\\\\\",\\\\\"max_age\\\\\":604800}\",\"server\":\"cloudflare\",\"strict-transport-security\":\"max-age=31536000; includeSubDomains; preload\",\"vary\":\"origin, Accept-Encoding\",\"x-content-type-options\":\"nosniff\",\"x-envoy-upstream-service-time\":\"91\",\"x-evy-trace-listener\":\"listener_https\",\"x-evy-trace-route-configuration\":\"listener_https/all\",\"x-evy-trace-route-service-name\":\"envoyset-translator\",\"x-evy-trace-served-by-pod\":\"iad02/hubapi-td/envoy-proxy-6c94986c56-9xsh2\",\"x-evy-trace-virtual-host\":\"all\",\"x-hubspot-correlation-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-hubspot-ratelimit-interval-milliseconds\":\"10000\",\"x-hubspot-ratelimit-max\":\"100\",\"x-hubspot-ratelimit-remaining\":\"99\",\"x-hubspot-ratelimit-secondly\":\"10\",\"x-hubspot-ratelimit-secondly-remaining\":\"9\",\"x-request-id\":\"ac94252c-90b5-45d2-ad1d-9a9f7651d7d2\",\"x-trace\":\"2B1B4386362759B6A4C34802AD168B803DDC1BE770000000000000000000\"}}\n","problem_type":"BAD_REQUEST_ERROR","title":"Property values were not valid\n"}]}},"warnings":{"type":"array","items":{"type":"object","properties":{"detail":{"type":"string"},"problem_type":{"type":"string"},"title":{"type":"string"}}}}}}}}}},"method":"patch","path":"/tickets/{ticket_id}","servers":[{"url":"https://api.supaglue.io/ticketing/v2","description":"Supaglue API"}],"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header","description":"API key to allow developers to access the API"}},"jsonRequestBodyExample":{"record":{"name":"Please add more integrations","assignees":["17a54124-287f-494d-965e-3c5b330c9a68"],"creator":"3fa85f64-5717-4562-b3fc-2c963f66afa6","due_date":"2022-10-11T00:00:00Z","status":"OPEN","description":"Can you please add more integrations? It'll make syncing data much easier!","collections":["fb8c55b6-1cb8-4b4c-9fb6-17924231619d"],"ticket_type":"incident","account":"0958cbc6-6040-430a-848e-aafacbadf4ae","contact":"65c345ba-6870-4974-87ba-dd31509c367a","parent_ticket":"75b33d04-30d2-4f3e-be45-27838bc94342","tags":["enterprise"],"completed_at":"2021-12-09T00:00:00Z","ticket_url":"https://thirdpartysoftware.com/project/3/issue/1","priority":"HIGH"}},"info":{"version":"0.14.12","title":"Unified Ticketing API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified Actions API (Ticketing) documentation. You can use this API to write to third-party providers.\n\n[View common schema for Ticketing](https://docs.supaglue.com/platform/common-schemas/ticketing)\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://www.postman.com/supaglue/workspace/supaglue-public/overview)\n\n#### Base API URL\n```\nhttps://api.supaglue.io/ticketing/v2\n```\n"},"postman":{"name":"Update ticket","description":{"content":"Updates a Ticket object with the given values.","type":"text/plain"},"url":{"path":["tickets",":ticket_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"ticket_id"}]},"header":[{"disabled":false,"description":{"content":"(Required) The customer ID that uniquely identifies the customer in your application","type":"text/plain"},"key":"x-customer-id","value":""},{"disabled":false,"description":{"content":"(Required) The provider name","type":"text/plain"},"key":"x-provider-name","value":""},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PATCH","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"apikey","apikey":[{"type":"any","value":"x-api-key","key":"key"},{"type":"any","value":"","key":"value"},{"type":"any","value":"header","key":"in"}]}}} +sidebar_class_name: "patch api-method" +info_path: api/v2/ticketing/unified-ticketing-api +custom_edit_url: null +--- + +import ApiTabs from "@theme/ApiTabs"; +import DiscriminatorTabs from "@theme/DiscriminatorTabs"; +import MethodEndpoint from "@theme/ApiDemoPanel/MethodEndpoint"; +import SecuritySchemes from "@theme/ApiDemoPanel/SecuritySchemes"; +import MimeTabs from "@theme/MimeTabs"; +import ParamsItem from "@theme/ParamsItem"; +import ResponseSamples from "@theme/ResponseSamples"; +import SchemaItem from "@theme/SchemaItem"; +import SchemaTabs from "@theme/SchemaTabs"; +import TabItem from "@theme/TabItem"; + +

              Update ticket

              + + + + + + + +Updates a Ticket object with the given values. + +## Request + +

              Path Parameters

              Header Parameters

              Body

              required
                record objectrequired
              + +Ticket updated + +
              Schema
                errors object[]
              • Array [
              • ]
                • warnings object[]
              • Array [
              • ]
              + diff --git a/docs/versioned_docs/version-0.14.10/api/v2/ticketing/users.tag.mdx b/docs/versioned_docs/version-0.14.12/api/v2/ticketing/users.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/api/v2/ticketing/users.tag.mdx rename to docs/versioned_docs/version-0.14.12/api/v2/ticketing/users.tag.mdx diff --git a/docs/versioned_docs/version-0.14.10/destinations/bigquery.md b/docs/versioned_docs/version-0.14.12/destinations/bigquery.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/destinations/bigquery.md rename to docs/versioned_docs/version-0.14.12/destinations/bigquery.md diff --git a/docs/versioned_docs/version-0.14.10/destinations/mongodb.md b/docs/versioned_docs/version-0.14.12/destinations/mongodb.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/destinations/mongodb.md rename to docs/versioned_docs/version-0.14.12/destinations/mongodb.md diff --git a/docs/versioned_docs/version-0.14.10/destinations/mysql.md b/docs/versioned_docs/version-0.14.12/destinations/mysql.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/destinations/mysql.md rename to docs/versioned_docs/version-0.14.12/destinations/mysql.md diff --git a/docs/versioned_docs/version-0.14.10/destinations/postgres.md b/docs/versioned_docs/version-0.14.12/destinations/postgres.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/destinations/postgres.md rename to docs/versioned_docs/version-0.14.12/destinations/postgres.md diff --git a/docs/versioned_docs/version-0.14.10/destinations/snowflake.md b/docs/versioned_docs/version-0.14.12/destinations/snowflake.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/destinations/snowflake.md rename to docs/versioned_docs/version-0.14.12/destinations/snowflake.md diff --git a/docs/versioned_docs/version-0.14.10/integration-patterns/actions-api.mdx b/docs/versioned_docs/version-0.14.12/integration-patterns/actions-api.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/integration-patterns/actions-api.mdx rename to docs/versioned_docs/version-0.14.12/integration-patterns/actions-api.mdx diff --git a/docs/versioned_docs/version-0.14.10/integration-patterns/managed-syncs.mdx b/docs/versioned_docs/version-0.14.12/integration-patterns/managed-syncs.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/integration-patterns/managed-syncs.mdx rename to docs/versioned_docs/version-0.14.12/integration-patterns/managed-syncs.mdx diff --git a/docs/versioned_docs/version-0.14.10/integration-patterns/overview.mdx b/docs/versioned_docs/version-0.14.12/integration-patterns/overview.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/integration-patterns/overview.mdx rename to docs/versioned_docs/version-0.14.12/integration-patterns/overview.mdx diff --git a/docs/versioned_docs/version-0.14.10/integration-patterns/real-time-events.md b/docs/versioned_docs/version-0.14.12/integration-patterns/real-time-events.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/integration-patterns/real-time-events.md rename to docs/versioned_docs/version-0.14.12/integration-patterns/real-time-events.md diff --git a/docs/versioned_docs/version-0.14.12/integration-patterns/unified-api.mdx b/docs/versioned_docs/version-0.14.12/integration-patterns/unified-api.mdx new file mode 100644 index 000000000..d9cb086d2 --- /dev/null +++ b/docs/versioned_docs/version-0.14.12/integration-patterns/unified-api.mdx @@ -0,0 +1,63 @@ +import ThemedImage from '@theme/ThemedImage'; + +# Unified API + + + +**Unified API**: Write to multiple third-party providers with a single API for the following categories: + +- [`crm`](../api/v2/crm/unified-crm-api) ([common schema](../platform/common-schemas/crm)) +- [`engagement`](../api/v2/engagement/unified-engagement-api) +- [`enrichment`](../api/v2/enrichment/unified-enrichment-api) +- [`ticketing`](../api/v2/ticketing/unified-ticketing-api) + +## Errors + +Supaglue returns the following error codes and problem types: + +### 3XX + +#### 304 NOT_MODIFIED + +### 4XX + +#### 400 BAD_REQUEST_ERROR + +#### 401 UNAUTHORIZED_ERROR + +#### 403 FORBIDDEN_ERROR + +#### 404 NOT_FOUND_ERROR + +#### 409 CONFLICT_ERROR + +#### 422 UNPROCESSABLE_ENTITY_ERROR + +#### 429 TOO_MANY_REQUESTS_ERROR + +#### 499 REMOTE_PROVIDER_ERROR + +Supaglue returns a custom HTTP status code 499 as a catch-all to pass back remote Provider error messages. + +### 5XX + +#### 500 INTERNAL_SERVER_ERROR + +Supaglue returns a 500 `INTERNAL_SERVER_ERROR` as a catch-all for Supaglue-related errors. + +#### 500 CACHE_INVALIDATION_ERROR + +Supaglue returns a `CACHE_INVALIDATION_ERROR` for writes when it cannot refresh the value in your Destination after writing to a Provider. + +#### 502 BAD_GATEWAY_ERROR + +#### 503 SERVICE_UNAVAILABLE_ERROR + +#### 504 GATEWAY_TIMEOUT_ERROR diff --git a/docs/versioned_docs/version-0.14.10/intro.md b/docs/versioned_docs/version-0.14.12/intro.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/intro.md rename to docs/versioned_docs/version-0.14.12/intro.md diff --git a/docs/versioned_docs/version-0.14.10/platform/common-schemas/crm.md b/docs/versioned_docs/version-0.14.12/platform/common-schemas/crm.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/platform/common-schemas/crm.md rename to docs/versioned_docs/version-0.14.12/platform/common-schemas/crm.md diff --git a/docs/versioned_docs/version-0.14.10/platform/common-schemas/engagement.md b/docs/versioned_docs/version-0.14.12/platform/common-schemas/engagement.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/platform/common-schemas/engagement.md rename to docs/versioned_docs/version-0.14.12/platform/common-schemas/engagement.md diff --git a/docs/versioned_docs/version-0.14.10/platform/common-schemas/enrichment.md b/docs/versioned_docs/version-0.14.12/platform/common-schemas/enrichment.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/platform/common-schemas/enrichment.md rename to docs/versioned_docs/version-0.14.12/platform/common-schemas/enrichment.md diff --git a/docs/versioned_docs/version-0.14.10/platform/common-schemas/ticketing.md b/docs/versioned_docs/version-0.14.12/platform/common-schemas/ticketing.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/platform/common-schemas/ticketing.md rename to docs/versioned_docs/version-0.14.12/platform/common-schemas/ticketing.md diff --git a/docs/versioned_docs/version-0.14.10/platform/managed-auth.mdx b/docs/versioned_docs/version-0.14.12/platform/managed-auth.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/platform/managed-auth.mdx rename to docs/versioned_docs/version-0.14.12/platform/managed-auth.mdx diff --git a/docs/versioned_docs/version-0.14.10/platform/notification-webhooks.md b/docs/versioned_docs/version-0.14.12/platform/notification-webhooks.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/platform/notification-webhooks.md rename to docs/versioned_docs/version-0.14.12/platform/notification-webhooks.md diff --git a/docs/versioned_docs/version-0.14.10/platform/objects/overview.mdx b/docs/versioned_docs/version-0.14.12/platform/objects/overview.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/platform/objects/overview.mdx rename to docs/versioned_docs/version-0.14.12/platform/objects/overview.mdx diff --git a/docs/versioned_docs/version-0.14.10/platform/overview.md b/docs/versioned_docs/version-0.14.12/platform/overview.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/platform/overview.md rename to docs/versioned_docs/version-0.14.12/platform/overview.md diff --git a/docs/versioned_docs/version-0.14.10/platform/passthrough.md b/docs/versioned_docs/version-0.14.12/platform/passthrough.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/platform/passthrough.md rename to docs/versioned_docs/version-0.14.12/platform/passthrough.md diff --git a/docs/versioned_docs/version-0.14.10/providers/6sense.md b/docs/versioned_docs/version-0.14.12/providers/6sense.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/6sense.md rename to docs/versioned_docs/version-0.14.12/providers/6sense.md diff --git a/docs/versioned_docs/version-0.14.10/providers/amplitude.md b/docs/versioned_docs/version-0.14.12/providers/amplitude.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/amplitude.md rename to docs/versioned_docs/version-0.14.12/providers/amplitude.md diff --git a/docs/versioned_docs/version-0.14.10/providers/apollo.md b/docs/versioned_docs/version-0.14.12/providers/apollo.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/apollo.md rename to docs/versioned_docs/version-0.14.12/providers/apollo.md diff --git a/docs/versioned_docs/version-0.14.10/providers/asana.md b/docs/versioned_docs/version-0.14.12/providers/asana.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/asana.md rename to docs/versioned_docs/version-0.14.12/providers/asana.md diff --git a/docs/versioned_docs/version-0.14.10/providers/box.md b/docs/versioned_docs/version-0.14.12/providers/box.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/box.md rename to docs/versioned_docs/version-0.14.12/providers/box.md diff --git a/docs/versioned_docs/version-0.14.10/providers/chargebee.md b/docs/versioned_docs/version-0.14.12/providers/chargebee.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/chargebee.md rename to docs/versioned_docs/version-0.14.12/providers/chargebee.md diff --git a/docs/versioned_docs/version-0.14.10/providers/clearbit.md b/docs/versioned_docs/version-0.14.12/providers/clearbit.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/clearbit.md rename to docs/versioned_docs/version-0.14.12/providers/clearbit.md diff --git a/docs/versioned_docs/version-0.14.10/providers/dropbox.md b/docs/versioned_docs/version-0.14.12/providers/dropbox.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/dropbox.md rename to docs/versioned_docs/version-0.14.12/providers/dropbox.md diff --git a/docs/versioned_docs/version-0.14.10/providers/gmail.md b/docs/versioned_docs/version-0.14.12/providers/gmail.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/gmail.md rename to docs/versioned_docs/version-0.14.12/providers/gmail.md diff --git a/docs/versioned_docs/version-0.14.10/providers/gong.md b/docs/versioned_docs/version-0.14.12/providers/gong.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/gong.md rename to docs/versioned_docs/version-0.14.12/providers/gong.md diff --git a/docs/versioned_docs/version-0.14.10/providers/google-analytics.md b/docs/versioned_docs/version-0.14.12/providers/google-analytics.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/google-analytics.md rename to docs/versioned_docs/version-0.14.12/providers/google-analytics.md diff --git a/docs/versioned_docs/version-0.14.10/providers/google_calendar.md b/docs/versioned_docs/version-0.14.12/providers/google_calendar.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/google_calendar.md rename to docs/versioned_docs/version-0.14.12/providers/google_calendar.md diff --git a/docs/versioned_docs/version-0.14.10/providers/google_drive.md b/docs/versioned_docs/version-0.14.12/providers/google_drive.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/google_drive.md rename to docs/versioned_docs/version-0.14.12/providers/google_drive.md diff --git a/docs/versioned_docs/version-0.14.10/providers/hubspot.md b/docs/versioned_docs/version-0.14.12/providers/hubspot.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/hubspot.md rename to docs/versioned_docs/version-0.14.12/providers/hubspot.md diff --git a/docs/versioned_docs/version-0.14.10/providers/intercom.md b/docs/versioned_docs/version-0.14.12/providers/intercom.md similarity index 83% rename from docs/versioned_docs/version-0.14.10/providers/intercom.md rename to docs/versioned_docs/version-0.14.12/providers/intercom.md index 0409b188c..d54ae4a17 100644 --- a/docs/versioned_docs/version-0.14.10/providers/intercom.md +++ b/docs/versioned_docs/version-0.14.12/providers/intercom.md @@ -11,15 +11,15 @@ description: '' **Category:** `ticketing` -| Feature | Available | -| ------------------------------------ | --------------------------------------------------- | -| Authentication (`oauth2`) | Yes | -| Managed syncs | No | -|     Sync strategies | `full then incremental` (soft delete not supported) | -| Unified API | Yes | -|     Data invalidation | Yes | -| Real-time events | No | -| Passthrough API | Yes | +| Feature | Available | +| ------------------------------------ | ---------------------------------------------------------------- | +| Authentication (`oauth2`) | Yes | +| Managed syncs | Yes | +|     Sync strategies | `full then incremental`, `full only` (soft delete not supported) | +| Unified API | Yes | +|     Data invalidation | Yes | +| Real-time events | No | +| Passthrough API | Yes | Supported standard objects: diff --git a/docs/versioned_docs/version-0.14.10/providers/linear.mdx b/docs/versioned_docs/version-0.14.12/providers/linear.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/linear.mdx rename to docs/versioned_docs/version-0.14.12/providers/linear.mdx diff --git a/docs/versioned_docs/version-0.14.10/providers/linkedin.md b/docs/versioned_docs/version-0.14.12/providers/linkedin.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/linkedin.md rename to docs/versioned_docs/version-0.14.12/providers/linkedin.md diff --git a/docs/versioned_docs/version-0.14.10/providers/marketo.md b/docs/versioned_docs/version-0.14.12/providers/marketo.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/marketo.md rename to docs/versioned_docs/version-0.14.12/providers/marketo.md diff --git a/docs/versioned_docs/version-0.14.10/providers/messenger.md b/docs/versioned_docs/version-0.14.12/providers/messenger.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/messenger.md rename to docs/versioned_docs/version-0.14.12/providers/messenger.md diff --git a/docs/versioned_docs/version-0.14.10/providers/mixpanel.md b/docs/versioned_docs/version-0.14.12/providers/mixpanel.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/mixpanel.md rename to docs/versioned_docs/version-0.14.12/providers/mixpanel.md diff --git a/docs/versioned_docs/version-0.14.10/providers/ms_dynamics_365_sales.md b/docs/versioned_docs/version-0.14.12/providers/ms_dynamics_365_sales.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/ms_dynamics_365_sales.md rename to docs/versioned_docs/version-0.14.12/providers/ms_dynamics_365_sales.md diff --git a/docs/versioned_docs/version-0.14.10/providers/onedrive.md b/docs/versioned_docs/version-0.14.12/providers/onedrive.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/onedrive.md rename to docs/versioned_docs/version-0.14.12/providers/onedrive.md diff --git a/docs/versioned_docs/version-0.14.10/providers/outlook.md b/docs/versioned_docs/version-0.14.12/providers/outlook.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/outlook.md rename to docs/versioned_docs/version-0.14.12/providers/outlook.md diff --git a/docs/versioned_docs/version-0.14.10/providers/outreach.md b/docs/versioned_docs/version-0.14.12/providers/outreach.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/outreach.md rename to docs/versioned_docs/version-0.14.12/providers/outreach.md diff --git a/docs/versioned_docs/version-0.14.10/providers/pipedrive.md b/docs/versioned_docs/version-0.14.12/providers/pipedrive.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/pipedrive.md rename to docs/versioned_docs/version-0.14.12/providers/pipedrive.md diff --git a/docs/versioned_docs/version-0.14.10/providers/salesforce.mdx b/docs/versioned_docs/version-0.14.12/providers/salesforce.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/salesforce.mdx rename to docs/versioned_docs/version-0.14.12/providers/salesforce.mdx diff --git a/docs/versioned_docs/version-0.14.10/providers/salesforce_marketing_cloud_account_engagement.md b/docs/versioned_docs/version-0.14.12/providers/salesforce_marketing_cloud_account_engagement.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/salesforce_marketing_cloud_account_engagement.md rename to docs/versioned_docs/version-0.14.12/providers/salesforce_marketing_cloud_account_engagement.md diff --git a/docs/versioned_docs/version-0.14.10/providers/salesloft.md b/docs/versioned_docs/version-0.14.12/providers/salesloft.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/salesloft.md rename to docs/versioned_docs/version-0.14.12/providers/salesloft.md diff --git a/docs/versioned_docs/version-0.14.10/providers/segment.md b/docs/versioned_docs/version-0.14.12/providers/segment.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/segment.md rename to docs/versioned_docs/version-0.14.12/providers/segment.md diff --git a/docs/versioned_docs/version-0.14.10/providers/slack.md b/docs/versioned_docs/version-0.14.12/providers/slack.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/slack.md rename to docs/versioned_docs/version-0.14.12/providers/slack.md diff --git a/docs/versioned_docs/version-0.14.10/providers/stripe.md b/docs/versioned_docs/version-0.14.12/providers/stripe.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/stripe.md rename to docs/versioned_docs/version-0.14.12/providers/stripe.md diff --git a/docs/versioned_docs/version-0.14.10/providers/teams.md b/docs/versioned_docs/version-0.14.12/providers/teams.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/teams.md rename to docs/versioned_docs/version-0.14.12/providers/teams.md diff --git a/docs/versioned_docs/version-0.14.10/providers/whatsapp.md b/docs/versioned_docs/version-0.14.12/providers/whatsapp.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/whatsapp.md rename to docs/versioned_docs/version-0.14.12/providers/whatsapp.md diff --git a/docs/versioned_docs/version-0.14.10/providers/zendesk.md b/docs/versioned_docs/version-0.14.12/providers/zendesk.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/zendesk.md rename to docs/versioned_docs/version-0.14.12/providers/zendesk.md diff --git a/docs/versioned_docs/version-0.14.10/providers/zoho.md b/docs/versioned_docs/version-0.14.12/providers/zoho.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/zoho.md rename to docs/versioned_docs/version-0.14.12/providers/zoho.md diff --git a/docs/versioned_docs/version-0.14.10/providers/zoom.md b/docs/versioned_docs/version-0.14.12/providers/zoom.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/zoom.md rename to docs/versioned_docs/version-0.14.12/providers/zoom.md diff --git a/docs/versioned_docs/version-0.14.10/providers/zoominfo.md b/docs/versioned_docs/version-0.14.12/providers/zoominfo.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/zoominfo.md rename to docs/versioned_docs/version-0.14.12/providers/zoominfo.md diff --git a/docs/versioned_docs/version-0.14.10/providers/zuora.md b/docs/versioned_docs/version-0.14.12/providers/zuora.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/providers/zuora.md rename to docs/versioned_docs/version-0.14.12/providers/zuora.md diff --git a/docs/versioned_docs/version-0.14.10/quickstart.mdx b/docs/versioned_docs/version-0.14.12/quickstart.mdx similarity index 99% rename from docs/versioned_docs/version-0.14.10/quickstart.mdx rename to docs/versioned_docs/version-0.14.12/quickstart.mdx index 7d3033e21..82f44d4bc 100644 --- a/docs/versioned_docs/version-0.14.10/quickstart.mdx +++ b/docs/versioned_docs/version-0.14.12/quickstart.mdx @@ -36,7 +36,7 @@ Create a free Supaglue Cloud account **[here](https://app.supaglue.io/sign-up)** Clone the Github repo and run the Supaglue stack locally using docker compose: ```shell -git clone -b v0.14.10 https://github.com/supaglue-labs/supaglue.git && cd supaglue +git clone -b v0.14.12 https://github.com/supaglue-labs/supaglue.git && cd supaglue ./scripts/create_quickstart_env.sh docker compose up ``` diff --git a/docs/versioned_docs/version-0.14.10/recipes/overview.md b/docs/versioned_docs/version-0.14.12/recipes/overview.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/recipes/overview.md rename to docs/versioned_docs/version-0.14.12/recipes/overview.md diff --git a/docs/versioned_docs/version-0.14.10/recipes/supaglue-inngest.mdx b/docs/versioned_docs/version-0.14.12/recipes/supaglue-inngest.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/recipes/supaglue-inngest.mdx rename to docs/versioned_docs/version-0.14.12/recipes/supaglue-inngest.mdx diff --git a/docs/versioned_docs/version-0.14.10/recipes/supaglue-prisma.mdx b/docs/versioned_docs/version-0.14.12/recipes/supaglue-prisma.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/recipes/supaglue-prisma.mdx rename to docs/versioned_docs/version-0.14.12/recipes/supaglue-prisma.mdx diff --git a/docs/versioned_docs/version-0.14.10/recipes/supaglue-render.md b/docs/versioned_docs/version-0.14.12/recipes/supaglue-render.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/recipes/supaglue-render.md rename to docs/versioned_docs/version-0.14.12/recipes/supaglue-render.md diff --git a/docs/versioned_docs/version-0.14.10/recipes/supaglue-temporal.md b/docs/versioned_docs/version-0.14.12/recipes/supaglue-temporal.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/recipes/supaglue-temporal.md rename to docs/versioned_docs/version-0.14.12/recipes/supaglue-temporal.md diff --git a/docs/versioned_docs/version-0.14.10/recipes/supaglue-triggerdev.md b/docs/versioned_docs/version-0.14.12/recipes/supaglue-triggerdev.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/recipes/supaglue-triggerdev.md rename to docs/versioned_docs/version-0.14.12/recipes/supaglue-triggerdev.md diff --git a/docs/versioned_docs/version-0.14.10/roadmap.md b/docs/versioned_docs/version-0.14.12/roadmap.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/roadmap.md rename to docs/versioned_docs/version-0.14.12/roadmap.md diff --git a/docs/versioned_docs/version-0.14.10/security_legal/privacy.md b/docs/versioned_docs/version-0.14.12/security_legal/privacy.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/security_legal/privacy.md rename to docs/versioned_docs/version-0.14.12/security_legal/privacy.md diff --git a/docs/versioned_docs/version-0.14.10/security_legal/security.md b/docs/versioned_docs/version-0.14.12/security_legal/security.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/security_legal/security.md rename to docs/versioned_docs/version-0.14.12/security_legal/security.md diff --git a/docs/versioned_docs/version-0.14.10/security_legal/terms.md b/docs/versioned_docs/version-0.14.12/security_legal/terms.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/security_legal/terms.md rename to docs/versioned_docs/version-0.14.12/security_legal/terms.md diff --git a/docs/versioned_docs/version-0.14.10/tutorials/build-integration-card.mdx b/docs/versioned_docs/version-0.14.12/tutorials/build-integration-card.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/tutorials/build-integration-card.mdx rename to docs/versioned_docs/version-0.14.12/tutorials/build-integration-card.mdx diff --git a/docs/versioned_docs/version-0.14.10/tutorials/build-settings-page.mdx b/docs/versioned_docs/version-0.14.12/tutorials/build-settings-page.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/tutorials/build-settings-page.mdx rename to docs/versioned_docs/version-0.14.12/tutorials/build-settings-page.mdx diff --git a/docs/versioned_docs/version-0.14.10/tutorials/listen-for-webhooks.mdx b/docs/versioned_docs/version-0.14.12/tutorials/listen-for-webhooks.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/tutorials/listen-for-webhooks.mdx rename to docs/versioned_docs/version-0.14.12/tutorials/listen-for-webhooks.mdx diff --git a/docs/versioned_docs/version-0.14.10/tutorials/mongo-view-prisma-view.md b/docs/versioned_docs/version-0.14.12/tutorials/mongo-view-prisma-view.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/tutorials/mongo-view-prisma-view.md rename to docs/versioned_docs/version-0.14.12/tutorials/mongo-view-prisma-view.md diff --git a/docs/versioned_docs/version-0.14.10/tutorials/read-write-contacts.md b/docs/versioned_docs/version-0.14.12/tutorials/read-write-contacts.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/tutorials/read-write-contacts.md rename to docs/versioned_docs/version-0.14.12/tutorials/read-write-contacts.md diff --git a/docs/versioned_docs/version-0.14.10/tutorials/search-across-data.mdx b/docs/versioned_docs/version-0.14.12/tutorials/search-across-data.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/tutorials/search-across-data.mdx rename to docs/versioned_docs/version-0.14.12/tutorials/search-across-data.mdx diff --git a/docs/versioned_docs/version-0.14.10/tutorials/transformations/association-bridge-table.mdx b/docs/versioned_docs/version-0.14.12/tutorials/transformations/association-bridge-table.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/tutorials/transformations/association-bridge-table.mdx rename to docs/versioned_docs/version-0.14.12/tutorials/transformations/association-bridge-table.mdx diff --git a/docs/versioned_docs/version-0.14.10/tutorials/transformations/common-schema.mdx b/docs/versioned_docs/version-0.14.12/tutorials/transformations/common-schema.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/tutorials/transformations/common-schema.mdx rename to docs/versioned_docs/version-0.14.12/tutorials/transformations/common-schema.mdx diff --git a/docs/versioned_docs/version-0.14.10/tutorials/transformations/normalized-relations.md b/docs/versioned_docs/version-0.14.12/tutorials/transformations/normalized-relations.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/tutorials/transformations/normalized-relations.md rename to docs/versioned_docs/version-0.14.12/tutorials/transformations/normalized-relations.md diff --git a/docs/versioned_docs/version-0.14.10/tutorials/transformations/object-field-mapping.mdx b/docs/versioned_docs/version-0.14.12/tutorials/transformations/object-field-mapping.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/tutorials/transformations/object-field-mapping.mdx rename to docs/versioned_docs/version-0.14.12/tutorials/transformations/object-field-mapping.mdx diff --git a/docs/versioned_docs/version-0.14.10/tutorials/transformations/overview.mdx b/docs/versioned_docs/version-0.14.12/tutorials/transformations/overview.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/tutorials/transformations/overview.mdx rename to docs/versioned_docs/version-0.14.12/tutorials/transformations/overview.mdx diff --git a/docs/versioned_docs/version-0.14.10/tutorials/transformations/pagination.mdx b/docs/versioned_docs/version-0.14.12/tutorials/transformations/pagination.mdx similarity index 100% rename from docs/versioned_docs/version-0.14.10/tutorials/transformations/pagination.mdx rename to docs/versioned_docs/version-0.14.12/tutorials/transformations/pagination.mdx diff --git a/docs/versioned_docs/version-0.14.10/use-cases/analytics.md b/docs/versioned_docs/version-0.14.12/use-cases/analytics.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/use-cases/analytics.md rename to docs/versioned_docs/version-0.14.12/use-cases/analytics.md diff --git a/docs/versioned_docs/version-0.14.10/use-cases/calculated-scores.md b/docs/versioned_docs/version-0.14.12/use-cases/calculated-scores.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/use-cases/calculated-scores.md rename to docs/versioned_docs/version-0.14.12/use-cases/calculated-scores.md diff --git a/docs/versioned_docs/version-0.14.10/use-cases/data-store.md b/docs/versioned_docs/version-0.14.12/use-cases/data-store.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/use-cases/data-store.md rename to docs/versioned_docs/version-0.14.12/use-cases/data-store.md diff --git a/docs/versioned_docs/version-0.14.10/use-cases/enrichment.md b/docs/versioned_docs/version-0.14.12/use-cases/enrichment.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/use-cases/enrichment.md rename to docs/versioned_docs/version-0.14.12/use-cases/enrichment.md diff --git a/docs/versioned_docs/version-0.14.10/use-cases/overview.md b/docs/versioned_docs/version-0.14.12/use-cases/overview.md similarity index 100% rename from docs/versioned_docs/version-0.14.10/use-cases/overview.md rename to docs/versioned_docs/version-0.14.12/use-cases/overview.md diff --git a/docs/versioned_sidebars/version-0.14.10-sidebars.json b/docs/versioned_sidebars/version-0.14.12-sidebars.json similarity index 99% rename from docs/versioned_sidebars/version-0.14.10-sidebars.json rename to docs/versioned_sidebars/version-0.14.12-sidebars.json index 1b6cbe581..6fe985ab9 100644 --- a/docs/versioned_sidebars/version-0.14.10-sidebars.json +++ b/docs/versioned_sidebars/version-0.14.12-sidebars.json @@ -972,106 +972,6 @@ "className": "menu__list-item--deprecated api-method post" } ] - }, - { - "type": "html", - "value": "
              Metadata API
              " - }, - { - "type": "doc", - "id": "api/v2/metadata/metadata-api" - }, - { - "type": "category", - "label": "CustomObjects", - "link": { - "type": "doc", - "id": "api/v2/metadata/custom-objects" - }, - "collapsed": true, - "items": [ - { - "type": "doc", - "id": "api/v2/metadata/list-custom-objects", - "label": "List customObjects", - "className": "api-method get" - }, - { - "type": "doc", - "id": "api/v2/metadata/create-custom-object", - "label": "Create customObject", - "className": "api-method post" - }, - { - "type": "doc", - "id": "api/v2/metadata/get-custom-object", - "label": "Get customObject", - "className": "api-method get" - }, - { - "type": "doc", - "id": "api/v2/metadata/update-custom-object", - "label": "Update customObject", - "className": "api-method put" - } - ] - }, - { - "type": "category", - "label": "StandardObjects", - "link": { - "type": "doc", - "id": "api/v2/metadata/standard-objects" - }, - "collapsed": true, - "items": [ - { - "type": "doc", - "id": "api/v2/metadata/list-standard-objects", - "label": "List standardObjects", - "className": "api-method get" - } - ] - }, - { - "type": "category", - "label": "AssociationTypes", - "link": { - "type": "doc", - "id": "api/v2/metadata/association-types" - }, - "collapsed": true, - "items": [ - { - "type": "doc", - "id": "api/v2/metadata/get-association-types", - "label": "List associationTypes", - "className": "api-method get" - }, - { - "type": "doc", - "id": "api/v2/metadata/create-association-type", - "label": "Create associationType", - "className": "api-method post" - } - ] - }, - { - "type": "category", - "label": "Properties", - "link": { - "type": "doc", - "id": "api/v2/metadata/properties" - }, - "collapsed": true, - "items": [ - { - "type": "doc", - "id": "api/v2/metadata/list-properties", - "label": "List properties", - "className": "api-method get" - } - ] } ] }, @@ -1646,6 +1546,112 @@ } ] }, + { + "type": "html", + "value": "
              Metadata API
              " + }, + { + "type": "category", + "label": "Metadata API", + "items": [ + { + "type": "doc", + "id": "api/v2/metadata/metadata-api" + }, + { + "type": "category", + "label": "CustomObjects", + "link": { + "type": "doc", + "id": "api/v2/metadata/custom-objects" + }, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/v2/metadata/list-custom-objects", + "label": "List customObjects", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/v2/metadata/create-custom-object", + "label": "Create customObject", + "className": "api-method post" + }, + { + "type": "doc", + "id": "api/v2/metadata/get-custom-object", + "label": "Get customObject", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/v2/metadata/update-custom-object", + "label": "Update customObject", + "className": "api-method put" + } + ] + }, + { + "type": "category", + "label": "StandardObjects", + "link": { + "type": "doc", + "id": "api/v2/metadata/standard-objects" + }, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/v2/metadata/list-standard-objects", + "label": "List standardObjects", + "className": "api-method get" + } + ] + }, + { + "type": "category", + "label": "AssociationTypes", + "link": { + "type": "doc", + "id": "api/v2/metadata/association-types" + }, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/v2/metadata/get-association-types", + "label": "List associationTypes", + "className": "api-method get" + }, + { + "type": "doc", + "id": "api/v2/metadata/create-association-type", + "label": "Create associationType", + "className": "api-method post" + } + ] + }, + { + "type": "category", + "label": "Properties", + "link": { + "type": "doc", + "id": "api/v2/metadata/properties" + }, + "collapsed": true, + "items": [ + { + "type": "doc", + "id": "api/v2/metadata/list-properties", + "label": "List properties", + "className": "api-method get" + } + ] + } + ] + }, { "type": "html", "value": "
              Passthrough API
              " diff --git a/docs/versions.json b/docs/versions.json index a2a48d43d..c959ef58c 100644 --- a/docs/versions.json +++ b/docs/versions.json @@ -1,4 +1,4 @@ [ - "0.14.11", - "0.14.10" + "0.14.12", + "0.14.11" ] diff --git a/openapi/v2/actions/openapi.bundle.json b/openapi/v2/actions/openapi.bundle.json index eaf191ee3..7b25c3718 100644 --- a/openapi/v2/actions/openapi.bundle.json +++ b/openapi/v2/actions/openapi.bundle.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "0.14.11", + "version": "0.14.12", "title": "Actions API", "contact": { "name": "Supaglue", diff --git a/openapi/v2/actions/openapi.yaml b/openapi/v2/actions/openapi.yaml index e99bb45e9..b840272ad 100644 --- a/openapi/v2/actions/openapi.yaml +++ b/openapi/v2/actions/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 0.14.11 + version: 0.14.12 title: Actions API contact: name: Supaglue diff --git a/openapi/v2/crm/openapi.bundle.json b/openapi/v2/crm/openapi.bundle.json index 9d6f9511e..2d303d6a9 100644 --- a/openapi/v2/crm/openapi.bundle.json +++ b/openapi/v2/crm/openapi.bundle.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "0.14.11", + "version": "0.14.12", "title": "Unified CRM API", "contact": { "name": "Supaglue", diff --git a/openapi/v2/crm/openapi.yaml b/openapi/v2/crm/openapi.yaml index acebae5f2..6b65a96ac 100644 --- a/openapi/v2/crm/openapi.yaml +++ b/openapi/v2/crm/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 0.14.11 + version: 0.14.12 title: Unified CRM API contact: name: Supaglue diff --git a/openapi/v2/engagement/openapi.bundle.json b/openapi/v2/engagement/openapi.bundle.json index 7a2ca060b..eebeafa50 100644 --- a/openapi/v2/engagement/openapi.bundle.json +++ b/openapi/v2/engagement/openapi.bundle.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "0.14.11", + "version": "0.14.12", "title": "Unified Engagement API", "contact": { "name": "Supaglue", diff --git a/openapi/v2/engagement/openapi.yaml b/openapi/v2/engagement/openapi.yaml index 51747ad9a..2772a81a6 100644 --- a/openapi/v2/engagement/openapi.yaml +++ b/openapi/v2/engagement/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 0.14.11 + version: 0.14.12 title: Unified Engagement API contact: name: Supaglue diff --git a/openapi/v2/enrichment/openapi.bundle.json b/openapi/v2/enrichment/openapi.bundle.json index 7ccf812bc..0f1cb6b81 100644 --- a/openapi/v2/enrichment/openapi.bundle.json +++ b/openapi/v2/enrichment/openapi.bundle.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "0.14.11", + "version": "0.14.12", "title": "Unified Enrichment API", "contact": { "name": "Supaglue", diff --git a/openapi/v2/enrichment/openapi.yaml b/openapi/v2/enrichment/openapi.yaml index acbf55ed5..bb9213ce5 100644 --- a/openapi/v2/enrichment/openapi.yaml +++ b/openapi/v2/enrichment/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 0.14.11 + version: 0.14.12 title: Unified Enrichment API contact: name: Supaglue diff --git a/openapi/v2/mgmt/openapi.bundle.json b/openapi/v2/mgmt/openapi.bundle.json index 16d5ce38d..75e27b84a 100644 --- a/openapi/v2/mgmt/openapi.bundle.json +++ b/openapi/v2/mgmt/openapi.bundle.json @@ -1,7 +1,7 @@ { "openapi": "3.1.0", "info": { - "version": "0.14.11", + "version": "0.14.12", "title": "Management API", "contact": { "name": "Supaglue", diff --git a/openapi/v2/mgmt/openapi.yaml b/openapi/v2/mgmt/openapi.yaml index d5029710b..3d857b439 100644 --- a/openapi/v2/mgmt/openapi.yaml +++ b/openapi/v2/mgmt/openapi.yaml @@ -2,7 +2,7 @@ # Other than the `webhooks` key, we should not use 3.1.0 features since the validation middleware doesn't support it yet openapi: 3.1.0 info: - version: 0.14.11 + version: 0.14.12 title: Management API contact: name: Supaglue diff --git a/openapi/v2/ticketing/openapi.bundle.json b/openapi/v2/ticketing/openapi.bundle.json index 56eb15955..a67937f2f 100644 --- a/openapi/v2/ticketing/openapi.bundle.json +++ b/openapi/v2/ticketing/openapi.bundle.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "0.14.11", + "version": "0.14.12", "title": "Unified Ticketing API", "contact": { "name": "Supaglue", diff --git a/openapi/v2/ticketing/openapi.yaml b/openapi/v2/ticketing/openapi.yaml index 9428ee901..893e403be 100644 --- a/openapi/v2/ticketing/openapi.yaml +++ b/openapi/v2/ticketing/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 0.14.11 + version: 0.14.12 title: Unified Ticketing API contact: name: Supaglue diff --git a/package.json b/package.json index 6aa236d59..1f89784b2 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "supaglue", - "version": "0.14.11", + "version": "0.14.12", "packageManager": "yarn@3.4.1", "private": true, "workspaces": [ diff --git a/packages/core/package.json b/packages/core/package.json index 6e694e018..7c5649e51 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "@supaglue/core", - "version": "0.14.11", + "version": "0.14.12", "private": true, "index": "dist/index.js", "types": "index.ts", diff --git a/packages/db/package.json b/packages/db/package.json index 4e3aa6a83..70dd4b772 100644 --- a/packages/db/package.json +++ b/packages/db/package.json @@ -1,6 +1,6 @@ { "name": "@supaglue/db", - "version": "0.14.11", + "version": "0.14.12", "private": true, "packageManager": "yarn@3.4.1", "index": "dist/index.js", diff --git a/packages/schemas/package.json b/packages/schemas/package.json index 85a79e2c3..0a699259b 100644 --- a/packages/schemas/package.json +++ b/packages/schemas/package.json @@ -1,6 +1,6 @@ { "name": "@supaglue/schemas", - "version": "0.14.11", + "version": "0.14.12", "scripts": { "generate": "tsx scripts/generate_typescript_from_openapi.ts ../../openapi/v2/crm/openapi.bundle.json gen/v2/crm.ts && tsx scripts/generate_typescript_from_openapi.ts ../../openapi/v2/mgmt/openapi.bundle.json gen/v2/mgmt.ts && tsx scripts/generate_typescript_from_openapi.ts ../../openapi/v2/engagement/openapi.bundle.json gen/v2/engagement.ts && tsx scripts/generate_typescript_from_openapi.ts ../../openapi/v2/actions/openapi.bundle.json gen/v2/actions.ts && tsx scripts/generate_typescript_from_openapi.ts ../../openapi/v2/metadata/openapi.bundle.json gen/v2/metadata.ts && tsx scripts/generate_typescript_from_openapi.ts ../../openapi/v2/data/openapi.bundle.json gen/v2/data.ts && tsx scripts/generate_typescript_from_openapi.ts ../../openapi/v2/enrichment/openapi.bundle.json gen/v2/enrichment.ts && tsx scripts/generate_typescript_from_openapi.ts ../../openapi/v2/marketing-automation/openapi.bundle.json gen/v2/marketing-automation.ts && tsx scripts/generate_typescript_from_openapi.ts ../../openapi/v2/ticketing/openapi.bundle.json gen/v2/ticketing.ts" }, diff --git a/packages/sync-workflows/package.json b/packages/sync-workflows/package.json index 272224b2c..7557e40fc 100644 --- a/packages/sync-workflows/package.json +++ b/packages/sync-workflows/package.json @@ -1,6 +1,6 @@ { "name": "@supaglue/sync-workflows", - "version": "0.14.11", + "version": "0.14.12", "packageManager": "yarn@3.4.1", "dependencies": { "@supaglue/core": "workspace:*", diff --git a/packages/types/package.json b/packages/types/package.json index 4dbe3f2b7..b895b99c7 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@supaglue/types", - "version": "0.14.11", + "version": "0.14.12", "private": true, "index": "dist/index.js", "types": "index.ts", diff --git a/packages/utils/package.json b/packages/utils/package.json index de15ca479..65998bb0f 100644 --- a/packages/utils/package.json +++ b/packages/utils/package.json @@ -1,6 +1,6 @@ { "name": "@supaglue/utils", - "version": "0.14.11", + "version": "0.14.12", "private": true, "index": "dist/index.js", "types": "index.ts",