diff --git a/.yarn/versions/a35c2807.yml b/.yarn/versions/a35c2807.yml new file mode 100644 index 000000000..690b9e718 --- /dev/null +++ b/.yarn/versions/a35c2807.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 91f4ddf90..13069c16e 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.16.0 https://github.com/supaglue-labs/supaglue.git && cd supaglue +git clone -b v0.16.1 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 c7fd18d0b..a9258694e 100644 --- a/apps/api/package.json +++ b/apps/api/package.json @@ -1,6 +1,6 @@ { "name": "api", - "version": "0.16.0", + "version": "0.16.1", "private": true, "packageManager": "yarn@3.4.1", "type": "commonjs", diff --git a/apps/mgmt-ui/package.json b/apps/mgmt-ui/package.json index c6882f0ab..71be7d4d0 100644 --- a/apps/mgmt-ui/package.json +++ b/apps/mgmt-ui/package.json @@ -1,6 +1,6 @@ { "name": "mgmt-ui", - "version": "0.16.0", + "version": "0.16.1", "private": true, "scripts": { "dev": "next dev", diff --git a/apps/salesforce-pub-sub/package.json b/apps/salesforce-pub-sub/package.json index 7f5485770..e93bef843 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.16.0", + "version": "0.16.1", "private": true, "packageManager": "yarn@3.4.1", "dependencies": { diff --git a/apps/sync-worker/package.json b/apps/sync-worker/package.json index dac63a288..a435ceae5 100644 --- a/apps/sync-worker/package.json +++ b/apps/sync-worker/package.json @@ -1,6 +1,6 @@ { "name": "sync-worker", - "version": "0.16.0", + "version": "0.16.1", "private": true, "packageManager": "yarn@3.4.1", "dependencies": { diff --git a/docs/docs/api/v2/actions/actions-api.info.mdx b/docs/docs/api/v2/actions/actions-api.info.mdx index 7c99229fe..a1e261573 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.16.0 +Version: 0.16.1 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 2090a1073..b3e02894c 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.16.0","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.16.1","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 a0e7f41a1..37db56e42 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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 98bd1b4a0..e6c2520db 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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 f21bb7285..5f317650c 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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 3acc02f4c..18211520f 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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 151d61f16..ebe1a176d 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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 5da58e867..bfc05794b 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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 99f5904d0..1c730c2a7 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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 604cf511a..784abe197 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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 2e16204f0..1cd9c3d35 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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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/list-accounts.api.mdx b/docs/docs/api/v2/crm/list-accounts.api.mdx index a3ff7bcf8..9b6b30fea 100644 --- a/docs/docs/api/v2/crm/list-accounts.api.mdx +++ b/docs/docs/api/v2/crm/list-accounts.api.mdx @@ -5,7 +5,7 @@ description: "List accounts" sidebar_label: "List accounts" hide_title: true hide_table_of_contents: true -api: {"operationId":"listAccounts","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":"read_from_cache","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n"},{"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":"Paginated Accounts","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"],"title":"pagination"},"records":{"type":"array","items":{"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"}}},"required":["pagination","records"]}}}}},"description":"List accounts","method":"get","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"}},"info":{"version":"0.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List accounts","description":{"type":"text/plain"},"url":{"path":["accounts"],"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":""},{"disabled":false,"description":{"content":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n","type":"text/plain"},"key":"read_from_cache","value":""},{"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","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":"read_from_cache","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n"},{"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":"Paginated Accounts","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"],"title":"pagination"},"records":{"type":"array","items":{"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"}}},"required":["pagination","records"]}}}}},"description":"List accounts","method":"get","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"}},"info":{"version":"0.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List accounts","description":{"type":"text/plain"},"url":{"path":["accounts"],"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":""},{"disabled":false,"description":{"content":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n","type":"text/plain"},"key":"read_from_cache","value":""},{"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/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/list-contacts.api.mdx b/docs/docs/api/v2/crm/list-contacts.api.mdx index 93d8e597a..2cf6fa350 100644 --- a/docs/docs/api/v2/crm/list-contacts.api.mdx +++ b/docs/docs/api/v2/crm/list-contacts.api.mdx @@ -5,7 +5,7 @@ description: "List contacts" sidebar_label: "List contacts" hide_title: true hide_table_of_contents: true -api: {"operationId":"listContacts","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":"read_from_cache","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n"},{"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":"Paginated Contacts","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"],"title":"pagination"},"records":{"type":"array","items":{"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"}}},"required":["pagination","records"]}}}}},"description":"List contacts","method":"get","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"}},"info":{"version":"0.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List contacts","description":{"type":"text/plain"},"url":{"path":["contacts"],"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":""},{"disabled":false,"description":{"content":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n","type":"text/plain"},"key":"read_from_cache","value":""},{"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","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":"read_from_cache","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n"},{"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":"Paginated Contacts","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"],"title":"pagination"},"records":{"type":"array","items":{"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"}}},"required":["pagination","records"]}}}}},"description":"List contacts","method":"get","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"}},"info":{"version":"0.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List contacts","description":{"type":"text/plain"},"url":{"path":["contacts"],"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":""},{"disabled":false,"description":{"content":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n","type":"text/plain"},"key":"read_from_cache","value":""},{"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/crm/unified-crm-api custom_edit_url: null diff --git a/docs/docs/api/v2/crm/list-list-memberships.api.mdx b/docs/docs/api/v2/crm/list-list-memberships.api.mdx index 55e3166e0..9d9f03ee1 100644 --- a/docs/docs/api/v2/crm/list-list-memberships.api.mdx +++ b/docs/docs/api/v2/crm/list-list-memberships.api.mdx @@ -5,7 +5,7 @@ description: "Support:" sidebar_label: "List list memberships" hide_title: true hide_table_of_contents: true -api: {"operationId":"listListMemberships","description":"Support:\n\n| Provider | Object | Common Schema support | Notes |\n| ---------- | ------------------------------------------- | --------------------- | ------------------------------------- |\n| Hubspot | `contact` | Yes | Raw data response from V3 API |\n| Salesforce | `contact`, `account`, `lead`, `opportunity` | Yes | Raw data response from V57.0 REST API |\n","tags":["Lists"],"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":"object_type","in":"query","schema":{"type":"string","enum":["contact","account","opportunity","lead"],"example":"contact"},"description":"The Supaglue common object type to fetch a list for.","required":true},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"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":"list_id","in":"path","required":true,"schema":{"type":"string","example":"220e715a-0cbc-4d2d-8420-cd729f12f094"}}],"responses":{"200":{"description":"List membership","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"],"title":"pagination"},"records":{"type":"array","items":{"oneOf":[{"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"},{"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"},{"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"},{"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"}],"title":"list_membership"}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"00BDn00000RHS32MAH","description":"The provider-specific unique identifier for this list."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"RecentlyViewedContacts","description":"The developer name of this list."},"label":{"type":"string","example":"Recently Viewed Contacts","description":"The label for this list."},"raw_data":{"type":"object","description":"The raw data from the provider for this list.","additionalProperties":true,"example":{"attributes":{"type":"ListView","url":"/services/data/v57.0/sobjects/ListView/00BDn00000RHS32MAH"},"Id":"00BDn00000RHS32MAH","Name":"Recently Viewed Contacts","DeveloperName":"RecentlyViewedContacts","NamespacePrefix":null,"SobjectType":"Contact","IsSoqlCompatible":true,"CreatedDate":"2023-05-26T22:25:47.000+0000","CreatedById":"005Dn0000079fN6IAI","LastModifiedDate":"2023-05-26T22:25:47.000+0000","LastModifiedById":"005Dn0000079fN6IAI","SystemModstamp":"2023-05-26T22:25:47.000+0000","LastViewedDate":null,"LastReferencedDate":null}}},"required":["id","object_type","name","label","raw_data"],"title":"list_metadata","description":"Metadata about the remote provider list view."}},"required":["pagination","records","metadata"]}}}}},"method":"get","path":"/lists/{list_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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List list memberships","description":{"content":"Support:\n\n| Provider | Object | Common Schema support | Notes |\n| ---------- | ------------------------------------------- | --------------------- | ------------------------------------- |\n| Hubspot | `contact` | Yes | Raw data response from V3 API |\n| Salesforce | `contact`, `account`, `lead`, `opportunity` | Yes | Raw data response from V57.0 REST API |\n","type":"text/plain"},"url":{"path":["lists",":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":""},{"disabled":false,"description":{"content":"(Required) The Supaglue common object type to fetch a list for.","type":"text/plain"},"key":"object_type","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"list_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":"listListMemberships","description":"Support:\n\n| Provider | Object | Common Schema support | Notes |\n| ---------- | ------------------------------------------- | --------------------- | ------------------------------------- |\n| Hubspot | `contact` | Yes | Raw data response from V3 API |\n| Salesforce | `contact`, `account`, `lead`, `opportunity` | Yes | Raw data response from V57.0 REST API |\n","tags":["Lists"],"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":"object_type","in":"query","schema":{"type":"string","enum":["contact","account","opportunity","lead"],"example":"contact"},"description":"The Supaglue common object type to fetch a list for.","required":true},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"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":"list_id","in":"path","required":true,"schema":{"type":"string","example":"220e715a-0cbc-4d2d-8420-cd729f12f094"}}],"responses":{"200":{"description":"List membership","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"],"title":"pagination"},"records":{"type":"array","items":{"oneOf":[{"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"},{"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"},{"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"},{"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"}],"title":"list_membership"}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"00BDn00000RHS32MAH","description":"The provider-specific unique identifier for this list."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"RecentlyViewedContacts","description":"The developer name of this list."},"label":{"type":"string","example":"Recently Viewed Contacts","description":"The label for this list."},"raw_data":{"type":"object","description":"The raw data from the provider for this list.","additionalProperties":true,"example":{"attributes":{"type":"ListView","url":"/services/data/v57.0/sobjects/ListView/00BDn00000RHS32MAH"},"Id":"00BDn00000RHS32MAH","Name":"Recently Viewed Contacts","DeveloperName":"RecentlyViewedContacts","NamespacePrefix":null,"SobjectType":"Contact","IsSoqlCompatible":true,"CreatedDate":"2023-05-26T22:25:47.000+0000","CreatedById":"005Dn0000079fN6IAI","LastModifiedDate":"2023-05-26T22:25:47.000+0000","LastModifiedById":"005Dn0000079fN6IAI","SystemModstamp":"2023-05-26T22:25:47.000+0000","LastViewedDate":null,"LastReferencedDate":null}}},"required":["id","object_type","name","label","raw_data"],"title":"list_metadata","description":"Metadata about the remote provider list view."}},"required":["pagination","records","metadata"]}}}}},"method":"get","path":"/lists/{list_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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List list memberships","description":{"content":"Support:\n\n| Provider | Object | Common Schema support | Notes |\n| ---------- | ------------------------------------------- | --------------------- | ------------------------------------- |\n| Hubspot | `contact` | Yes | Raw data response from V3 API |\n| Salesforce | `contact`, `account`, `lead`, `opportunity` | Yes | Raw data response from V57.0 REST API |\n","type":"text/plain"},"url":{"path":["lists",":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":""},{"disabled":false,"description":{"content":"(Required) The Supaglue common object type to fetch a list for.","type":"text/plain"},"key":"object_type","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"list_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/list-lists.api.mdx b/docs/docs/api/v2/crm/list-lists.api.mdx index 5f37ca53b..94ad63a85 100644 --- a/docs/docs/api/v2/crm/list-lists.api.mdx +++ b/docs/docs/api/v2/crm/list-lists.api.mdx @@ -5,7 +5,7 @@ description: "List lists" sidebar_label: "List lists" hide_title: true hide_table_of_contents: true -api: {"operationId":"listLists","tags":["Lists"],"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":"object_type","in":"query","schema":{"type":"string","enum":["contact","account","opportunity","lead"],"example":"contact"},"description":"The Supaglue common object type to fetch a list for.","required":true},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"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 Lists","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"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"00BDn00000RHS32MAH","description":"The provider-specific unique identifier for this list."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"RecentlyViewedContacts","description":"The developer name of this list."},"label":{"type":"string","example":"Recently Viewed Contacts","description":"The label for this list."},"raw_data":{"type":"object","description":"The raw data from the provider for this list.","additionalProperties":true,"example":{"attributes":{"type":"ListView","url":"/services/data/v57.0/sobjects/ListView/00BDn00000RHS32MAH"},"Id":"00BDn00000RHS32MAH","Name":"Recently Viewed Contacts","DeveloperName":"RecentlyViewedContacts","NamespacePrefix":null,"SobjectType":"Contact","IsSoqlCompatible":true,"CreatedDate":"2023-05-26T22:25:47.000+0000","CreatedById":"005Dn0000079fN6IAI","LastModifiedDate":"2023-05-26T22:25:47.000+0000","LastModifiedById":"005Dn0000079fN6IAI","SystemModstamp":"2023-05-26T22:25:47.000+0000","LastViewedDate":null,"LastReferencedDate":null}}},"required":["id","object_type","name","label","raw_data"],"title":"list_metadata"}}},"required":["pagination","records"]}}}}},"description":"List lists","method":"get","path":"/lists","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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List lists","description":{"type":"text/plain"},"url":{"path":["lists"],"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":""},{"disabled":false,"description":{"content":"(Required) The Supaglue common object type to fetch a list for.","type":"text/plain"},"key":"object_type","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":"listLists","tags":["Lists"],"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":"object_type","in":"query","schema":{"type":"string","enum":["contact","account","opportunity","lead"],"example":"contact"},"description":"The Supaglue common object type to fetch a list for.","required":true},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"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 Lists","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"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"00BDn00000RHS32MAH","description":"The provider-specific unique identifier for this list."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"RecentlyViewedContacts","description":"The developer name of this list."},"label":{"type":"string","example":"Recently Viewed Contacts","description":"The label for this list."},"raw_data":{"type":"object","description":"The raw data from the provider for this list.","additionalProperties":true,"example":{"attributes":{"type":"ListView","url":"/services/data/v57.0/sobjects/ListView/00BDn00000RHS32MAH"},"Id":"00BDn00000RHS32MAH","Name":"Recently Viewed Contacts","DeveloperName":"RecentlyViewedContacts","NamespacePrefix":null,"SobjectType":"Contact","IsSoqlCompatible":true,"CreatedDate":"2023-05-26T22:25:47.000+0000","CreatedById":"005Dn0000079fN6IAI","LastModifiedDate":"2023-05-26T22:25:47.000+0000","LastModifiedById":"005Dn0000079fN6IAI","SystemModstamp":"2023-05-26T22:25:47.000+0000","LastViewedDate":null,"LastReferencedDate":null}}},"required":["id","object_type","name","label","raw_data"],"title":"list_metadata"}}},"required":["pagination","records"]}}}}},"description":"List lists","method":"get","path":"/lists","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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List lists","description":{"type":"text/plain"},"url":{"path":["lists"],"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":""},{"disabled":false,"description":{"content":"(Required) The Supaglue common object type to fetch a list for.","type":"text/plain"},"key":"object_type","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/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 9ac072705..ef42bbc1b 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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 578d214b0..885ded4d5 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.16.0 +Version: 0.16.1 diff --git a/docs/docs/api/v2/crm/update-account.api.mdx b/docs/docs/api/v2/crm/update-account.api.mdx index 4fe252828..37ce59f2c 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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 b25f43d2f..a84727db7 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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 577c760b8..917114d55 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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 165a842be..e32db1fb8 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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 30e131698..ba71d1584 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 an account. If the account does not exist, it will be creat sidebar_label: "Upsert account" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertAccount","description":"Upsert an account. If the account does not exist, it will be created. If the account does exist, it will be updated.\nOnly supported for Salesforce and Hubspot.\n","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","website"],"description":"The key to upsert on. Only `website` is supported for Salesforce, while both `domain` and `website` are supported for Hubspot."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","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"}}}}}}},"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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":{"content":"Upsert an account. If the account does not exist, it will be created. If the account does exist, it will be updated.\nOnly supported for Salesforce and Hubspot.\n","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","description":"Upsert an account. If the account does not exist, it will be created. If the account does exist, it will be updated.\nOnly supported for Salesforce and Hubspot.\n","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","website"],"description":"The key to upsert on. Only `website` is supported for Salesforce, while both `domain` and `website` are supported for Hubspot."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","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"}}}}}}},"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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":{"content":"Upsert an account. If the account does not exist, it will be created. If the account does exist, it will be updated.\nOnly supported for Salesforce and Hubspot.\n","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 d7fb14d81..e4170e5d8 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 a contact. If the contact does not exist, it will be create sidebar_label: "Upsert contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertContact","description":"Upsert a contact. If the contact does not exist, it will be created. If the contact does exist, it will be updated.\nOnly supported for Salesforce, Hubspot, and Pipedrive.\n","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"],"description":"The key to upsert on. Only `email` is supported for all providers."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","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"}}}}}}},"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.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":{"content":"Upsert a contact. If the contact does not exist, it will be created. If the contact does exist, it will be updated.\nOnly supported for Salesforce, Hubspot, and Pipedrive.\n","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","description":"Upsert a contact. If the contact does not exist, it will be created. If the contact does exist, it will be updated.\nOnly supported for Salesforce, Hubspot, and Pipedrive.\n","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"],"description":"The key to upsert on. Only `email` is supported for all providers."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","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"}}}}}}},"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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":{"content":"Upsert a contact. If the contact does not exist, it will be created. If the contact does exist, it will be updated.\nOnly supported for Salesforce, Hubspot, and Pipedrive.\n","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/crm/upsert-lead.api.mdx b/docs/docs/api/v2/crm/upsert-lead.api.mdx index 3f5df2406..012e4464a 100644 --- a/docs/docs/api/v2/crm/upsert-lead.api.mdx +++ b/docs/docs/api/v2/crm/upsert-lead.api.mdx @@ -5,7 +5,7 @@ description: "Upsert a lead. If the lead does not exist, it will be created. If sidebar_label: "Upsert lead" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertLead","description":"Upsert a lead. If the lead does not exist, it will be created. If the lead does exist, it will be updated.\nOnly supported for Salesforce.\n","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"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["email"],"description":"The key to upsert on. Only `email` is supported."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","items":{"type":"string","example":"hello@example.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"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"}}}}}}},"method":"post","path":"/leads/_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":{"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":{}},"upsert_on":{"key":"email","values":["hello@example.com"]}},"info":{"version":"0.16.0","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 lead","description":{"content":"Upsert a lead. If the lead does not exist, it will be created. If the lead does exist, it will be updated.\nOnly supported for Salesforce.\n","type":"text/plain"},"url":{"path":["leads","_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":"upsertLead","description":"Upsert a lead. If the lead does not exist, it will be created. If the lead does exist, it will be updated.\nOnly supported for Salesforce.\n","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"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["email"],"description":"The key to upsert on. Only `email` is supported."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","items":{"type":"string","example":"hello@example.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"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"}}}}}}},"method":"post","path":"/leads/_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":{"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":{}},"upsert_on":{"key":"email","values":["hello@example.com"]}},"info":{"version":"0.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 lead","description":{"content":"Upsert a lead. If the lead does not exist, it will be created. If the lead does exist, it will be updated.\nOnly supported for Salesforce.\n","type":"text/plain"},"url":{"path":["leads","_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 456dbf747..fc7019a3e 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.16.0","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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 69d90e67b..eca2a55af 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.16.0","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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 4dd16e388..4270060b1 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.16.0","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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 54b12671c..270bda7b6 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":{"description":"The email/message template to be used for this step. Only applicable for email or message steps.","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_email","manual_email","call","task","linkedin_send_message"],"description":"The type of the sequence state. Note: `linkedin_send_message` is undocumented in Outreach and subject to change.\n"},"task_note":{"type":"string","description":"An optional note to be attached to this step."},"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_email","task_note":"string","custom_fields":{}}},"info":{"version":"0.16.0","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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":{"description":"The email/message template to be used for this step. Only applicable for email or message steps.","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_email","manual_email","call","task","linkedin_send_message"],"description":"The type of the sequence state. Note: `linkedin_send_message` is undocumented in Outreach and subject to change.\n"},"task_note":{"type":"string","description":"An optional note to be attached to this step."},"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_email","task_note":"string","custom_fields":{}}},"info":{"version":"0.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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 edae0693e..18fc16491 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.16.0","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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 56fbe1e1d..4e83a00a6 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.16.0","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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 e66f17fb8..c9b5e5d45 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.16.0","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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 880ad9aeb..c8d756b39 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.16.0","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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 2fce8c211..9ed2df5bb 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.16.0","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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 1bbf38fd1..082323c6a 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.16.0","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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 59218ae7f..e368bc14d 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.16.0","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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 04090309a..b75b08435 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.16.0","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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 6b7d4857f..21555c0d6 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.16.0 +Version: 0.16.1 diff --git a/docs/docs/api/v2/engagement/update-account.api.mdx b/docs/docs/api/v2/engagement/update-account.api.mdx index dd0ece8d8..54b60ba76 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.16.0","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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 bf251e17f..f828764b9 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.16.0","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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 ec4f39f5d..601848463 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.16.0","title":"Unified Enrichment API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified 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.16.1","title":"Unified Enrichment API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified 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 c74ca54ff..5afdbbd2d 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.16.0 +Version: 0.16.1 diff --git a/docs/docs/api/v2/mgmt/connection-created.api.mdx b/docs/docs/api/v2/mgmt/connection-created.api.mdx index 8238cff04..3ca2d9d75 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","slack"],"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.16.0","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","slack"],"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.16.1","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 7b127a3f0..c020dd873 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","slack"],"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.16.0","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","slack"],"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.16.1","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 a6231c374..9871d188f 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","slack"],"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.16.0","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","slack"],"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.16.1","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 559815987..a89ad25f2 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":"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":"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.16.0","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":"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":"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.16.1","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 c5992cf95..ef38de200 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: {"deprecated":true,"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.16.0","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: {"deprecated":true,"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.16.1","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 feaed6470..9a4cdba39 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","slack"],"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","slack"],"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.16.0","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","slack"],"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","slack"],"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.16.1","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 603842cc7..7ceb76530 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","slack"],"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.16.0","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","slack"],"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.16.1","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 faafb34c2..73326171a 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: {"deprecated":true,"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.16.0","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: {"deprecated":true,"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.16.1","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 c4e7e556a..95364ea84 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.16.0","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.16.1","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 45f9809d6..742a62137 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.16.0","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.16.1","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 332bff32b..7844f2e1b 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.16.0","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.16.1","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 3ede773b6..0adfa4185 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","slack"],"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.16.0","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","slack"],"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.16.1","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 79d3ddefd..199e93e23 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: {"deprecated":true,"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.16.0","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: {"deprecated":true,"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.16.1","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 9153d6a6c..072bfbfa3 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: {"deprecated":true,"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.16.0","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: {"deprecated":true,"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.16.1","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 8e1f16f4f..77bb3f1f6 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.16.0","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.16.1","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 01e813d3f..4113f1432 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","slack"],"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.16.0","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","slack"],"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.16.1","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 8e3742f3d..4fa5538fc 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.16.0","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.16.1","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 4a8b23256..21a128b8e 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.16.0","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.16.1","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 71770a400..3e9b2c771 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: {"deprecated":true,"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.16.0","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: {"deprecated":true,"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.16.1","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 27c85e3d7..5dcbcd001 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: {"deprecated":true,"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.16.0","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: {"deprecated":true,"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.16.1","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 86c012119..8a10c2bf3 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: {"deprecated":true,"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.16.0","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: {"deprecated":true,"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.16.1","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 73042b723..18fbbdd7a 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":{"description":"An object to override the default Destination configuration per connection.","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"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"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.16.0","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":{"description":"An object to override the default Destination configuration per connection.","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"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"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.16.1","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 a6b2bda9c..d272360ea 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","slack"],"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.16.0","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","slack"],"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.16.1","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 cec99974e..b7292f4aa 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","slack"],"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.16.0","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","slack"],"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.16.1","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 9b5bf8f59..a4d911d3f 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","slack"],"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.16.0","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","slack"],"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.16.1","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 4711d9e2d..d6466b52f 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","slack"],"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.16.0","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","slack"],"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.16.1","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 6552f5a46..fa83a13a0 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":"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.16.0","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":"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.16.1","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 72be87e32..6e636e1c1 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":"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":"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.16.0","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":"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":"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.16.1","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 612d92632..c307b8668 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: {"deprecated":true,"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.16.0","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: {"deprecated":true,"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.16.1","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 e4a4f8fff..e642abf67 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: {"deprecated":true,"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.16.0","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: {"deprecated":true,"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.16.1","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 e95b2a9d7..daafd6cf7 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","slack"],"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.16.0","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","slack"],"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.16.1","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 e09edf913..3161e35dd 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.16.0","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.16.1","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 5e7ba9397..49da7914b 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","slack"],"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.16.0","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","slack"],"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.16.1","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 42ce5d129..e31e7247b 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","slack"],"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.16.0","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","slack"],"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.16.1","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 414dd01d0..1361934e1 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.16.0","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.16.1","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 3113226ca..8a18b6deb 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.16.0","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.16.1","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 fa080d4a0..fdb3c526b 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.16.0","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.16.1","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 a6d55266c..72f130d6f 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.16.0","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.16.1","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 1e9557ec3..bfbb15ad9 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"],"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","slack"],"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","slack"],"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.16.0","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"],"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","slack"],"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","slack"],"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.16.1","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 e667762e4..9eb28d6ed 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"],"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.16.0","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"],"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.16.1","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 77ae28aa4..c26d51aec 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.16.0","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.16.1","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 b26637428..c4c84eafa 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.16.0","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.16.1","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 eccc963d0..2b4600311 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.16.0 +Version: 0.16.1 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 0c1daab43..04b5fe086 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: {"deprecated":true,"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","slack"],"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.16.0","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: {"deprecated":true,"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","slack"],"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.16.1","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 e83fd15c1..232614fde 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: {"deprecated":true,"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","slack"],"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.16.0","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: {"deprecated":true,"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","slack"],"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.16.1","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 86a429179..82de64c9e 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.16.0","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.16.1","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 951155f20..e91e25575 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.16.0","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.16.1","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 70976f062..5fbf132bc 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.16.0","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.16.1","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 b6c6a5993..b3d71206c 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.16.0","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.16.1","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 02ea438d5..aae01de61 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.16.0","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.16.1","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 f1bdab983..ad253835b 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.16.0","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.16.1","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 7d3839ee0..f8e3b19b8 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","slack"],"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","slack"],"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.16.0","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","slack"],"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","slack"],"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.16.1","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 458b91938..c0568084f 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.16.0","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.16.1","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 50f08b5df..182d67df4 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":"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":"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.16.0","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":"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":"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.16.1","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 b8d09dff9..0db00c4c5 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: {"deprecated":true,"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.16.0","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: {"deprecated":true,"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.16.1","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 ed8712417..e6db9fe1e 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.16.0","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.16.1","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 e1d8f35f8..26879b06a 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","slack"],"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.16.0","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","slack"],"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.16.1","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 b5f9dae5c..e8a5a8687 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.16.0","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.16.1","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 9de0613da..b2800caa6 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.16.0","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.16.1","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 b828f75b2..25cecb901 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: "Use this to override SyncConfig and Destination configurations on sidebar_label: "Upsert connection sync config" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertConnectionSyncConfig","description":"Use this to override SyncConfig and Destination configurations on a per customer-connection basis. E.g. you can override the objects that are synced per customer-connection as well as override the table/collection that these objects are written into.","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":{"description":"An object to override the default Destination configuration per connection.","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"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"upsert_connection_sync_config"}}}},"responses":{"200":{"description":"Connection Sync Config","content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","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"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"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"},{"object":"Contact","table":"my_contacts"},{"object":"Contact","collection":"MyContacts"}],"custom_objects":[{"object":"Contact__c"},{"object":"Contact__c","table":"my_contacts"},{"object":"Contact__c","collection":"MyContacts"}]},"info":{"version":"0.16.0","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":{"content":"Use this to override SyncConfig and Destination configurations on a per customer-connection basis. E.g. you can override the objects that are synced per customer-connection as well as override the table/collection that these objects are written into.","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","description":"Use this to override SyncConfig and Destination configurations on a per customer-connection basis. E.g. you can override the objects that are synced per customer-connection as well as override the table/collection that these objects are written into.","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":{"description":"An object to override the default Destination configuration per connection.","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"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"upsert_connection_sync_config"}}}},"responses":{"200":{"description":"Connection Sync Config","content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","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"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"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"},{"object":"Contact","table":"my_contacts"},{"object":"Contact","collection":"MyContacts"}],"custom_objects":[{"object":"Contact__c"},{"object":"Contact__c","table":"my_contacts"},{"object":"Contact__c","collection":"MyContacts"}]},"info":{"version":"0.16.1","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":{"content":"Use this to override SyncConfig and Destination configurations on a per customer-connection basis. E.g. you can override the objects that are synced per customer-connection as well as override the table/collection that these objects are written into.","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 7afebaa7d..2bdd3135d 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","slack"],"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.16.0","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","slack"],"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.16.1","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 bb210da37..2df370972 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.16.0","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.16.1","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 663708a6f..25564636d 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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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-preview 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 85a291522..333222137 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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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-preview 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 5979fb1e1..732c9cc57 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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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-preview 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 38a4863d1..b6e4bcae8 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: ":::note" sidebar_label: "Get account" hide_title: true hide_table_of_contents: true -api: {"operationId":"getAccount","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Account object with the given id.\n","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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Account object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Account object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Account object with the given id.\n","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-preview 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 968e27611..aa5d751e8 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: ":::note" sidebar_label: "Get attachment" hide_title: true hide_table_of_contents: true -api: {"operationId":"getAttachment","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Attachment object with the given id.\n","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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Attachment object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Attachment object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Attachment object with the given id.\n","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-preview 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 a0e47fa7f..534799d38 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: ":::note" sidebar_label: "Get collection" hide_title: true hide_table_of_contents: true -api: {"operationId":"getCollection","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Collection object with the given id.\n","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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Collection object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Collection object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Collection object with the given id.\n","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-preview 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 ddab90b37..0ec60dd19 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: ":::note" sidebar_label: "Get contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"getContact","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Contact object with the given id.\n","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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Contact object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Contact object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Contact object with the given id.\n","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-preview 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 0d84e3b02..f7de11013 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: ":::note" sidebar_label: "Get tag" hide_title: true hide_table_of_contents: true -api: {"operationId":"getTag","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Tag object with the given id.\n","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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Tag object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Tag object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Tag object with the given id.\n","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-preview 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 252a912f0..61b795937 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: ":::note" sidebar_label: "Get team" hide_title: true hide_table_of_contents: true -api: {"operationId":"getTeam","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Team object with the given id.\n","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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Team object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Team object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Team object with the given id.\n","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-preview 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 a546f2c8d..e5647c077 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: ":::note" sidebar_label: "Get ticket" hide_title: true hide_table_of_contents: true -api: {"operationId":"getTicket","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Ticket object with the given id.\n","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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Ticket object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Ticket object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Ticket object with the given id.\n","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-preview 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 9f67db455..da595ccdc 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: ":::note" sidebar_label: "Get user" hide_title: true hide_table_of_contents: true -api: {"operationId":"getUser","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a User object with the given id.\n","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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a User object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a User object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a User object with the given id.\n","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-preview 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 8cedf46b4..38cd2a567 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: ":::note" sidebar_label: "List accounts" hide_title: true hide_table_of_contents: true -api: {"operationId":"listAccounts","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Account objects.\n","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"]},"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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Account objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Account objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Account objects.\n","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-preview 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 7bd18f674..fe255b902 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: ":::note" sidebar_label: "List attachments" hide_title: true hide_table_of_contents: true -api: {"operationId":"listAttachments","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Attachment objects.\n","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"]},"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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Attachment objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Attachment objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Attachment objects.\n","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-preview 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 894bca5b3..3cd0d4f4b 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: ":::note" sidebar_label: "List collection users" hide_title: true hide_table_of_contents: true -api: {"operationId":"listCollectionUsers","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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"]},"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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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-preview 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 097390cda..d106771ea 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: ":::note" sidebar_label: "List collections" hide_title: true hide_table_of_contents: true -api: {"operationId":"listCollections","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Collection objects.\n","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"]},"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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Collection objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Collection objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Collection objects.\n","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-preview 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 511d7a8d4..ae7ea1b45 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: ":::note" sidebar_label: "List comments" hide_title: true hide_table_of_contents: true -api: {"operationId":"listComments","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Comment objects.\n","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"]},"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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Comment objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Comment objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Comment objects.\n","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-preview 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 4e7e9f784..dd205966d 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: ":::note" sidebar_label: "List contacts" hide_title: true hide_table_of_contents: true -api: {"operationId":"listContacts","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Contact objects.\n","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"]},"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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Contact objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Contact objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Contact objects.\n","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-preview 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 841c89c40..25c7f287e 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: ":::note" sidebar_label: "List tags" hide_title: true hide_table_of_contents: true -api: {"operationId":"listTags","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Tag objects.\n","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"]},"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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Tag objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Tag objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Tag objects.\n","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-preview 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 a9222e024..227bbdba0 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: ":::note" sidebar_label: "List teams" hide_title: true hide_table_of_contents: true -api: {"operationId":"listTeams","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Team objects.\n","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"]},"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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Team objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Team objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Team objects.\n","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-preview 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 06672c7dd..2accdd0cc 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: ":::note" sidebar_label: "List tickets" hide_title: true hide_table_of_contents: true -api: {"operationId":"listTickets","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Ticket objects.\n","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"]},"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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Ticket objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Ticket objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Ticket objects.\n","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-preview 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 1aef23aff..f08e37ef4 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: ":::note" sidebar_label: "List users" hide_title: true hide_table_of_contents: true -api: {"operationId":"listUsers","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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"]},"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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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-preview custom_edit_url: null diff --git a/docs/docs/api/v2/ticketing/unified-ticketing-api-preview.info.mdx b/docs/docs/api/v2/ticketing/unified-ticketing-api-preview.info.mdx index 530be2dde..b3f187007 100644 --- a/docs/docs/api/v2/ticketing/unified-ticketing-api-preview.info.mdx +++ b/docs/docs/api/v2/ticketing/unified-ticketing-api-preview.info.mdx @@ -13,7 +13,7 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 0.16.0 +Version: 0.16.1 diff --git a/docs/docs/api/v2/ticketing/update-ticket.api.mdx b/docs/docs/api/v2/ticketing/update-ticket.api.mdx index fc5b60ae3..f4e3f75c3 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.16.0","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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-preview custom_edit_url: null diff --git a/docs/package.json b/docs/package.json index 6db99bdf7..4fe1f4d72 100644 --- a/docs/package.json +++ b/docs/package.json @@ -1,6 +1,6 @@ { "name": "docs", - "version": "0.16.0", + "version": "0.16.1", "private": true, "scripts": { "docusaurus": "docusaurus", diff --git a/docs/versioned_docs/version-0.15.2/api/introduction.mdx b/docs/versioned_docs/version-0.16.1/api/introduction.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/introduction.mdx rename to docs/versioned_docs/version-0.16.1/api/introduction.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/actions/actions-api.info.mdx b/docs/versioned_docs/version-0.16.1/api/v2/actions/actions-api.info.mdx similarity index 98% rename from docs/versioned_docs/version-0.15.2/api/v2/actions/actions-api.info.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/actions/actions-api.info.mdx index 751c07e43..a32285822 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/actions/actions-api.info.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2 +Version: 0.16.1 diff --git a/docs/versioned_docs/version-0.15.2/api/v2/actions/passthrough.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/actions/passthrough.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/actions/passthrough.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/actions/passthrough.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/actions/send-passthrough-request.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/actions/send-passthrough-request.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/actions/send-passthrough-request.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/actions/send-passthrough-request.api.mdx index feb653783..3b53a0a6c 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/actions/send-passthrough-request.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/actions/sidebar.js b/docs/versioned_docs/version-0.16.1/api/v2/actions/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/actions/sidebar.js rename to docs/versioned_docs/version-0.16.1/api/v2/actions/sidebar.js diff --git a/docs/versioned_docs/version-0.15.2/api/v2/crm/accounts.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/accounts.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/accounts.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/accounts.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/crm/contacts.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/contacts.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/contacts.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/contacts.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/crm/create-account.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/create-account.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/create-account.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/create-account.api.mdx index 0f71b9ed9..02bbc9e67 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/create-account.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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/versioned_docs/version-0.15.2/api/v2/crm/create-contact.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/create-contact.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/create-contact.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/create-contact.api.mdx index 05cc7a65d..eeae097d5 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/create-contact.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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/versioned_docs/version-0.15.2/api/v2/crm/create-lead.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/create-lead.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/create-lead.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/create-lead.api.mdx index a8fa4be48..b4f13c39c 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/create-lead.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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/versioned_docs/version-0.15.2/api/v2/crm/create-opportunity.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/create-opportunity.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/create-opportunity.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/create-opportunity.api.mdx index 7de11bd08..2d7b87698 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/create-opportunity.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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/versioned_docs/version-0.15.2/api/v2/crm/get-account.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/get-account.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/get-account.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/get-account.api.mdx index afb02875b..49598e74b 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/get-account.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.15.2/api/v2/crm/get-contact.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/get-contact.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/get-contact.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/get-contact.api.mdx index 477934b0a..14c7ebd35 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/get-contact.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.15.2/api/v2/crm/get-lead.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/get-lead.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/get-lead.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/get-lead.api.mdx index 61235fc1f..8ab47b2a0 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/get-lead.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.15.2/api/v2/crm/get-opportunity.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/get-opportunity.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/get-opportunity.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/get-opportunity.api.mdx index ace818f1f..5a36edb62 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/get-opportunity.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.15.2/api/v2/crm/get-user.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/get-user.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/get-user.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/get-user.api.mdx index c09a68d95..87c63c6ae 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/get-user.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.15.2/api/v2/crm/leads.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/leads.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/leads.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/leads.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/crm/list-accounts.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/list-accounts.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/list-accounts.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/list-accounts.api.mdx index af602b011..55f0a42fd 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/list-accounts.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/crm/list-accounts.api.mdx @@ -5,7 +5,7 @@ description: "List accounts" sidebar_label: "List accounts" hide_title: true hide_table_of_contents: true -api: {"operationId":"listAccounts","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":"read_from_cache","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n"},{"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":"Paginated Accounts","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"],"title":"pagination"},"records":{"type":"array","items":{"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"}}},"required":["pagination","records"]}}}}},"description":"List accounts","method":"get","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"}},"info":{"version":"0.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List accounts","description":{"type":"text/plain"},"url":{"path":["accounts"],"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":""},{"disabled":false,"description":{"content":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n","type":"text/plain"},"key":"read_from_cache","value":""},{"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","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":"read_from_cache","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n"},{"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":"Paginated Accounts","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"],"title":"pagination"},"records":{"type":"array","items":{"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"}}},"required":["pagination","records"]}}}}},"description":"List accounts","method":"get","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"}},"info":{"version":"0.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List accounts","description":{"type":"text/plain"},"url":{"path":["accounts"],"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":""},{"disabled":false,"description":{"content":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n","type":"text/plain"},"key":"read_from_cache","value":""},{"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/crm/unified-crm-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/crm/list-contacts.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/list-contacts.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/list-contacts.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/list-contacts.api.mdx index 2d46a4da3..e32afdc65 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/list-contacts.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/crm/list-contacts.api.mdx @@ -5,7 +5,7 @@ description: "List contacts" sidebar_label: "List contacts" hide_title: true hide_table_of_contents: true -api: {"operationId":"listContacts","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":"read_from_cache","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n"},{"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":"Paginated Contacts","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"],"title":"pagination"},"records":{"type":"array","items":{"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"}}},"required":["pagination","records"]}}}}},"description":"List contacts","method":"get","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"}},"info":{"version":"0.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List contacts","description":{"type":"text/plain"},"url":{"path":["contacts"],"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":""},{"disabled":false,"description":{"content":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n","type":"text/plain"},"key":"read_from_cache","value":""},{"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","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":"read_from_cache","in":"query","schema":{"type":"boolean","example":true},"description":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n"},{"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":"Paginated Contacts","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"],"title":"pagination"},"records":{"type":"array","items":{"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"}}},"required":["pagination","records"]}}}}},"description":"List contacts","method":"get","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"}},"info":{"version":"0.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List contacts","description":{"type":"text/plain"},"url":{"path":["contacts"],"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":""},{"disabled":false,"description":{"content":"Whether to read from Supaglue's Managed Destination cache or to read directly from the provider. \n\n\n**NOTE**: `read_from_cache=true` requires you to use the Supaglue Managed Destination and select [Common Objects](https://docs.supaglue.com/platform/common-schemas/overview#configuration) to be synced.\n","type":"text/plain"},"key":"read_from_cache","value":""},{"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/crm/unified-crm-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/crm/list-list-memberships.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/list-list-memberships.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/list-list-memberships.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/list-list-memberships.api.mdx index 962c7b5de..362a642aa 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/list-list-memberships.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/crm/list-list-memberships.api.mdx @@ -5,7 +5,7 @@ description: "Support:" sidebar_label: "List list memberships" hide_title: true hide_table_of_contents: true -api: {"operationId":"listListMemberships","description":"Support:\n\n| Provider | Object | Common Schema support | Notes |\n| ---------- | ------------------------------------------- | --------------------- | ------------------------------------- |\n| Hubspot | `contact` | Yes | Raw data response from V3 API |\n| Salesforce | `contact`, `account`, `lead`, `opportunity` | Yes | Raw data response from V57.0 REST API |\n","tags":["Lists"],"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":"object_type","in":"query","schema":{"type":"string","enum":["contact","account","opportunity","lead"],"example":"contact"},"description":"The Supaglue common object type to fetch a list for.","required":true},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"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":"list_id","in":"path","required":true,"schema":{"type":"string","example":"220e715a-0cbc-4d2d-8420-cd729f12f094"}}],"responses":{"200":{"description":"List membership","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"],"title":"pagination"},"records":{"type":"array","items":{"oneOf":[{"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"},{"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"},{"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"},{"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"}],"title":"list_membership"}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"00BDn00000RHS32MAH","description":"The provider-specific unique identifier for this list."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"RecentlyViewedContacts","description":"The developer name of this list."},"label":{"type":"string","example":"Recently Viewed Contacts","description":"The label for this list."},"raw_data":{"type":"object","description":"The raw data from the provider for this list.","additionalProperties":true,"example":{"attributes":{"type":"ListView","url":"/services/data/v57.0/sobjects/ListView/00BDn00000RHS32MAH"},"Id":"00BDn00000RHS32MAH","Name":"Recently Viewed Contacts","DeveloperName":"RecentlyViewedContacts","NamespacePrefix":null,"SobjectType":"Contact","IsSoqlCompatible":true,"CreatedDate":"2023-05-26T22:25:47.000+0000","CreatedById":"005Dn0000079fN6IAI","LastModifiedDate":"2023-05-26T22:25:47.000+0000","LastModifiedById":"005Dn0000079fN6IAI","SystemModstamp":"2023-05-26T22:25:47.000+0000","LastViewedDate":null,"LastReferencedDate":null}}},"required":["id","object_type","name","label","raw_data"],"title":"list_metadata","description":"Metadata about the remote provider list view."}},"required":["pagination","records","metadata"]}}}}},"method":"get","path":"/lists/{list_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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List list memberships","description":{"content":"Support:\n\n| Provider | Object | Common Schema support | Notes |\n| ---------- | ------------------------------------------- | --------------------- | ------------------------------------- |\n| Hubspot | `contact` | Yes | Raw data response from V3 API |\n| Salesforce | `contact`, `account`, `lead`, `opportunity` | Yes | Raw data response from V57.0 REST API |\n","type":"text/plain"},"url":{"path":["lists",":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":""},{"disabled":false,"description":{"content":"(Required) The Supaglue common object type to fetch a list for.","type":"text/plain"},"key":"object_type","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"list_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":"listListMemberships","description":"Support:\n\n| Provider | Object | Common Schema support | Notes |\n| ---------- | ------------------------------------------- | --------------------- | ------------------------------------- |\n| Hubspot | `contact` | Yes | Raw data response from V3 API |\n| Salesforce | `contact`, `account`, `lead`, `opportunity` | Yes | Raw data response from V57.0 REST API |\n","tags":["Lists"],"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":"object_type","in":"query","schema":{"type":"string","enum":["contact","account","opportunity","lead"],"example":"contact"},"description":"The Supaglue common object type to fetch a list for.","required":true},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"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":"list_id","in":"path","required":true,"schema":{"type":"string","example":"220e715a-0cbc-4d2d-8420-cd729f12f094"}}],"responses":{"200":{"description":"List membership","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"],"title":"pagination"},"records":{"type":"array","items":{"oneOf":[{"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"},{"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"},{"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"},{"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"}],"title":"list_membership"}},"metadata":{"type":"object","properties":{"id":{"type":"string","example":"00BDn00000RHS32MAH","description":"The provider-specific unique identifier for this list."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"RecentlyViewedContacts","description":"The developer name of this list."},"label":{"type":"string","example":"Recently Viewed Contacts","description":"The label for this list."},"raw_data":{"type":"object","description":"The raw data from the provider for this list.","additionalProperties":true,"example":{"attributes":{"type":"ListView","url":"/services/data/v57.0/sobjects/ListView/00BDn00000RHS32MAH"},"Id":"00BDn00000RHS32MAH","Name":"Recently Viewed Contacts","DeveloperName":"RecentlyViewedContacts","NamespacePrefix":null,"SobjectType":"Contact","IsSoqlCompatible":true,"CreatedDate":"2023-05-26T22:25:47.000+0000","CreatedById":"005Dn0000079fN6IAI","LastModifiedDate":"2023-05-26T22:25:47.000+0000","LastModifiedById":"005Dn0000079fN6IAI","SystemModstamp":"2023-05-26T22:25:47.000+0000","LastViewedDate":null,"LastReferencedDate":null}}},"required":["id","object_type","name","label","raw_data"],"title":"list_metadata","description":"Metadata about the remote provider list view."}},"required":["pagination","records","metadata"]}}}}},"method":"get","path":"/lists/{list_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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List list memberships","description":{"content":"Support:\n\n| Provider | Object | Common Schema support | Notes |\n| ---------- | ------------------------------------------- | --------------------- | ------------------------------------- |\n| Hubspot | `contact` | Yes | Raw data response from V3 API |\n| Salesforce | `contact`, `account`, `lead`, `opportunity` | Yes | Raw data response from V57.0 REST API |\n","type":"text/plain"},"url":{"path":["lists",":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":""},{"disabled":false,"description":{"content":"(Required) The Supaglue common object type to fetch a list for.","type":"text/plain"},"key":"object_type","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"","key":"list_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.15.2/api/v2/crm/list-lists.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/list-lists.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/list-lists.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/list-lists.api.mdx index 11ec500f6..b49300722 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/list-lists.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/crm/list-lists.api.mdx @@ -5,7 +5,7 @@ description: "List lists" sidebar_label: "List lists" hide_title: true hide_table_of_contents: true -api: {"operationId":"listLists","tags":["Lists"],"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":"object_type","in":"query","schema":{"type":"string","enum":["contact","account","opportunity","lead"],"example":"contact"},"description":"The Supaglue common object type to fetch a list for.","required":true},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"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 Lists","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"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"00BDn00000RHS32MAH","description":"The provider-specific unique identifier for this list."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"RecentlyViewedContacts","description":"The developer name of this list."},"label":{"type":"string","example":"Recently Viewed Contacts","description":"The label for this list."},"raw_data":{"type":"object","description":"The raw data from the provider for this list.","additionalProperties":true,"example":{"attributes":{"type":"ListView","url":"/services/data/v57.0/sobjects/ListView/00BDn00000RHS32MAH"},"Id":"00BDn00000RHS32MAH","Name":"Recently Viewed Contacts","DeveloperName":"RecentlyViewedContacts","NamespacePrefix":null,"SobjectType":"Contact","IsSoqlCompatible":true,"CreatedDate":"2023-05-26T22:25:47.000+0000","CreatedById":"005Dn0000079fN6IAI","LastModifiedDate":"2023-05-26T22:25:47.000+0000","LastModifiedById":"005Dn0000079fN6IAI","SystemModstamp":"2023-05-26T22:25:47.000+0000","LastViewedDate":null,"LastReferencedDate":null}}},"required":["id","object_type","name","label","raw_data"],"title":"list_metadata"}}},"required":["pagination","records"]}}}}},"description":"List lists","method":"get","path":"/lists","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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List lists","description":{"type":"text/plain"},"url":{"path":["lists"],"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":""},{"disabled":false,"description":{"content":"(Required) The Supaglue common object type to fetch a list for.","type":"text/plain"},"key":"object_type","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":"listLists","tags":["Lists"],"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":"object_type","in":"query","schema":{"type":"string","enum":["contact","account","opportunity","lead"],"example":"contact"},"description":"The Supaglue common object type to fetch a list for.","required":true},{"name":"x-customer-id","in":"header","schema":{"type":"string","example":"my-customer-1"},"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 Lists","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"],"title":"pagination"},"records":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"00BDn00000RHS32MAH","description":"The provider-specific unique identifier for this list."},"object_type":{"type":"string","enum":["contact","account","lead","opportunity"]},"name":{"type":"string","example":"RecentlyViewedContacts","description":"The developer name of this list."},"label":{"type":"string","example":"Recently Viewed Contacts","description":"The label for this list."},"raw_data":{"type":"object","description":"The raw data from the provider for this list.","additionalProperties":true,"example":{"attributes":{"type":"ListView","url":"/services/data/v57.0/sobjects/ListView/00BDn00000RHS32MAH"},"Id":"00BDn00000RHS32MAH","Name":"Recently Viewed Contacts","DeveloperName":"RecentlyViewedContacts","NamespacePrefix":null,"SobjectType":"Contact","IsSoqlCompatible":true,"CreatedDate":"2023-05-26T22:25:47.000+0000","CreatedById":"005Dn0000079fN6IAI","LastModifiedDate":"2023-05-26T22:25:47.000+0000","LastModifiedById":"005Dn0000079fN6IAI","SystemModstamp":"2023-05-26T22:25:47.000+0000","LastViewedDate":null,"LastReferencedDate":null}}},"required":["id","object_type","name","label","raw_data"],"title":"list_metadata"}}},"required":["pagination","records"]}}}}},"description":"List lists","method":"get","path":"/lists","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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":"List lists","description":{"type":"text/plain"},"url":{"path":["lists"],"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":""},{"disabled":false,"description":{"content":"(Required) The Supaglue common object type to fetch a list for.","type":"text/plain"},"key":"object_type","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/crm/unified-crm-api custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/crm/lists.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/lists.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/lists.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/lists.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/crm/opportunities.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/opportunities.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/opportunities.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/opportunities.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/crm/passthrough.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/passthrough.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/passthrough.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/passthrough.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/crm/send-passthrough-request.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/send-passthrough-request.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/send-passthrough-request.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/send-passthrough-request.api.mdx index 862b9826a..15e38e692 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/send-passthrough-request.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.15.2/api/v2/crm/sidebar.js b/docs/versioned_docs/version-0.16.1/api/v2/crm/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/sidebar.js rename to docs/versioned_docs/version-0.16.1/api/v2/crm/sidebar.js diff --git a/docs/versioned_docs/version-0.15.2/api/v2/crm/unified-crm-api.info.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/unified-crm-api.info.mdx similarity index 98% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/unified-crm-api.info.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/unified-crm-api.info.mdx index 34cda3fb2..724ad25a1 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/unified-crm-api.info.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2 +Version: 0.16.1 diff --git a/docs/versioned_docs/version-0.15.2/api/v2/crm/update-account.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/update-account.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/update-account.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/update-account.api.mdx index 328e0e7dd..1d3d0706a 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/update-account.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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/versioned_docs/version-0.15.2/api/v2/crm/update-contact.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/update-contact.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/update-contact.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/update-contact.api.mdx index 33c9434ed..c38f74894 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/update-contact.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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/versioned_docs/version-0.15.2/api/v2/crm/update-lead.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/update-lead.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/update-lead.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/update-lead.api.mdx index 7b652771f..387f18a41 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/update-lead.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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/versioned_docs/version-0.15.2/api/v2/crm/update-opportunity.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/update-opportunity.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/update-opportunity.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/update-opportunity.api.mdx index be1259f73..6693716f4 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/update-opportunity.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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/versioned_docs/version-0.15.2/api/v2/crm/upsert-account.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/upsert-account.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/upsert-account.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/upsert-account.api.mdx index 500ca90bf..843e59a1b 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/upsert-account.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/crm/upsert-account.api.mdx @@ -5,7 +5,7 @@ description: "Upsert an account. If the account does not exist, it will be creat sidebar_label: "Upsert account" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertAccount","description":"Upsert an account. If the account does not exist, it will be created. If the account does exist, it will be updated.\nOnly supported for Salesforce and Hubspot.\n","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","website"],"description":"The key to upsert on. Only `website` is supported for Salesforce, while both `domain` and `website` are supported for Hubspot."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","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"}}}}}}},"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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":{"content":"Upsert an account. If the account does not exist, it will be created. If the account does exist, it will be updated.\nOnly supported for Salesforce and Hubspot.\n","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","description":"Upsert an account. If the account does not exist, it will be created. If the account does exist, it will be updated.\nOnly supported for Salesforce and Hubspot.\n","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","website"],"description":"The key to upsert on. Only `website` is supported for Salesforce, while both `domain` and `website` are supported for Hubspot."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","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"}}}}}}},"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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":{"content":"Upsert an account. If the account does not exist, it will be created. If the account does exist, it will be updated.\nOnly supported for Salesforce and Hubspot.\n","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/versioned_docs/version-0.15.2/api/v2/crm/upsert-contact.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/upsert-contact.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/upsert-contact.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/upsert-contact.api.mdx index 1ae8c381b..5530ad88a 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/upsert-contact.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/crm/upsert-contact.api.mdx @@ -5,7 +5,7 @@ description: "Upsert a contact. If the contact does not exist, it will be create sidebar_label: "Upsert contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertContact","description":"Upsert a contact. If the contact does not exist, it will be created. If the contact does exist, it will be updated.\nOnly supported for Salesforce, Hubspot, and Pipedrive.\n","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"],"description":"The key to upsert on. Only `email` is supported for all providers."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","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"}}}}}}},"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.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":{"content":"Upsert a contact. If the contact does not exist, it will be created. If the contact does exist, it will be updated.\nOnly supported for Salesforce, Hubspot, and Pipedrive.\n","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","description":"Upsert a contact. If the contact does not exist, it will be created. If the contact does exist, it will be updated.\nOnly supported for Salesforce, Hubspot, and Pipedrive.\n","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"],"description":"The key to upsert on. Only `email` is supported for all providers."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","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"}}}}}}},"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.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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":{"content":"Upsert a contact. If the contact does not exist, it will be created. If the contact does exist, it will be updated.\nOnly supported for Salesforce, Hubspot, and Pipedrive.\n","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/versioned_docs/version-0.15.2/api/v2/crm/upsert-lead.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/upsert-lead.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/upsert-lead.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/upsert-lead.api.mdx index 6f720bac7..b4ccd8d58 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/crm/upsert-lead.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/crm/upsert-lead.api.mdx @@ -5,7 +5,7 @@ description: "Upsert a lead. If the lead does not exist, it will be created. If sidebar_label: "Upsert lead" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertLead","description":"Upsert a lead. If the lead does not exist, it will be created. If the lead does exist, it will be updated.\nOnly supported for Salesforce.\n","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"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["email"],"description":"The key to upsert on. Only `email` is supported."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","items":{"type":"string","example":"hello@example.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"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"}}}}}}},"method":"post","path":"/leads/_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":{"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":{}},"upsert_on":{"key":"email","values":["hello@example.com"]}},"info":{"version":"0.15.2","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 lead","description":{"content":"Upsert a lead. If the lead does not exist, it will be created. If the lead does exist, it will be updated.\nOnly supported for Salesforce.\n","type":"text/plain"},"url":{"path":["leads","_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":"upsertLead","description":"Upsert a lead. If the lead does not exist, it will be created. If the lead does exist, it will be updated.\nOnly supported for Salesforce.\n","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"},"upsert_on":{"type":"object","properties":{"key":{"type":"string","enum":["email"],"description":"The key to upsert on. Only `email` is supported."},"values":{"type":"array","description":"The values to upsert on. If more than one value is provided, it will act as a logical OR. If more than one account is found that matches, then an error will be thrown.","items":{"type":"string","example":"hello@example.com"}}},"required":["key","values"]}},"required":["record","upsert_on"]}}}},"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"}}}}}}},"method":"post","path":"/leads/_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":{"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":{}},"upsert_on":{"key":"email","values":["hello@example.com"]}},"info":{"version":"0.16.1","title":"Unified CRM API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified API (CRM) documentation. 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 lead","description":{"content":"Upsert a lead. If the lead does not exist, it will be created. If the lead does exist, it will be updated.\nOnly supported for Salesforce.\n","type":"text/plain"},"url":{"path":["leads","_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/versioned_docs/version-0.15.2/api/v2/crm/users.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/crm/users.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/crm/users.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/crm/users.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/data/data-listing-api.info.mdx b/docs/versioned_docs/version-0.16.1/api/v2/data/data-listing-api.info.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/data/data-listing-api.info.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/data/data-listing-api.info.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/data/hubspot.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/data/hubspot.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/data/hubspot.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/data/hubspot.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/data/list-hubspot-companies.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/data/list-hubspot-companies.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/data/list-hubspot-companies.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/data/list-hubspot-companies.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/data/list-hubspot-contacts.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/data/list-hubspot-contacts.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/data/list-hubspot-contacts.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/data/list-hubspot-contacts.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/data/list-salesforce-accounts.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/data/list-salesforce-accounts.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/data/list-salesforce-accounts.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/data/list-salesforce-accounts.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/data/list-salesforce-contacts.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/data/list-salesforce-contacts.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/data/list-salesforce-contacts.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/data/list-salesforce-contacts.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/data/salesforce.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/data/salesforce.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/data/salesforce.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/data/salesforce.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/data/sidebar.js b/docs/versioned_docs/version-0.16.1/api/v2/data/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/data/sidebar.js rename to docs/versioned_docs/version-0.16.1/api/v2/data/sidebar.js diff --git a/docs/versioned_docs/version-0.15.2/api/v2/engagement/accounts.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/accounts.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/accounts.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/accounts.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/engagement/contacts.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/contacts.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/contacts.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/contacts.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/engagement/create-account.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/create-account.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/create-account.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/create-account.api.mdx index 474d7947a..50945c55d 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/create-account.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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/versioned_docs/version-0.15.2/api/v2/engagement/create-contact.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/create-contact.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/create-contact.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/create-contact.api.mdx index 7170b13b0..f799eab02 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/create-contact.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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/versioned_docs/version-0.15.2/api/v2/engagement/create-sequence-state.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/create-sequence-state.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/create-sequence-state.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/create-sequence-state.api.mdx index cedbe4a40..fe2caf674 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/create-sequence-state.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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/versioned_docs/version-0.15.2/api/v2/engagement/create-sequence-step.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/create-sequence-step.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/create-sequence-step.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/create-sequence-step.api.mdx index b7b665688..af8d6e02f 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/create-sequence-step.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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":{"description":"The email/message template to be used for this step. Only applicable for email or message steps.","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_email","manual_email","call","task","linkedin_send_message"],"description":"The type of the sequence state. Note: `linkedin_send_message` is undocumented in Outreach and subject to change.\n"},"task_note":{"type":"string","description":"An optional note to be attached to this step."},"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_email","task_note":"string","custom_fields":{}}},"info":{"version":"0.15.2","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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":{"description":"The email/message template to be used for this step. Only applicable for email or message steps.","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_email","manual_email","call","task","linkedin_send_message"],"description":"The type of the sequence state. Note: `linkedin_send_message` is undocumented in Outreach and subject to change.\n"},"task_note":{"type":"string","description":"An optional note to be attached to this step."},"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_email","task_note":"string","custom_fields":{}}},"info":{"version":"0.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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/versioned_docs/version-0.15.2/api/v2/engagement/create-sequence.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/create-sequence.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/create-sequence.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/create-sequence.api.mdx index 19a3be423..26760a8c2 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/create-sequence.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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/versioned_docs/version-0.15.2/api/v2/engagement/get-account.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/get-account.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/get-account.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/get-account.api.mdx index b55e438fc..a5e0d8f13 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/get-account.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.15.2/api/v2/engagement/get-contact.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/get-contact.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/get-contact.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/get-contact.api.mdx index deb4a45ec..68a93f3d3 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/get-contact.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.15.2/api/v2/engagement/get-mailbox.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/get-mailbox.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/get-mailbox.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/get-mailbox.api.mdx index 9cf82bf0f..ae1648baf 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/get-mailbox.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.15.2/api/v2/engagement/get-sequence-state.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/get-sequence-state.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/get-sequence-state.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/get-sequence-state.api.mdx index e429689ec..2230b8a1e 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/get-sequence-state.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.15.2/api/v2/engagement/get-sequence.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/get-sequence.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/get-sequence.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/get-sequence.api.mdx index 6c2d242d4..ec0d4096f 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/get-sequence.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.15.2/api/v2/engagement/get-user.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/get-user.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/get-user.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/get-user.api.mdx index 53a8e3a9b..02748ab92 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/get-user.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.15.2/api/v2/engagement/mailboxes.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/mailboxes.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/mailboxes.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/mailboxes.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/engagement/passthrough.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/passthrough.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/passthrough.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/passthrough.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/engagement/send-passthrough-request.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/send-passthrough-request.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/send-passthrough-request.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/send-passthrough-request.api.mdx index bf9b8aa7c..b20b248b0 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/send-passthrough-request.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.15.2/api/v2/engagement/sequence-states.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/sequence-states.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/sequence-states.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/sequence-states.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/engagement/sequences.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/sequences.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/sequences.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/sequences.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/engagement/sidebar.js b/docs/versioned_docs/version-0.16.1/api/v2/engagement/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/sidebar.js rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/sidebar.js diff --git a/docs/versioned_docs/version-0.15.2/api/v2/engagement/unified-engagement-api.info.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/unified-engagement-api.info.mdx similarity index 98% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/unified-engagement-api.info.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/unified-engagement-api.info.mdx index ccc1e12b7..712b1588b 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/unified-engagement-api.info.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2 +Version: 0.16.1 diff --git a/docs/versioned_docs/version-0.15.2/api/v2/engagement/update-account.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/update-account.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/update-account.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/update-account.api.mdx index 940ff5f2b..3911a9dd6 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/update-account.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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/versioned_docs/version-0.15.2/api/v2/engagement/update-contact.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/update-contact.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/update-contact.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/update-contact.api.mdx index 74e890956..432977333 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/engagement/update-contact.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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.16.1","title":"Unified Engagement API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\nWelcome to the Unified API (Engagement) documentation. 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/versioned_docs/version-0.15.2/api/v2/engagement/users.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/engagement/users.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/engagement/users.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/engagement/users.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/enrichment/enrich-person.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/enrichment/enrich-person.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/enrichment/enrich-person.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/enrichment/enrich-person.api.mdx index 8c3084a58..9d106acec 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/enrichment/enrich-person.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Enrichment API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified 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.16.1","title":"Unified Enrichment API","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":"#### Introduction\n\nWelcome to the Unified 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.15.2/api/v2/enrichment/persons.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/enrichment/persons.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/enrichment/persons.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/enrichment/persons.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/enrichment/sidebar.js b/docs/versioned_docs/version-0.16.1/api/v2/enrichment/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/enrichment/sidebar.js rename to docs/versioned_docs/version-0.16.1/api/v2/enrichment/sidebar.js diff --git a/docs/versioned_docs/version-0.15.2/api/v2/enrichment/unified-enrichment-api.info.mdx b/docs/versioned_docs/version-0.16.1/api/v2/enrichment/unified-enrichment-api.info.mdx similarity index 98% rename from docs/versioned_docs/version-0.15.2/api/v2/enrichment/unified-enrichment-api.info.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/enrichment/unified-enrichment-api.info.mdx index 158ff0938..199ac2e15 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/enrichment/unified-enrichment-api.info.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2 +Version: 0.16.1 diff --git a/docs/versioned_docs/version-0.15.2/api/v2/marketing-automation/forms.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/marketing-automation/forms.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/marketing-automation/forms.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/marketing-automation/forms.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/marketing-automation/get-form-fields.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/marketing-automation/get-form-fields.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/marketing-automation/get-form-fields.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/marketing-automation/get-form-fields.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/marketing-automation/list-forms.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/marketing-automation/list-forms.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/marketing-automation/list-forms.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/marketing-automation/list-forms.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/marketing-automation/sidebar.js b/docs/versioned_docs/version-0.16.1/api/v2/marketing-automation/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/marketing-automation/sidebar.js rename to docs/versioned_docs/version-0.16.1/api/v2/marketing-automation/sidebar.js diff --git a/docs/versioned_docs/version-0.15.2/api/v2/marketing-automation/submit-form.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/marketing-automation/submit-form.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/marketing-automation/submit-form.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/marketing-automation/submit-form.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/marketing-automation/unified-enrichment-api.info.mdx b/docs/versioned_docs/version-0.16.1/api/v2/marketing-automation/unified-enrichment-api.info.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/marketing-automation/unified-enrichment-api.info.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/marketing-automation/unified-enrichment-api.info.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/metadata/association-types.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/metadata/association-types.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/metadata/association-types.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/metadata/association-types.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/metadata/create-association-type.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/metadata/create-association-type.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/metadata/create-association-type.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/metadata/create-association-type.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/metadata/create-custom-object.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/metadata/create-custom-object.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/metadata/create-custom-object.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/metadata/create-custom-object.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/metadata/custom-objects.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/metadata/custom-objects.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/metadata/custom-objects.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/metadata/custom-objects.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/metadata/get-association-types.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/metadata/get-association-types.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/metadata/get-association-types.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/metadata/get-association-types.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/metadata/get-custom-object.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/metadata/get-custom-object.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/metadata/get-custom-object.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/metadata/get-custom-object.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/metadata/list-custom-objects.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/metadata/list-custom-objects.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/metadata/list-custom-objects.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/metadata/list-custom-objects.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/metadata/list-properties.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/metadata/list-properties.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/metadata/list-properties.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/metadata/list-properties.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/metadata/list-standard-objects.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/metadata/list-standard-objects.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/metadata/list-standard-objects.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/metadata/list-standard-objects.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/metadata/metadata-api.info.mdx b/docs/versioned_docs/version-0.16.1/api/v2/metadata/metadata-api.info.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/metadata/metadata-api.info.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/metadata/metadata-api.info.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/metadata/properties.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/metadata/properties.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/metadata/properties.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/metadata/properties.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/metadata/sidebar.js b/docs/versioned_docs/version-0.16.1/api/v2/metadata/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/metadata/sidebar.js rename to docs/versioned_docs/version-0.16.1/api/v2/metadata/sidebar.js diff --git a/docs/versioned_docs/version-0.15.2/api/v2/metadata/standard-objects.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/metadata/standard-objects.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/metadata/standard-objects.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/metadata/standard-objects.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/metadata/update-custom-object.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/metadata/update-custom-object.api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/metadata/update-custom-object.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/metadata/update-custom-object.api.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/connection-created.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/connection-created.api.mdx similarity index 98% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/connection-created.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/connection-created.api.mdx index 694d5c673..f9e13e07d 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/connection-created.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/connection-deleted.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/connection-deleted.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/connection-deleted.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/connection-deleted.api.mdx index e44fafbca..3728547f0 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/connection-deleted.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/connection-sync-configs.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/connection-sync-configs.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/connection-sync-configs.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/connection-sync-configs.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/connections.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/connections.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/connections.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/connections.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-connection.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/create-connection.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-connection.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/create-connection.api.mdx index b2358b63b..fc1501f7d 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-connection.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/create-destination.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/create-destination.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-destination.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/create-destination.api.mdx index eb14dd53b..b640f1942 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-destination.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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":"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":"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.15.2","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":"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":"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.16.1","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.15.2/api/v2/mgmt/create-entity.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/create-entity.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-entity.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/create-entity.api.mdx index a064c391a..484436354 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-entity.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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: {"deprecated":true,"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.15.2","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: {"deprecated":true,"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.16.1","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.15.2/api/v2/mgmt/create-magic-link.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/create-magic-link.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-magic-link.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/create-magic-link.api.mdx index f7d9c1674..6b879dee7 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-magic-link.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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","slack"],"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.15.2","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","slack"],"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","slack"],"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.16.1","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.15.2/api/v2/mgmt/create-provider.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/create-provider.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-provider.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/create-provider.api.mdx index 5bfe38736..f6a70ac87 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-provider.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/create-schema.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/create-schema.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-schema.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/create-schema.api.mdx index dde870236..56cf7622e 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-schema.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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: {"deprecated":true,"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.15.2","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: {"deprecated":true,"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.16.1","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.15.2/api/v2/mgmt/create-sync-config.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/create-sync-config.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-sync-config.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/create-sync-config.api.mdx index 0af688632..211fde48a 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/create-sync-config.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/customers.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/customers.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/customers.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/customers.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-connection-sync-config.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-connection-sync-config.api.mdx similarity index 98% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-connection-sync-config.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-connection-sync-config.api.mdx index db7662840..223b928e7 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-connection-sync-config.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/delete-connection.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-connection.api.mdx similarity index 98% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-connection.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-connection.api.mdx index 7b44485f5..9a7892579 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-connection.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/delete-customer.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-customer.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-customer.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-customer.api.mdx index 79eec9731..6271fcc18 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-customer.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/delete-entity-mapping.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-entity-mapping.api.mdx similarity index 98% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-entity-mapping.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-entity-mapping.api.mdx index 5c399f674..eb88bd456 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-entity-mapping.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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: {"deprecated":true,"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.15.2","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: {"deprecated":true,"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.16.1","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.15.2/api/v2/mgmt/delete-entity.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-entity.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-entity.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-entity.api.mdx index bdb7227fb..9be7df5da 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-entity.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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: {"deprecated":true,"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.15.2","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: {"deprecated":true,"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.16.1","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.15.2/api/v2/mgmt/delete-magic-link.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-magic-link.api.mdx similarity index 97% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-magic-link.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-magic-link.api.mdx index e1fb7675c..e900c8265 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-magic-link.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/delete-provider.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-provider.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-provider.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-provider.api.mdx index 75bd3e733..3393a5429 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-provider.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/delete-schema.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-schema.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-schema.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-schema.api.mdx index 4eb851942..143e290e2 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-schema.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/delete-sync-config.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-sync-config.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-sync-config.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/delete-sync-config.api.mdx index 0ccbd49c7..c442f5316 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/delete-sync-config.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/destinations.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/destinations.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/destinations.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/destinations.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/entities.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/entities.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/entities.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/entities.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/entity-entity-mapping-created.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/entity-entity-mapping-created.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/entity-entity-mapping-created.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/entity-entity-mapping-created.api.mdx index 6f809266c..094e46c55 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/entity-entity-mapping-created.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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: {"deprecated":true,"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.15.2","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: {"deprecated":true,"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.16.1","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.15.2/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx index 8d28d37d3..1de822990 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/entity-entity-mapping-deleted.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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: {"deprecated":true,"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.15.2","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: {"deprecated":true,"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.16.1","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.15.2/api/v2/mgmt/entity-entity-mapping-updated.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/entity-entity-mapping-updated.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/entity-entity-mapping-updated.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/entity-entity-mapping-updated.api.mdx index cec7262af..56e29832e 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/entity-entity-mapping-updated.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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: {"deprecated":true,"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.15.2","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: {"deprecated":true,"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.16.1","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.15.2/api/v2/mgmt/entity-mappings.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/entity-mappings.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/entity-mappings.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/entity-mappings.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-connection-sync-config.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-connection-sync-config.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-connection-sync-config.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-connection-sync-config.api.mdx index 1158b6b30..4c1de4ed6 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-connection-sync-config.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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":{"description":"An object to override the default Destination configuration per connection.","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"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"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.15.2","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":{"description":"An object to override the default Destination configuration per connection.","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"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"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.16.1","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/versioned_docs/version-0.15.2/api/v2/mgmt/get-connection.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-connection.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-connection.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-connection.api.mdx index 423e04c75..18934752d 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-connection.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/get-connections.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-connections.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-connections.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-connections.api.mdx index 84b07654e..3eff551bd 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-connections.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/get-customer.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-customer.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-customer.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-customer.api.mdx index 3c91fa39a..6afbc7118 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-customer.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/get-customers.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-customers.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-customers.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-customers.api.mdx index 9b088205e..705e1d66f 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-customers.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/get-destination.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-destination.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-destination.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-destination.api.mdx index 7026e0a3b..aeb76cda3 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-destination.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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":"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.15.2","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":"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.16.1","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.15.2/api/v2/mgmt/get-destinations.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-destinations.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-destinations.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-destinations.api.mdx index db08bcb6b..09d39114f 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-destinations.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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":"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":"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.15.2","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":"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":"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.16.1","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.15.2/api/v2/mgmt/get-entities.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-entities.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-entities.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-entities.api.mdx index 842a3792f..94001e3f7 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-entities.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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: {"deprecated":true,"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.15.2","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: {"deprecated":true,"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.16.1","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.15.2/api/v2/mgmt/get-entity.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-entity.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-entity.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-entity.api.mdx index f166d347b..9b2b96c36 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-entity.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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: {"deprecated":true,"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.15.2","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: {"deprecated":true,"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.16.1","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.15.2/api/v2/mgmt/get-magic-links.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-magic-links.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-magic-links.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-magic-links.api.mdx index f9852b70e..17aa43212 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-magic-links.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/get-provider-user-id.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-provider-user-id.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-provider-user-id.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-provider-user-id.api.mdx index f8e4f3d82..360cbc0dc 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-provider-user-id.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/get-provider.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-provider.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-provider.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-provider.api.mdx index 9fc58ed6d..7518d82b8 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-provider.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/get-providers.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-providers.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-providers.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-providers.api.mdx index bc804359f..cbd706fce 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-providers.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/get-schema.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-schema.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-schema.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-schema.api.mdx index 9b12b995b..ae5822f68 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-schema.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/get-schemas.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-schemas.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-schemas.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-schemas.api.mdx index 5deed4b15..14640bfab 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-schemas.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/get-sync-config.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-sync-config.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-sync-config.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-sync-config.api.mdx index 5ca4eb7a2..f77908fc7 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-sync-config.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/get-sync-configs.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-sync-configs.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-sync-configs.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-sync-configs.api.mdx index 635612dc8..9e69bcd61 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-sync-configs.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/get-sync-runs.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-sync-runs.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-sync-runs.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-sync-runs.api.mdx index 46593083c..fcdfb4c51 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-sync-runs.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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"],"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","slack"],"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","slack"],"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.15.2","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"],"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","slack"],"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","slack"],"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.16.1","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.15.2/api/v2/mgmt/get-syncs.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-syncs.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-syncs.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/get-syncs.api.mdx index 152a5eaf8..a1d59a115 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/get-syncs.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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"],"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.15.2","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"],"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.16.1","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.15.2/api/v2/mgmt/list-entity-mappings.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/list-entity-mappings.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/list-entity-mappings.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/list-entity-mappings.api.mdx index ec567dbbf..4637c11d3 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/list-entity-mappings.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/list-field-mappings.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/list-field-mappings.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/list-field-mappings.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/list-field-mappings.api.mdx index 3a10351e9..a0182a409 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/list-field-mappings.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/magic-links.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/magic-links.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/magic-links.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/magic-links.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/management-api.info.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/management-api.info.mdx similarity index 98% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/management-api.info.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/management-api.info.mdx index 2fa653c82..8290ea4b3 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/management-api.info.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2 +Version: 0.16.1 diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/object-field-mapping-created.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/object-field-mapping-created.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/object-field-mapping-created.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/object-field-mapping-created.api.mdx index 82ab5afa2..a356aebdc 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/object-field-mapping-created.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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: {"deprecated":true,"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","slack"],"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.15.2","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: {"deprecated":true,"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","slack"],"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.16.1","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.15.2/api/v2/mgmt/object-field-mapping-updated.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/object-field-mapping-updated.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/object-field-mapping-updated.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/object-field-mapping-updated.api.mdx index 03876ade1..9b2a4f18d 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/object-field-mapping-updated.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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: {"deprecated":true,"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","slack"],"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.15.2","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: {"deprecated":true,"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","slack"],"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.16.1","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.15.2/api/v2/mgmt/pause-sync.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/pause-sync.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/pause-sync.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/pause-sync.api.mdx index cc0de4c3b..7a8d0d5eb 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/pause-sync.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/providers.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/providers.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/providers.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/providers.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/resume-sync.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/resume-sync.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/resume-sync.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/resume-sync.api.mdx index a8f9e1627..c23388446 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/resume-sync.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/salesforce-cdc-create.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/salesforce-cdc-create.api.mdx similarity index 98% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/salesforce-cdc-create.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/salesforce-cdc-create.api.mdx index 6e88b844f..b05181b25 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/salesforce-cdc-create.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/salesforce-cdc-delete.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/salesforce-cdc-delete.api.mdx similarity index 98% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/salesforce-cdc-delete.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/salesforce-cdc-delete.api.mdx index 145005780..fc4cd6adf 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/salesforce-cdc-delete.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/salesforce-cdc-undelete.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/salesforce-cdc-undelete.api.mdx similarity index 98% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/salesforce-cdc-undelete.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/salesforce-cdc-undelete.api.mdx index 5190e88b1..ef73dd61c 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/salesforce-cdc-undelete.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/salesforce-cdc-update.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/salesforce-cdc-update.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/salesforce-cdc-update.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/salesforce-cdc-update.api.mdx index 981a193b5..5bb3bd5b4 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/salesforce-cdc-update.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/schema-mappings.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/schema-mappings.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/schema-mappings.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/schema-mappings.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/schemas.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/schemas.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/schemas.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/schemas.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/sidebar.js b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/sidebar.js rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/sidebar.js diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/sync-complete.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/sync-complete.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/sync-complete.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/sync-complete.api.mdx index 95bc6e291..73b454757 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/sync-complete.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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","slack"],"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.15.2","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","slack"],"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","slack"],"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.16.1","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.15.2/api/v2/mgmt/sync-configs.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/sync-configs.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/sync-configs.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/sync-configs.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/sync-runs.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/sync-runs.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/sync-runs.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/sync-runs.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/syncs.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/syncs.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/syncs.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/syncs.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/trigger-sync.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/trigger-sync.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/trigger-sync.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/trigger-sync.api.mdx index bc579ac8c..218e5232e 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/trigger-sync.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/update-destination.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/update-destination.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/update-destination.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/update-destination.api.mdx index 1fe75f2c7..7ea56fcb8 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/update-destination.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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":"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":"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.15.2","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":"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":"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.16.1","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.15.2/api/v2/mgmt/update-entity.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/update-entity.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/update-entity.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/update-entity.api.mdx index 5643f34db..1af27d5de 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/update-entity.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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: {"deprecated":true,"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.15.2","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: {"deprecated":true,"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.16.1","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.15.2/api/v2/mgmt/update-object-field-mappings.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/update-object-field-mappings.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/update-object-field-mappings.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/update-object-field-mappings.api.mdx index d17edd15e..cdd8d4ad8 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/update-object-field-mappings.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/update-provider.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/update-provider.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/update-provider.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/update-provider.api.mdx index b657036bc..491a99952 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/update-provider.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/update-schema.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/update-schema.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/update-schema.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/update-schema.api.mdx index 20c819c81..e28e55d93 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/update-schema.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/update-sync-config.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/update-sync-config.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/update-sync-config.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/update-sync-config.api.mdx index 0fd7d9823..7abb5165f 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/update-sync-config.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/mgmt/upsert-connection-sync-config.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/upsert-connection-sync-config.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/upsert-connection-sync-config.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/upsert-connection-sync-config.api.mdx index 2334c5ad6..4cfd542f6 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/upsert-connection-sync-config.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/upsert-connection-sync-config.api.mdx @@ -5,7 +5,7 @@ description: "Use this to override SyncConfig and Destination configurations on sidebar_label: "Upsert connection sync config" hide_title: true hide_table_of_contents: true -api: {"operationId":"upsertConnectionSyncConfig","description":"Use this to override SyncConfig and Destination configurations on a per customer-connection basis. E.g. you can override the objects that are synced per customer-connection as well as override the table/collection that these objects are written into.","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":{"description":"An object to override the default Destination configuration per connection.","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"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"upsert_connection_sync_config"}}}},"responses":{"200":{"description":"Connection Sync Config","content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","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"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"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"},{"object":"Contact","table":"my_contacts"},{"object":"Contact","collection":"MyContacts"}],"custom_objects":[{"object":"Contact__c"},{"object":"Contact__c","table":"my_contacts"},{"object":"Contact__c","collection":"MyContacts"}]},"info":{"version":"0.15.2","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":{"content":"Use this to override SyncConfig and Destination configurations on a per customer-connection basis. E.g. you can override the objects that are synced per customer-connection as well as override the table/collection that these objects are written into.","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","description":"Use this to override SyncConfig and Destination configurations on a per customer-connection basis. E.g. you can override the objects that are synced per customer-connection as well as override the table/collection that these objects are written into.","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":{"description":"An object to override the default Destination configuration per connection.","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"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"upsert_connection_sync_config"}}}},"responses":{"200":{"description":"Connection Sync Config","content":{"application/json":{"schema":{"type":"object","properties":{"destination_config":{"description":"An object to override the default Destination configuration per connection.","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"]},{"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nConfig specific to MongoDB destination\n","type":"object","title":"MongoDB (Preview)","properties":{"type":{"type":"string","enum":["mongodb"]},"collection":{"type":"string","description":"The collection you'd like to sync to. This collection must already exist. Supaglue will not create it. If not specified, the schema specified in the MongoDB Destination will be used.","example":"customer_1_schema"}},"required":["type","collection"]}]},"standard_objects":{"description":"A list of case-sensitive Provider standard objects to by synced. If specified, this list will take override the custom_objects list in SyncConfig.","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default collection used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}},"custom_objects":{"description":"(Preview) A list of case-sensitive Provider custom objects to be synced. If specified, this list will take override the custom_objects list in SyncConfig.\n","type":"array","items":{"oneOf":[{"type":"object","title":"All","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"}},"required":["object"]},{"type":"object","title":"Postgres/BigQuery (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"table":{"type":"string","description":"The table to write the object to. If specified, this will override the default table used by Supaglue.","example":"my_contacts"}},"required":["object","table"]},{"type":"object","title":"MongoDB (Preview)","properties":{"object":{"type":"string","description":"The Provider object name (case sensitive)","example":"Contact__c"},"collection":{"type":"string","description":"The collection to write the object to. If specified, this will override the default table used by Supaglue.","example":"MyContacts"}},"required":["object","collection"]}]}}},"title":"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"},{"object":"Contact","table":"my_contacts"},{"object":"Contact","collection":"MyContacts"}],"custom_objects":[{"object":"Contact__c"},{"object":"Contact__c","table":"my_contacts"},{"object":"Contact__c","collection":"MyContacts"}]},"info":{"version":"0.16.1","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":{"content":"Use this to override SyncConfig and Destination configurations on a per customer-connection basis. E.g. you can override the objects that are synced per customer-connection as well as override the table/collection that these objects are written into.","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/versioned_docs/version-0.15.2/api/v2/mgmt/upsert-customer.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/upsert-customer.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/upsert-customer.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/upsert-customer.api.mdx index d44f4ae99..2ebb616b2 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/upsert-customer.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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","slack"],"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.15.2","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","slack"],"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.16.1","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.15.2/api/v2/mgmt/upsert-entity-mapping.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/mgmt/upsert-entity-mapping.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/mgmt/upsert-entity-mapping.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/mgmt/upsert-entity-mapping.api.mdx index d61a58454..1a74b052f 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/mgmt/upsert-entity-mapping.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","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.16.1","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.15.2/api/v2/ticketing/accounts.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/accounts.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/accounts.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/accounts.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/attachments.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/attachments.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/attachments.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/attachments.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/collections.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/collections.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/collections.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/collections.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/comments.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/comments.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/comments.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/comments.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/contacts.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/contacts.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/contacts.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/contacts.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/create-attachment.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/create-attachment.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/create-attachment.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/create-attachment.api.mdx index 54346eeaa..8e1870575 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/create-attachment.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/create-comment.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/create-comment.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/create-comment.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/create-comment.api.mdx index f2b5e3132..16bb6e879 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/create-comment.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/create-ticket.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/create-ticket.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/create-ticket.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/create-ticket.api.mdx index a59b3c504..d8f295cd9 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/create-ticket.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-account.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-account.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-account.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-account.api.mdx index 69a9e939f..7e3925659 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-account.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-account.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get account" hide_title: true hide_table_of_contents: true -api: {"operationId":"getAccount","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Account object with the given id.\n","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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Account object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Account object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Account object with the given id.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-attachment.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-attachment.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-attachment.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-attachment.api.mdx index 37890ffe8..057a8dafc 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-attachment.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-attachment.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get attachment" hide_title: true hide_table_of_contents: true -api: {"operationId":"getAttachment","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Attachment object with the given id.\n","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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Attachment object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Attachment object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Attachment object with the given id.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-collection.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-collection.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-collection.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-collection.api.mdx index 6124579d3..a6b620f45 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-collection.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-collection.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get collection" hide_title: true hide_table_of_contents: true -api: {"operationId":"getCollection","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Collection object with the given id.\n","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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Collection object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Collection object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Collection object with the given id.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-contact.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-contact.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-contact.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-contact.api.mdx index 4e4064e43..86c60d820 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-contact.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-contact.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get contact" hide_title: true hide_table_of_contents: true -api: {"operationId":"getContact","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Contact object with the given id.\n","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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Contact object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Contact object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Contact object with the given id.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-tag.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-tag.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-tag.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-tag.api.mdx index 0f7201bd5..4d5a58f4d 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-tag.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-tag.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get tag" hide_title: true hide_table_of_contents: true -api: {"operationId":"getTag","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Tag object with the given id.\n","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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Tag object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Tag object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a Tag object with the given id.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-team.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-team.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-team.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-team.api.mdx index d1d2f6117..9e871c7c6 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-team.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-team.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get team" hide_title: true hide_table_of_contents: true -api: {"operationId":"getTeam","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Team object with the given id.\n","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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Team object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Team object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Team object with the given id.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-ticket.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-ticket.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-ticket.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-ticket.api.mdx index 5c5d739eb..a4e97f7b4 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-ticket.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-ticket.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get ticket" hide_title: true hide_table_of_contents: true -api: {"operationId":"getTicket","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Ticket object with the given id.\n","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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Ticket object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Ticket object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns an Ticket object with the given id.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-user.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-user.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-user.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-user.api.mdx index dbc27e95f..6655f5e5c 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/get-user.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/get-user.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "Get user" hide_title: true hide_table_of_contents: true -api: {"operationId":"getUser","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a User object with the given id.\n","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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a User object with the given id.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a User object with the given id.\n","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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a User object with the given id.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-accounts.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-accounts.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-accounts.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-accounts.api.mdx index d324f89ff..5f605bcd5 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-accounts.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-accounts.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List accounts" hide_title: true hide_table_of_contents: true -api: {"operationId":"listAccounts","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Account objects.\n","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"]},"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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Account objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Account objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Account objects.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-attachments.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-attachments.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-attachments.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-attachments.api.mdx index 95f553153..bce0fb0de 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-attachments.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-attachments.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List attachments" hide_title: true hide_table_of_contents: true -api: {"operationId":"listAttachments","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Attachment objects.\n","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"]},"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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Attachment objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Attachment objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Attachment objects.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-collection-users.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-collection-users.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-collection-users.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-collection-users.api.mdx index d8c801896..be007d343 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-collection-users.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-collection-users.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List collection users" hide_title: true hide_table_of_contents: true -api: {"operationId":"listCollectionUsers","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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"]},"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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-collections.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-collections.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-collections.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-collections.api.mdx index 79988ec68..99628106f 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-collections.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-collections.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List collections" hide_title: true hide_table_of_contents: true -api: {"operationId":"listCollections","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Collection objects.\n","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"]},"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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Collection objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Collection objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Collection objects.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-comments.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-comments.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-comments.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-comments.api.mdx index b543a765d..00e2d2662 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-comments.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-comments.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List comments" hide_title: true hide_table_of_contents: true -api: {"operationId":"listComments","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Comment objects.\n","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"]},"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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Comment objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Comment objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Comment objects.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-contacts.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-contacts.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-contacts.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-contacts.api.mdx index 1276ad439..9933d0506 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-contacts.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-contacts.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List contacts" hide_title: true hide_table_of_contents: true -api: {"operationId":"listContacts","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Contact objects.\n","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"]},"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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Contact objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Contact objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Contact objects.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-tags.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-tags.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-tags.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-tags.api.mdx index df8123782..6ec35dfb1 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-tags.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-tags.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List tags" hide_title: true hide_table_of_contents: true -api: {"operationId":"listTags","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Tag objects.\n","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"]},"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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Tag objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Tag objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Tag objects.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-teams.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-teams.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-teams.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-teams.api.mdx index 9c838f369..cca2e1411 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-teams.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-teams.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List teams" hide_title: true hide_table_of_contents: true -api: {"operationId":"listTeams","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Team objects.\n","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"]},"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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Team objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Team objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Team objects.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-tickets.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-tickets.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-tickets.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-tickets.api.mdx index 467f89606..06b5b4b08 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-tickets.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-tickets.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List tickets" hide_title: true hide_table_of_contents: true -api: {"operationId":"listTickets","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Ticket objects.\n","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"]},"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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Ticket objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Ticket objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of Ticket objects.\n","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-preview custom_edit_url: null @@ -44,4 +44,4 @@ Returns a list of Ticket objects. TicketsData
Schema
    pagination objectrequired
    records object[]required
  • Array [
  • ]
