{
  "opencollection": "1.0.0",
  "info": {
    "name": "Suger API Contact API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Contact",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Contacts By Organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.suger.cloud/org/:orgId/contact",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "List pagination size, default 1000, max value is 1000"
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "List pagination offset, default 0"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "List all contacts under the given organization."
        },
        {
          "info": {
            "name": "Create Contact",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.suger.cloud/org/:orgId/contact",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Create a contact under the given organization. If the email address already exists, return the existing contact."
        },
        {
          "info": {
            "name": "Get Contact",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.suger.cloud/org/:orgId/contact/:contactId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "contactId",
                "value": "",
                "type": "path",
                "description": "Contact ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Get the Contact by the given contact ID."
        },
        {
          "info": {
            "name": "Update Contact",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.suger.cloud/org/:orgId/contact/:contactId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "contactId",
                "value": "",
                "type": "path",
                "description": "Contact ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "update contact by the given organization and buyer id. The given name and information should be complete. Please note that this function does not support partial updates."
        },
        {
          "info": {
            "name": "Add Contact To Buyer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.suger.cloud/org/:orgId/contact/:contactId/buyer/:buyerId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "buyerId",
                "value": "",
                "type": "path",
                "description": "Buyer ID"
              },
              {
                "name": "contactId",
                "value": "",
                "type": "path",
                "description": "Contact ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "add contact to buyer by the given organization, buyer id and contact id."
        },
        {
          "info": {
            "name": "Remove Contact From Buyer",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.suger.cloud/org/:orgId/contact/:contactId/buyer/:buyerId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "buyerId",
                "value": "",
                "type": "path",
                "description": "Buyer ID"
              },
              {
                "name": "contactId",
                "value": "",
                "type": "path",
                "description": "Contact ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "remove contact from buyer by the given organization, buyer id and contact id."
        },
        {
          "info": {
            "name": "Add Contact To Offer",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.suger.cloud/org/:orgId/contact/:contactId/offer/:offerId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "contactId",
                "value": "",
                "type": "path",
                "description": "Contact ID"
              },
              {
                "name": "offerId",
                "value": "",
                "type": "path",
                "description": "Offer ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "add contact to offer by the given organization, offer id and contact id."
        },
        {
          "info": {
            "name": "Remove Contact From Offer",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.suger.cloud/org/:orgId/contact/:contactId/offer/:offerId",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "contactId",
                "value": "",
                "type": "path",
                "description": "Contact ID"
              },
              {
                "name": "offerId",
                "value": "",
                "type": "path",
                "description": "Offer ID"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "remove contact from offer by given organization, offer id and contact id."
        },
        {
          "info": {
            "name": "Batch Create Contacts",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.suger.cloud/org/:orgId/contact/batch",
            "params": [
              {
                "name": "orgId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Create multiple contacts under the given organization. If an email address already exists, return the existing contact."
        }
      ]
    }
  ],
  "bundled": true
}