- \ No newline at end of file + diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-users.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-users.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-users.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-users.api.mdx index 5b88a386a..f69dc3561 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/list-users.api.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/list-users.api.mdx @@ -5,7 +5,7 @@ description: ":::note" sidebar_label: "List users" hide_title: true hide_table_of_contents: true -api: {"operationId":"listUsers","description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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"]},"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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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"]},"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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n\nReturns a list of User objects.\n","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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/sidebar.js b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/sidebar.js similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/sidebar.js rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/sidebar.js diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/tags.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/tags.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/tags.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/tags.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/teams.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/teams.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/teams.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/teams.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/tickets.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/tickets.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/tickets.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/tickets.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/unified-ticketing-api-preview.info.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/unified-ticketing-api-preview.info.mdx similarity index 98% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/unified-ticketing-api-preview.info.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/unified-ticketing-api-preview.info.mdx index c80de717d..2c27fe6f6 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/unified-ticketing-api-preview.info.mdx +++ b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/unified-ticketing-api-preview.info.mdx @@ -13,7 +13,7 @@ import SchemaTabs from "@theme/SchemaTabs"; import TabItem from "@theme/TabItem"; import Export from "@theme/ApiDemoPanel/Export"; -Version: 0.15.2 +Version: 0.16.1 diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/update-ticket.api.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/update-ticket.api.mdx similarity index 99% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/update-ticket.api.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/update-ticket.api.mdx index 8dd29e8ad..d544a2729 100644 --- a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/update-ticket.api.mdx +++ b/docs/versioned_docs/version-0.16.1/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.15.2","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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.16.1","title":"Unified Ticketing API (Preview)","contact":{"name":"Supaglue","email":"docs@supaglue.com","url":"https://supaglue.com"},"description":":::note\nThis feature is only available in Preview to select customers on our Enterprise plan. [Contact us](mailto:team@supaglue.com) for more information.\n:::\n#### Introduction\n\nWelcome to the Unified 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-preview custom_edit_url: null diff --git a/docs/versioned_docs/version-0.15.2/api/v2/ticketing/users.tag.mdx b/docs/versioned_docs/version-0.16.1/api/v2/ticketing/users.tag.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/api/v2/ticketing/users.tag.mdx rename to docs/versioned_docs/version-0.16.1/api/v2/ticketing/users.tag.mdx diff --git a/docs/versioned_docs/version-0.15.2/destinations/bigquery.md b/docs/versioned_docs/version-0.16.1/destinations/bigquery.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/destinations/bigquery.md rename to docs/versioned_docs/version-0.16.1/destinations/bigquery.md diff --git a/docs/versioned_docs/version-0.15.2/destinations/postgres.md b/docs/versioned_docs/version-0.16.1/destinations/postgres.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/destinations/postgres.md rename to docs/versioned_docs/version-0.16.1/destinations/postgres.md diff --git a/docs/versioned_docs/version-0.15.2/integration-patterns/managed-syncs.mdx b/docs/versioned_docs/version-0.16.1/integration-patterns/managed-syncs.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/integration-patterns/managed-syncs.mdx rename to docs/versioned_docs/version-0.16.1/integration-patterns/managed-syncs.mdx diff --git a/docs/versioned_docs/version-0.15.2/integration-patterns/unified-api.mdx b/docs/versioned_docs/version-0.16.1/integration-patterns/unified-api.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/integration-patterns/unified-api.mdx rename to docs/versioned_docs/version-0.16.1/integration-patterns/unified-api.mdx diff --git a/docs/versioned_docs/version-0.15.2/intro.md b/docs/versioned_docs/version-0.16.1/intro.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/intro.md rename to docs/versioned_docs/version-0.16.1/intro.md diff --git a/docs/versioned_docs/version-0.15.2/platform/common-schemas/crm.md b/docs/versioned_docs/version-0.16.1/platform/common-schemas/crm.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/platform/common-schemas/crm.md rename to docs/versioned_docs/version-0.16.1/platform/common-schemas/crm.md diff --git a/docs/versioned_docs/version-0.15.2/platform/common-schemas/engagement.md b/docs/versioned_docs/version-0.16.1/platform/common-schemas/engagement.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/platform/common-schemas/engagement.md rename to docs/versioned_docs/version-0.16.1/platform/common-schemas/engagement.md diff --git a/docs/versioned_docs/version-0.15.2/platform/common-schemas/enrichment.md b/docs/versioned_docs/version-0.16.1/platform/common-schemas/enrichment.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/platform/common-schemas/enrichment.md rename to docs/versioned_docs/version-0.16.1/platform/common-schemas/enrichment.md diff --git a/docs/versioned_docs/version-0.15.2/platform/common-schemas/overview.mdx b/docs/versioned_docs/version-0.16.1/platform/common-schemas/overview.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/platform/common-schemas/overview.mdx rename to docs/versioned_docs/version-0.16.1/platform/common-schemas/overview.mdx diff --git a/docs/versioned_docs/version-0.15.2/platform/common-schemas/ticketing.md b/docs/versioned_docs/version-0.16.1/platform/common-schemas/ticketing.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/platform/common-schemas/ticketing.md rename to docs/versioned_docs/version-0.16.1/platform/common-schemas/ticketing.md diff --git a/docs/versioned_docs/version-0.15.2/platform/managed-auth.mdx b/docs/versioned_docs/version-0.16.1/platform/managed-auth.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/platform/managed-auth.mdx rename to docs/versioned_docs/version-0.16.1/platform/managed-auth.mdx diff --git a/docs/versioned_docs/version-0.15.2/platform/notification-webhooks.md b/docs/versioned_docs/version-0.16.1/platform/notification-webhooks.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/platform/notification-webhooks.md rename to docs/versioned_docs/version-0.16.1/platform/notification-webhooks.md diff --git a/docs/versioned_docs/version-0.15.2/platform/objects/overview.mdx b/docs/versioned_docs/version-0.16.1/platform/objects/overview.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/platform/objects/overview.mdx rename to docs/versioned_docs/version-0.16.1/platform/objects/overview.mdx diff --git a/docs/versioned_docs/version-0.15.2/platform/overview.md b/docs/versioned_docs/version-0.16.1/platform/overview.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/platform/overview.md rename to docs/versioned_docs/version-0.16.1/platform/overview.md diff --git a/docs/versioned_docs/version-0.15.2/platform/passthrough.md b/docs/versioned_docs/version-0.16.1/platform/passthrough.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/platform/passthrough.md rename to docs/versioned_docs/version-0.16.1/platform/passthrough.md diff --git a/docs/versioned_docs/version-0.15.2/providers/6sense.md b/docs/versioned_docs/version-0.16.1/providers/6sense.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/6sense.md rename to docs/versioned_docs/version-0.16.1/providers/6sense.md diff --git a/docs/versioned_docs/version-0.15.2/providers/amplitude.md b/docs/versioned_docs/version-0.16.1/providers/amplitude.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/amplitude.md rename to docs/versioned_docs/version-0.16.1/providers/amplitude.md diff --git a/docs/versioned_docs/version-0.15.2/providers/apollo.md b/docs/versioned_docs/version-0.16.1/providers/apollo.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/apollo.md rename to docs/versioned_docs/version-0.16.1/providers/apollo.md diff --git a/docs/versioned_docs/version-0.15.2/providers/asana.md b/docs/versioned_docs/version-0.16.1/providers/asana.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/asana.md rename to docs/versioned_docs/version-0.16.1/providers/asana.md diff --git a/docs/versioned_docs/version-0.15.2/providers/box.md b/docs/versioned_docs/version-0.16.1/providers/box.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/box.md rename to docs/versioned_docs/version-0.16.1/providers/box.md diff --git a/docs/versioned_docs/version-0.15.2/providers/chargebee.md b/docs/versioned_docs/version-0.16.1/providers/chargebee.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/chargebee.md rename to docs/versioned_docs/version-0.16.1/providers/chargebee.md diff --git a/docs/versioned_docs/version-0.15.2/providers/clearbit.md b/docs/versioned_docs/version-0.16.1/providers/clearbit.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/clearbit.md rename to docs/versioned_docs/version-0.16.1/providers/clearbit.md diff --git a/docs/versioned_docs/version-0.15.2/providers/dropbox.md b/docs/versioned_docs/version-0.16.1/providers/dropbox.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/dropbox.md rename to docs/versioned_docs/version-0.16.1/providers/dropbox.md diff --git a/docs/versioned_docs/version-0.15.2/providers/gmail.md b/docs/versioned_docs/version-0.16.1/providers/gmail.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/gmail.md rename to docs/versioned_docs/version-0.16.1/providers/gmail.md diff --git a/docs/versioned_docs/version-0.15.2/providers/gong.md b/docs/versioned_docs/version-0.16.1/providers/gong.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/gong.md rename to docs/versioned_docs/version-0.16.1/providers/gong.md diff --git a/docs/versioned_docs/version-0.15.2/providers/google-analytics.md b/docs/versioned_docs/version-0.16.1/providers/google-analytics.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/google-analytics.md rename to docs/versioned_docs/version-0.16.1/providers/google-analytics.md diff --git a/docs/versioned_docs/version-0.15.2/providers/google_calendar.md b/docs/versioned_docs/version-0.16.1/providers/google_calendar.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/google_calendar.md rename to docs/versioned_docs/version-0.16.1/providers/google_calendar.md diff --git a/docs/versioned_docs/version-0.15.2/providers/google_drive.md b/docs/versioned_docs/version-0.16.1/providers/google_drive.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/google_drive.md rename to docs/versioned_docs/version-0.16.1/providers/google_drive.md diff --git a/docs/versioned_docs/version-0.15.2/providers/hubspot.md b/docs/versioned_docs/version-0.16.1/providers/hubspot.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/hubspot.md rename to docs/versioned_docs/version-0.16.1/providers/hubspot.md diff --git a/docs/versioned_docs/version-0.15.2/providers/intercom.md b/docs/versioned_docs/version-0.16.1/providers/intercom.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/intercom.md rename to docs/versioned_docs/version-0.16.1/providers/intercom.md diff --git a/docs/versioned_docs/version-0.15.2/providers/linear.mdx b/docs/versioned_docs/version-0.16.1/providers/linear.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/linear.mdx rename to docs/versioned_docs/version-0.16.1/providers/linear.mdx diff --git a/docs/versioned_docs/version-0.15.2/providers/linkedin.md b/docs/versioned_docs/version-0.16.1/providers/linkedin.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/linkedin.md rename to docs/versioned_docs/version-0.16.1/providers/linkedin.md diff --git a/docs/versioned_docs/version-0.15.2/providers/marketo.md b/docs/versioned_docs/version-0.16.1/providers/marketo.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/marketo.md rename to docs/versioned_docs/version-0.16.1/providers/marketo.md diff --git a/docs/versioned_docs/version-0.15.2/providers/messenger.md b/docs/versioned_docs/version-0.16.1/providers/messenger.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/messenger.md rename to docs/versioned_docs/version-0.16.1/providers/messenger.md diff --git a/docs/versioned_docs/version-0.15.2/providers/mixpanel.md b/docs/versioned_docs/version-0.16.1/providers/mixpanel.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/mixpanel.md rename to docs/versioned_docs/version-0.16.1/providers/mixpanel.md diff --git a/docs/versioned_docs/version-0.15.2/providers/ms_dynamics_365_sales.md b/docs/versioned_docs/version-0.16.1/providers/ms_dynamics_365_sales.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/ms_dynamics_365_sales.md rename to docs/versioned_docs/version-0.16.1/providers/ms_dynamics_365_sales.md diff --git a/docs/versioned_docs/version-0.15.2/providers/onedrive.md b/docs/versioned_docs/version-0.16.1/providers/onedrive.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/onedrive.md rename to docs/versioned_docs/version-0.16.1/providers/onedrive.md diff --git a/docs/versioned_docs/version-0.15.2/providers/outlook.md b/docs/versioned_docs/version-0.16.1/providers/outlook.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/outlook.md rename to docs/versioned_docs/version-0.16.1/providers/outlook.md diff --git a/docs/versioned_docs/version-0.15.2/providers/outreach.md b/docs/versioned_docs/version-0.16.1/providers/outreach.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/outreach.md rename to docs/versioned_docs/version-0.16.1/providers/outreach.md diff --git a/docs/versioned_docs/version-0.15.2/providers/pipedrive.md b/docs/versioned_docs/version-0.16.1/providers/pipedrive.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/pipedrive.md rename to docs/versioned_docs/version-0.16.1/providers/pipedrive.md diff --git a/docs/versioned_docs/version-0.15.2/providers/salesforce.mdx b/docs/versioned_docs/version-0.16.1/providers/salesforce.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/salesforce.mdx rename to docs/versioned_docs/version-0.16.1/providers/salesforce.mdx diff --git a/docs/versioned_docs/version-0.15.2/providers/salesforce_marketing_cloud_account_engagement.md b/docs/versioned_docs/version-0.16.1/providers/salesforce_marketing_cloud_account_engagement.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/salesforce_marketing_cloud_account_engagement.md rename to docs/versioned_docs/version-0.16.1/providers/salesforce_marketing_cloud_account_engagement.md diff --git a/docs/versioned_docs/version-0.15.2/providers/salesloft.md b/docs/versioned_docs/version-0.16.1/providers/salesloft.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/salesloft.md rename to docs/versioned_docs/version-0.16.1/providers/salesloft.md diff --git a/docs/versioned_docs/version-0.15.2/providers/segment.md b/docs/versioned_docs/version-0.16.1/providers/segment.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/segment.md rename to docs/versioned_docs/version-0.16.1/providers/segment.md diff --git a/docs/versioned_docs/version-0.15.2/providers/slack.md b/docs/versioned_docs/version-0.16.1/providers/slack.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/slack.md rename to docs/versioned_docs/version-0.16.1/providers/slack.md diff --git a/docs/versioned_docs/version-0.15.2/providers/stripe.md b/docs/versioned_docs/version-0.16.1/providers/stripe.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/stripe.md rename to docs/versioned_docs/version-0.16.1/providers/stripe.md diff --git a/docs/versioned_docs/version-0.15.2/providers/teams.md b/docs/versioned_docs/version-0.16.1/providers/teams.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/teams.md rename to docs/versioned_docs/version-0.16.1/providers/teams.md diff --git a/docs/versioned_docs/version-0.15.2/providers/whatsapp.md b/docs/versioned_docs/version-0.16.1/providers/whatsapp.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/whatsapp.md rename to docs/versioned_docs/version-0.16.1/providers/whatsapp.md diff --git a/docs/versioned_docs/version-0.15.2/providers/zendesk.md b/docs/versioned_docs/version-0.16.1/providers/zendesk.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/zendesk.md rename to docs/versioned_docs/version-0.16.1/providers/zendesk.md diff --git a/docs/versioned_docs/version-0.15.2/providers/zoho.md b/docs/versioned_docs/version-0.16.1/providers/zoho.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/zoho.md rename to docs/versioned_docs/version-0.16.1/providers/zoho.md diff --git a/docs/versioned_docs/version-0.15.2/providers/zoom.md b/docs/versioned_docs/version-0.16.1/providers/zoom.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/zoom.md rename to docs/versioned_docs/version-0.16.1/providers/zoom.md diff --git a/docs/versioned_docs/version-0.15.2/providers/zoominfo.md b/docs/versioned_docs/version-0.16.1/providers/zoominfo.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/zoominfo.md rename to docs/versioned_docs/version-0.16.1/providers/zoominfo.md diff --git a/docs/versioned_docs/version-0.15.2/providers/zuora.md b/docs/versioned_docs/version-0.16.1/providers/zuora.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/providers/zuora.md rename to docs/versioned_docs/version-0.16.1/providers/zuora.md diff --git a/docs/versioned_docs/version-0.15.2/quickstart.mdx b/docs/versioned_docs/version-0.16.1/quickstart.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/quickstart.mdx rename to docs/versioned_docs/version-0.16.1/quickstart.mdx diff --git a/docs/versioned_docs/version-0.15.2/recipes/overview.md b/docs/versioned_docs/version-0.16.1/recipes/overview.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/recipes/overview.md rename to docs/versioned_docs/version-0.16.1/recipes/overview.md diff --git a/docs/versioned_docs/version-0.15.2/recipes/supaglue-inngest.mdx b/docs/versioned_docs/version-0.16.1/recipes/supaglue-inngest.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/recipes/supaglue-inngest.mdx rename to docs/versioned_docs/version-0.16.1/recipes/supaglue-inngest.mdx diff --git a/docs/versioned_docs/version-0.15.2/recipes/supaglue-prisma.mdx b/docs/versioned_docs/version-0.16.1/recipes/supaglue-prisma.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/recipes/supaglue-prisma.mdx rename to docs/versioned_docs/version-0.16.1/recipes/supaglue-prisma.mdx diff --git a/docs/versioned_docs/version-0.15.2/recipes/supaglue-render.md b/docs/versioned_docs/version-0.16.1/recipes/supaglue-render.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/recipes/supaglue-render.md rename to docs/versioned_docs/version-0.16.1/recipes/supaglue-render.md diff --git a/docs/versioned_docs/version-0.15.2/recipes/supaglue-temporal.md b/docs/versioned_docs/version-0.16.1/recipes/supaglue-temporal.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/recipes/supaglue-temporal.md rename to docs/versioned_docs/version-0.16.1/recipes/supaglue-temporal.md diff --git a/docs/versioned_docs/version-0.15.2/recipes/supaglue-triggerdev.md b/docs/versioned_docs/version-0.16.1/recipes/supaglue-triggerdev.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/recipes/supaglue-triggerdev.md rename to docs/versioned_docs/version-0.16.1/recipes/supaglue-triggerdev.md diff --git a/docs/versioned_docs/version-0.15.2/roadmap.md b/docs/versioned_docs/version-0.16.1/roadmap.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/roadmap.md rename to docs/versioned_docs/version-0.16.1/roadmap.md diff --git a/docs/versioned_docs/version-0.15.2/security_legal/privacy.md b/docs/versioned_docs/version-0.16.1/security_legal/privacy.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/security_legal/privacy.md rename to docs/versioned_docs/version-0.16.1/security_legal/privacy.md diff --git a/docs/versioned_docs/version-0.15.2/security_legal/security.md b/docs/versioned_docs/version-0.16.1/security_legal/security.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/security_legal/security.md rename to docs/versioned_docs/version-0.16.1/security_legal/security.md diff --git a/docs/versioned_docs/version-0.15.2/security_legal/terms.md b/docs/versioned_docs/version-0.16.1/security_legal/terms.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/security_legal/terms.md rename to docs/versioned_docs/version-0.16.1/security_legal/terms.md diff --git a/docs/versioned_docs/version-0.15.2/tutorials/build-integration-card.mdx b/docs/versioned_docs/version-0.16.1/tutorials/build-integration-card.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/tutorials/build-integration-card.mdx rename to docs/versioned_docs/version-0.16.1/tutorials/build-integration-card.mdx diff --git a/docs/versioned_docs/version-0.15.2/tutorials/build-settings-page.mdx b/docs/versioned_docs/version-0.16.1/tutorials/build-settings-page.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/tutorials/build-settings-page.mdx rename to docs/versioned_docs/version-0.16.1/tutorials/build-settings-page.mdx diff --git a/docs/versioned_docs/version-0.15.2/tutorials/listen-for-webhooks.mdx b/docs/versioned_docs/version-0.16.1/tutorials/listen-for-webhooks.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/tutorials/listen-for-webhooks.mdx rename to docs/versioned_docs/version-0.16.1/tutorials/listen-for-webhooks.mdx diff --git a/docs/versioned_docs/version-0.15.2/tutorials/mongo-view-prisma-view.md b/docs/versioned_docs/version-0.16.1/tutorials/mongo-view-prisma-view.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/tutorials/mongo-view-prisma-view.md rename to docs/versioned_docs/version-0.16.1/tutorials/mongo-view-prisma-view.md diff --git a/docs/versioned_docs/version-0.15.2/tutorials/read-write-contacts.md b/docs/versioned_docs/version-0.16.1/tutorials/read-write-contacts.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/tutorials/read-write-contacts.md rename to docs/versioned_docs/version-0.16.1/tutorials/read-write-contacts.md diff --git a/docs/versioned_docs/version-0.15.2/tutorials/search-across-data.mdx b/docs/versioned_docs/version-0.16.1/tutorials/search-across-data.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/tutorials/search-across-data.mdx rename to docs/versioned_docs/version-0.16.1/tutorials/search-across-data.mdx diff --git a/docs/versioned_docs/version-0.15.2/tutorials/transformations/association-bridge-table.mdx b/docs/versioned_docs/version-0.16.1/tutorials/transformations/association-bridge-table.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/tutorials/transformations/association-bridge-table.mdx rename to docs/versioned_docs/version-0.16.1/tutorials/transformations/association-bridge-table.mdx diff --git a/docs/versioned_docs/version-0.15.2/tutorials/transformations/common-schema.mdx b/docs/versioned_docs/version-0.16.1/tutorials/transformations/common-schema.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/tutorials/transformations/common-schema.mdx rename to docs/versioned_docs/version-0.16.1/tutorials/transformations/common-schema.mdx diff --git a/docs/versioned_docs/version-0.15.2/tutorials/transformations/normalized-relations.md b/docs/versioned_docs/version-0.16.1/tutorials/transformations/normalized-relations.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/tutorials/transformations/normalized-relations.md rename to docs/versioned_docs/version-0.16.1/tutorials/transformations/normalized-relations.md diff --git a/docs/versioned_docs/version-0.15.2/tutorials/transformations/object-field-mapping.mdx b/docs/versioned_docs/version-0.16.1/tutorials/transformations/object-field-mapping.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/tutorials/transformations/object-field-mapping.mdx rename to docs/versioned_docs/version-0.16.1/tutorials/transformations/object-field-mapping.mdx diff --git a/docs/versioned_docs/version-0.15.2/tutorials/transformations/overview.mdx b/docs/versioned_docs/version-0.16.1/tutorials/transformations/overview.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/tutorials/transformations/overview.mdx rename to docs/versioned_docs/version-0.16.1/tutorials/transformations/overview.mdx diff --git a/docs/versioned_docs/version-0.15.2/tutorials/transformations/pagination.mdx b/docs/versioned_docs/version-0.16.1/tutorials/transformations/pagination.mdx similarity index 100% rename from docs/versioned_docs/version-0.15.2/tutorials/transformations/pagination.mdx rename to docs/versioned_docs/version-0.16.1/tutorials/transformations/pagination.mdx diff --git a/docs/versioned_docs/version-0.15.2/use-cases/analytics.md b/docs/versioned_docs/version-0.16.1/use-cases/analytics.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/use-cases/analytics.md rename to docs/versioned_docs/version-0.16.1/use-cases/analytics.md diff --git a/docs/versioned_docs/version-0.15.2/use-cases/calculated-scores.md b/docs/versioned_docs/version-0.16.1/use-cases/calculated-scores.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/use-cases/calculated-scores.md rename to docs/versioned_docs/version-0.16.1/use-cases/calculated-scores.md diff --git a/docs/versioned_docs/version-0.15.2/use-cases/data-store.md b/docs/versioned_docs/version-0.16.1/use-cases/data-store.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/use-cases/data-store.md rename to docs/versioned_docs/version-0.16.1/use-cases/data-store.md diff --git a/docs/versioned_docs/version-0.15.2/use-cases/enrichment.md b/docs/versioned_docs/version-0.16.1/use-cases/enrichment.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/use-cases/enrichment.md rename to docs/versioned_docs/version-0.16.1/use-cases/enrichment.md diff --git a/docs/versioned_docs/version-0.15.2/use-cases/overview.md b/docs/versioned_docs/version-0.16.1/use-cases/overview.md similarity index 100% rename from docs/versioned_docs/version-0.15.2/use-cases/overview.md rename to docs/versioned_docs/version-0.16.1/use-cases/overview.md diff --git a/docs/versioned_sidebars/version-0.15.2-sidebars.json b/docs/versioned_sidebars/version-0.16.1-sidebars.json similarity index 100% rename from docs/versioned_sidebars/version-0.15.2-sidebars.json rename to docs/versioned_sidebars/version-0.16.1-sidebars.json diff --git a/docs/versions.json b/docs/versions.json index a97d04cdd..652ea8d8c 100644 --- a/docs/versions.json +++ b/docs/versions.json @@ -1,4 +1,4 @@ [ - "0.16.0", - "0.15.2" + "0.16.1", + "0.16.0" ] diff --git a/openapi/v2/actions/openapi.bundle.json b/openapi/v2/actions/openapi.bundle.json index 9b0aa0f88..c2c3e8143 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.16.0", + "version": "0.16.1", "title": "Actions API", "contact": { "name": "Supaglue", diff --git a/openapi/v2/actions/openapi.yaml b/openapi/v2/actions/openapi.yaml index d0b262cf3..7ff1bd9cd 100644 --- a/openapi/v2/actions/openapi.yaml +++ b/openapi/v2/actions/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 0.16.0 + version: 0.16.1 title: Actions API contact: name: Supaglue diff --git a/openapi/v2/crm/openapi.bundle.json b/openapi/v2/crm/openapi.bundle.json index 26ded8ab0..2ea3e21d5 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.16.0", + "version": "0.16.1", "title": "Unified CRM API", "contact": { "name": "Supaglue", diff --git a/openapi/v2/crm/openapi.yaml b/openapi/v2/crm/openapi.yaml index 4f45ed979..d0eb8f1eb 100644 --- a/openapi/v2/crm/openapi.yaml +++ b/openapi/v2/crm/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 0.16.0 + version: 0.16.1 title: Unified CRM API contact: name: Supaglue diff --git a/openapi/v2/engagement/openapi.bundle.json b/openapi/v2/engagement/openapi.bundle.json index 2b6641c29..9823dfb2d 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.16.0", + "version": "0.16.1", "title": "Unified Engagement API", "contact": { "name": "Supaglue", diff --git a/openapi/v2/engagement/openapi.yaml b/openapi/v2/engagement/openapi.yaml index cf166f619..3d81fb043 100644 --- a/openapi/v2/engagement/openapi.yaml +++ b/openapi/v2/engagement/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 0.16.0 + version: 0.16.1 title: Unified Engagement API contact: name: Supaglue diff --git a/openapi/v2/enrichment/openapi.bundle.json b/openapi/v2/enrichment/openapi.bundle.json index 0f6ba020d..be8bd28ca 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.16.0", + "version": "0.16.1", "title": "Unified Enrichment API", "contact": { "name": "Supaglue", diff --git a/openapi/v2/enrichment/openapi.yaml b/openapi/v2/enrichment/openapi.yaml index 1ca26dce8..7971a9e88 100644 --- a/openapi/v2/enrichment/openapi.yaml +++ b/openapi/v2/enrichment/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 0.16.0 + version: 0.16.1 title: Unified Enrichment API contact: name: Supaglue diff --git a/openapi/v2/mgmt/openapi.bundle.json b/openapi/v2/mgmt/openapi.bundle.json index 1a5791fc0..e6bfeccc7 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.16.0", + "version": "0.16.1", "title": "Management API", "contact": { "name": "Supaglue", diff --git a/openapi/v2/mgmt/openapi.yaml b/openapi/v2/mgmt/openapi.yaml index 5800b4d33..9ed31264a 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.16.0 + version: 0.16.1 title: Management API contact: name: Supaglue diff --git a/openapi/v2/ticketing/openapi.bundle.json b/openapi/v2/ticketing/openapi.bundle.json index ba29f7027..588aba6da 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.16.0", + "version": "0.16.1", "title": "Unified Ticketing API (Preview)", "contact": { "name": "Supaglue", diff --git a/openapi/v2/ticketing/openapi.yaml b/openapi/v2/ticketing/openapi.yaml index fcbd547c2..5a9114ce2 100644 --- a/openapi/v2/ticketing/openapi.yaml +++ b/openapi/v2/ticketing/openapi.yaml @@ -1,6 +1,6 @@ openapi: 3.0.3 info: - version: 0.16.0 + version: 0.16.1 title: Unified Ticketing API (Preview) contact: name: Supaglue diff --git a/package.json b/package.json index 3774e7f49..afa628d1c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "supaglue", - "version": "0.16.0", + "version": "0.16.1", "packageManager": "yarn@3.4.1", "private": true, "workspaces": [ diff --git a/packages/core/package.json b/packages/core/package.json index 76b08e6c5..ef3a3a788 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "@supaglue/core", - "version": "0.16.0", + "version": "0.16.1", "private": true, "index": "dist/index.js", "types": "index.ts", diff --git a/packages/db/package.json b/packages/db/package.json index 2ab7b0d74..5d3d0d32c 100644 --- a/packages/db/package.json +++ b/packages/db/package.json @@ -1,6 +1,6 @@ { "name": "@supaglue/db", - "version": "0.16.0", + "version": "0.16.1", "private": true, "packageManager": "yarn@3.4.1", "index": "dist/index.js", diff --git a/packages/schemas/package.json b/packages/schemas/package.json index aa405a736..2f396dd00 100644 --- a/packages/schemas/package.json +++ b/packages/schemas/package.json @@ -1,6 +1,6 @@ { "name": "@supaglue/schemas", - "version": "0.16.0", + "version": "0.16.1", "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 433c73f7a..bb063293c 100644 --- a/packages/sync-workflows/package.json +++ b/packages/sync-workflows/package.json @@ -1,6 +1,6 @@ { "name": "@supaglue/sync-workflows", - "version": "0.16.0", + "version": "0.16.1", "packageManager": "yarn@3.4.1", "dependencies": { "@supaglue/core": "workspace:*", diff --git a/packages/types/package.json b/packages/types/package.json index b1414be8d..d470b90bc 100644 --- a/packages/types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { "name": "@supaglue/types", - "version": "0.16.0", + "version": "0.16.1", "private": true, "index": "dist/index.js", "types": "index.ts", diff --git a/packages/utils/package.json b/packages/utils/package.json index ba2d0e49a..1d0714903 100644 --- a/packages/utils/package.json +++ b/packages/utils/package.json @@ -1,6 +1,6 @@ { "name": "@supaglue/utils", - "version": "0.16.0", + "version": "0.16.1", "private": true, "index": "dist/index.js", "types": "index.ts",