{
  "swagger": "2.0",
  "info": {
    "description": "",
    "version": "1.0",
    "title": "Contacts",
    "contact": {}
  },
  "host": "gdqgssg.restletmocks.net",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/contacts": {
      "get": {
        "tags": [
          "Contacts"
        ],
        "summary": "Get all contacts",
        "description": "Get all contacts",
        "operationId": "contacts-get-list",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "pageOffset",
            "in": "query",
            "required": false,
            "type": "number",
            "description": "Number of pages away from the first one. The first one is zero (0).",
            "default": 0,
            "x-example": 5
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "type": "number",
            "description": "Number of items per page",
            "default": 0,
            "x-example": 5
          },
          {
            "name": "tags[]",
            "in": "query",
            "required": false,
            "type": "string",
            "description": "Optional parameter to filter by one or more tags using the tagId",
            "x-example": "tags[]=123e4567-e89b-12d3-a456-426655440000&tags[]=123e4567-e89b-12d3-a456-426655440001"
          },
          {
            "name": "fromDatetime",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "date-time",
            "description": "Optional parameter to limit search results for records created after the specified date-time",
            "x-example": "2018-06-27T00:00:00.000Z"
          },
          {
            "name": "toDatetime",
            "in": "query",
            "required": false,
            "type": "string",
            "format": "date-time",
            "description": "Optional parameter to limit search results for records created before the specified date-time",
            "x-example": "2018-06-27T00:00:00.000Z"
          },
          {
            "name": "sortBy",
            "in": "query",
            "required": false,
            "type": "string",
            "description": "Optional parameter to sort by specified field name",
            "x-example": "contactName"
          },
          {
            "name": "sortOrder",
            "in": "query",
            "required": false,
            "type": "string",
            "description": "Optional parameter to sort by ascending or descending order",
            "default": "asc",
            "enum": [
              "asc",
              "desc"
            ]
          },
          {
            "name": "searchText",
            "in": "query",
            "required": false,
            "type": "string",
            "description": "Optional parameter to limit search results containing specified text"
          }
        ],
        "responses": {
          "200": {
            "description": "Status 200",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/Contact"
              }
            },
            "examples": {
              "application/json": "[\n    {\n      \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactTitle\": \"Dr\",\n      \"contactName\": \"Joe Smith\",\n      \"emailAddresses\": [\n        {\n          \"emailAddressId\": \"123e4567-e89b-12d3-a456-426655440000\",\n          \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n          \"label\": \"work\",\n          \"emailAddress\": \"joe@chassi.com\",\n          \"primaryEmailAddress\": true\n        }\n      ],\n      \"phoneNumbers\": [\n        {\n          \"phoneNumberId\": \"123e4567-e89b-12d3-a456-426655440000\",\n          \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n          \"label\": \"cell\",\n          \"countryCode\": \"1\",\n          \"phoneNumber\": \"1 (555) 123-1235\",\n          \"primaryPhoneNumber\": true\n        }\n      ],\n      \"physicalAddresses\": [\n        {\n          \"physicalAddressId\": \"123e4567-e89b-12d3-a456-426655440000\",\n          \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n          \"label\": \"mailing\",\n          \"attention\": \"Sam Smith\",\n          \"addressLine1\": \"123 Elm\",\n          \"addressLine2\": \"Suite 102\",\n          \"city\": \"Anytown\",\n          \"stateOrProvince2Digit\": \"AZ\",\n          \"postalCode\": \"85034\",\n          \"countryCode2Digit\": \"US\"\n        }\n      ],\n      \"contactTags\": [\n        {\n          \"contactTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n          \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n          \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n          \"tagName\": \"Referral\"\n        }\n      ],\n      \"primaryEmailAddressId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"primaryPhoneNumberId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactBirthday\": \"2018-02-18\",\n      \"contactSupportPIN\": \"string\",\n      \"contactCreatedByUserId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactCreatedBy\": \"John Smith\",\n      \"metadata\": [\n        {\n          \"metadataTag\": \"Customer\",\n          \"key\": \"birthdate\",\n          \"displayLabel\": \"personal data\",\n          \"value\": \"1974-08-28T00:00:00.000Z\",\n          \"valueFormat\": \"String\"\n        }\n      ],\n      \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n      \"lastUpdated\": \"2016-02-28T16:41:41.090Z\"\n    },\n    {\n        \"contactId\": \"123e4567-e89b-12d3-a456-426655440001\",\n        \"contactTitle\": \"Dr\",\n        \"contactName\": \"Jane Smith\",\n        \"emailAddresses\": [\n          {\n            \"emailAddressId\": \"123e4567-e89b-12d3-a456-426655440001\",\n            \"contactId\": \"123e4567-e89b-12d3-a456-426655440001\",\n            \"label\": \"work\",\n            \"emailAddress\": \"jane@chassi.com\",\n            \"primaryEmailAddress\": true\n          }\n        ],\n        \"phoneNumbers\": [\n          {\n            \"phoneNumberId\": \"123e4567-e89b-12d3-a456-426655440001\",\n            \"contactId\": \"123e4567-e89b-12d3-a456-4266554400001\",\n            \"label\": \"cell\",\n            \"countryCode\": \"1\",\n            \"phoneNumber\": \"1 (555) 123-4621\",\n            \"primaryPhoneNumber\": true\n          }\n        ],\n        \"physicalAddresses\": [\n          {\n            \"physicalAddressId\": \"123e4567-e89b-12d3-a456-426655440001\",\n            \"contactId\": \"123e4567-e89b-12d3-a456-426655440001\",\n            \"label\": \"mailing\",\n            \"attention\": \"Jane Smith\",\n            \"addressLine1\": \"123 Elm\",\n            \"addressLine2\": \"Suite 102\",\n            \"city\": \"Anytown\",\n            \"stateOrProvince2Digit\": \"AZ\",\n            \"postalCode\": \"85034\",\n            \"countryCode2Digit\": \"US\"\n          }\n        ],\n        \"contactTags\": [\n          {\n            \"contactTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n            \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n            \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n            \"tagName\": \"Referral\"\n          }\n        ],\n        \"primaryEmailAddressId\": \"123e4567-e89b-12d3-a456-426655440001\",\n        \"primaryPhoneNumberId\": \"123e4567-e89b-12d3-a456-426655440001\",\n        \"contactBirthday\": \"2018-02-18\",\n        \"contactSupportPIN\": \"string\",\n        \"contactCreatedByUserId\": \"123e4567-e89b-12d3-a456-426655440000\",\n        \"contactCreatedBy\": \"John Smith\",\n        \"metadata\": [\n          {\n            \"metadataTag\": \"Customer\",\n            \"key\": \"birthdate\",\n            \"displayLabel\": \"personal data\",\n            \"value\": \"1974-08-28T00:00:00.000Z\",\n            \"valueFormat\": \"String\"\n          }\n        ],\n        \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n        \"lastUpdated\": \"2016-02-28T16:41:41.090Z\"\n      }\n  ]\n"
            }
          }
        }
      },
      "post": {
        "tags": [
          "Contacts"
        ],
        "summary": "Create a new contact",
        "description": "Create a new contact",
        "operationId": "contacts-create",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Contact"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Status 200",
            "schema": {
              "$ref": "#/definitions/Contact"
            },
            "examples": {
              "application/json": "{\n  \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n  \"contactTitle\": \"Dr\",\n  \"contactName\": \"Joe Smith\",\n  \"emailAddresses\": [\n    {\n      \"emailAddressId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"label\": \"work\",\n      \"emailAddress\": \"joe@chassi.com\",\n      \"primaryEmailAddress\": false\n    }\n  ],\n  \"phoneNumbers\": [\n    {\n      \"phoneNumberId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"label\": \"cell\",\n      \"countryCode\": \"1\",\n      \"phoneNumber\": \"1 (555) 123-1235\",\n      \"primaryPhoneNumber\": false\n    }\n  ],\n  \"physicalAddresses\": [\n    {\n      \"physicalAddressId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"label\": \"mailing\",\n      \"attention\": \"Sam Smith\",\n      \"addressLine1\": \"123 Elm\",\n      \"addressLine2\": \"Suite 102\",\n      \"city\": \"Anytown\",\n      \"stateOrProvince2Digit\": \"AZ\",\n      \"postalCode\": \"85034\",\n      \"countryCode2Digit\": \"US\"\n    }\n  ],\n  \"contactTags\": [\n    {\n      \"contactTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"tagName\": \"Referral\"\n    }\n  ],\n  \"primaryEmailAddressId\": \"123e4567-e89b-12d3-a456-426655440000\",\n  \"primaryPhoneNumberId\": \"123e4567-e89b-12d3-a456-426655440000\",\n  \"contactBirthday\": \"2018-02-18\",\n  \"contactSupportPIN\": \"string\",\n  \"contactCreatedByUserId\": \"123e4567-e89b-12d3-a456-426655440000\",\n  \"contactCreatedBy\": \"John Smith\",\n  \"metadata\": [\n    {\n      \"metadataTag\": \"Customer\",\n      \"key\": \"birthdate\",\n      \"displayLabel\": \"personal data\",\n      \"value\": \"1974-08-28T00:00:00.000Z\",\n      \"valueFormat\": \"String\"\n    }\n  ],\n  \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n  \"lastUpdated\": \"2016-02-28T16:41:41.090Z\"\n}\n"
            }
          },
          "400": {
            "description": "Status 400",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      }
    },
    "/contacts/{contactId}": {
      "get": {
        "tags": [
          "Contacts"
        ],
        "summary": "Get a contact",
        "description": "Get a contact",
        "operationId": "contacts-get",
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Status 200",
            "schema": {
              "$ref": "#/definitions/Contact"
            },
            "examples": {
              "application/json": "{\n  \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n  \"contactTitle\": \"Dr\",\n  \"contactName\": \"Joe Smith\",\n  \"emailAddresses\": [\n    {\n      \"emailAddressId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"label\": \"work\",\n      \"emailAddress\": \"joe@chassi.com\",\n      \"primaryEmailAddress\": false\n    }\n  ],\n  \"phoneNumbers\": [\n    {\n      \"phoneNumberId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"label\": \"cell\",\n      \"countryCode\": \"1\",\n      \"phoneNumber\": \"1 (555) 123-1235\",\n      \"primaryPhoneNumber\": false\n    }\n  ],\n  \"physicalAddresses\": [\n    {\n      \"physicalAddressId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"label\": \"mailing\",\n      \"attention\": \"Sam Smith\",\n      \"addressLine1\": \"123 Elm\",\n      \"addressLine2\": \"Suite 102\",\n      \"city\": \"Anytown\",\n      \"stateOrProvince2Digit\": \"AZ\",\n      \"postalCode\": \"85034\",\n      \"countryCode2Digit\": \"US\"\n    }\n  ],\n  \"contactTags\": [\n    {\n      \"contactTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"tagName\": \"Referral\"\n    }\n  ],\n  \"primaryEmailAddressId\": \"123e4567-e89b-12d3-a456-426655440000\",\n  \"primaryPhoneNumberId\": \"123e4567-e89b-12d3-a456-426655440000\",\n  \"contactBirthday\": \"2018-02-18\",\n  \"contactSupportPIN\": \"string\",\n  \"contactCreatedByUserId\": \"123e4567-e89b-12d3-a456-426655440000\",\n  \"contactCreatedBy\": \"John Smith\",\n  \"metadata\": [\n    {\n      \"metadataTag\": \"Customer\",\n      \"key\": \"birthdate\",\n      \"displayLabel\": \"personal data\",\n      \"value\": \"1974-08-28T00:00:00.000Z\",\n      \"valueFormat\": \"String\"\n    }\n  ],\n  \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n  \"lastUpdated\": \"2016-02-28T16:41:41.090Z\"\n}\n"
            }
          },
          "404": {
            "description": "Status 404",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      },
      "put": {
        "tags": [
          "Contacts"
        ],
        "summary": "Update contact",
        "description": "Update contact",
        "operationId": "contacts-update",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/Contact"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Status 200",
            "schema": {
              "$ref": "#/definitions/Contact"
            },
            "examples": {
              "application/json": "{\n  \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n  \"contactTitle\": \"Dr\",\n  \"contactName\": \"Joe Smith\",\n  \"emailAddresses\": [\n    {\n      \"emailAddressId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"label\": \"work\",\n      \"emailAddress\": \"joe@chassi.com\",\n      \"primaryEmailAddress\": false\n    }\n  ],\n  \"phoneNumbers\": [\n    {\n      \"phoneNumberId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"label\": \"cell\",\n      \"countryCode\": \"1\",\n      \"phoneNumber\": \"1 (555) 123-1235\",\n      \"primaryPhoneNumber\": false\n    }\n  ],\n  \"physicalAddresses\": [\n    {\n      \"physicalAddressId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"label\": \"mailing\",\n      \"attention\": \"Sam Smith\",\n      \"addressLine1\": \"123 Elm\",\n      \"addressLine2\": \"Suite 102\",\n      \"city\": \"Anytown\",\n      \"stateOrProvince2Digit\": \"AZ\",\n      \"postalCode\": \"85034\",\n      \"countryCode2Digit\": \"US\"\n    }\n  ],\n  \"contactTags\": [\n    {\n      \"contactTagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"contactId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"tagId\": \"123e4567-e89b-12d3-a456-426655440000\",\n      \"tagName\": \"Referral\"\n    }\n  ],\n  \"primaryEmailAddressId\": \"123e4567-e89b-12d3-a456-426655440000\",\n  \"primaryPhoneNumberId\": \"123e4567-e89b-12d3-a456-426655440000\",\n  \"contactBirthday\": \"2018-02-18\",\n  \"contactSupportPIN\": \"string\",\n  \"contactCreatedByUserId\": \"123e4567-e89b-12d3-a456-426655440000\",\n  \"contactCreatedBy\": \"John Smith\",\n  \"metadata\": [\n    {\n      \"metadataTag\": \"Customer\",\n      \"key\": \"birthdate\",\n      \"displayLabel\": \"personal data\",\n      \"value\": \"1974-08-28T00:00:00.000Z\",\n      \"valueFormat\": \"String\"\n    }\n  ],\n  \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n  \"lastUpdated\": \"2016-02-28T16:41:41.090Z\"\n}\n"
            }
          },
          "400": {
            "description": "Status 400",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          },
          "404": {
            "description": "Status 404",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Contacts"
        ],
        "summary": "Delete a contact",
        "description": "Delete a contact",
        "operationId": "contacts-delete",
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "204": {
            "description": "Status 204"
          },
          "404": {
            "description": "Status 404",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      },
      "parameters": [
        {
          "name": "contactId",
          "in": "path",
          "required": true,
          "type": "string"
        }
      ]
    },
    "/contacts/{contactId}/notes": {
      "get": {
        "tags": [
          "Contact Notes"
        ],
        "summary": "Get all contact notes",
        "description": "Get all contact notes",
        "operationId": "contacts-notes-get-list",
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Status 200",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/definitions/ContactNote"
              }
            },
            "examples": {
              "application/json": "[\n    {\n        \"contactNoteId\": \"123e4567-e89b-12d3-a456-426655440000\",\n        \"noteDetail\": \"Once upon a time...\",\n        \"authorName\": \"Sam Jones\",\n        \"metadata\": [\n            {\n                \"metadataTag\": \"Customer\",\n                \"key\": \"quotes\",\n                \"displayLabel\": \"personal data\",\n                \"value\": \"favorite quotes\",\n                \"valueFormat\": \"String\"\n            }\n        ],\n        \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n        \"lastUpdated\": \"2016-02-28T16:41:41.090Z\"\n    },\n    {\n        \"contactNoteId\": \"123e4567-e89b-12d3-a456-426655440000\",\n        \"noteDetail\": \"A long time ago...\",\n        \"authorName\": \"John Doe\",\n        \"metadata\": [\n            {\n                \"metadataTag\": \"Customer\",\n                \"key\": \"quotes\",\n                \"displayLabel\": \"personal data\",\n                \"value\": \"favorite quotes\",\n                \"valueFormat\": \"String\"\n            }\n        ],\n        \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n        \"lastUpdated\": \"2016-02-28T16:41:41.090Z\"\n    }    \n]"
            }
          },
          "404": {
            "description": "Status 404",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      },
      "post": {
        "tags": [
          "Contact Notes"
        ],
        "summary": "Create a new contact note",
        "description": "Create a new contact note",
        "operationId": "contacts-notes-create",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/ContactNote"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Status 200",
            "schema": {
              "$ref": "#/definitions/ContactNote"
            },
            "examples": {
              "application/json": "{\n    \"contactNoteId\": \"123e4567-e89b-12d3-a456-426655440000\",\n    \"noteDetail\": \"Once upon a time...\",\n    \"authorName\": \"Sam Jones\",\n    \"metadata\": [\n        {\n            \"metadataTag\": \"Customer\",\n            \"key\": \"quotes\",\n            \"displayLabel\": \"personal data\",\n            \"value\": \"favorite quotes\",\n            \"valueFormat\": \"String\"\n        }\n    ],\n    \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n    \"lastUpdated\": \"2016-02-28T16:41:41.090Z\"\n}"
            }
          },
          "400": {
            "description": "Status 400",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          },
          "404": {
            "description": "Status 404",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      },
      "parameters": [
        {
          "name": "contactId",
          "in": "path",
          "required": true,
          "type": "string"
        }
      ]
    },
    "/contacts/{contactId}/notes/{contactNoteId}": {
      "get": {
        "tags": [
          "Contact Notes"
        ],
        "summary": "Get a note for the specified contact",
        "description": "Get a contact",
        "operationId": "contacts-notes-get",
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "Status 200",
            "schema": {
              "$ref": "#/definitions/ContactNote"
            },
            "examples": {
              "application/json": "{\n    \"contactNoteId\": \"123e4567-e89b-12d3-a456-426655440000\",\n    \"noteDetail\": \"Once upon a time...\",\n    \"authorName\": \"Sam Jones\",\n    \"metadata\": [\n        {\n            \"metadataTag\": \"Customer\",\n            \"key\": \"quotes\",\n            \"displayLabel\": \"personal data\",\n            \"value\": \"favorite quotes\",\n            \"valueFormat\": \"String\"\n        }\n    ],\n    \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n    \"lastUpdated\": \"2016-02-28T16:41:41.090Z\"\n}"
            }
          },
          "404": {
            "description": "Status 404",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      },
      "put": {
        "tags": [
          "Contact Notes"
        ],
        "summary": "Update a note for the specified contact",
        "description": "Update a note for the specified contact",
        "operationId": "contacts-notes-update",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "body",
            "in": "body",
            "required": true,
            "schema": {
              "$ref": "#/definitions/ContactNote"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Status 200",
            "schema": {
              "$ref": "#/definitions/ContactNote"
            },
            "examples": {
              "application/json": "{\n    \"contactNoteId\": \"123e4567-e89b-12d3-a456-426655440000\",\n    \"noteDetail\": \"Once upon a time...\",\n    \"authorName\": \"Sam Jones\",\n    \"metadata\": [\n        {\n            \"metadataTag\": \"Customer\",\n            \"key\": \"quotes\",\n            \"displayLabel\": \"personal data\",\n            \"value\": \"favorite quotes\",\n            \"valueFormat\": \"String\"\n        }\n    ],\n    \"dateCreated\": \"2016-02-28T16:41:41.090Z\",\n    \"lastUpdated\": \"2016-02-28T16:41:41.090Z\"\n}"
            }
          },
          "400": {
            "description": "Status 400",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          },
          "404": {
            "description": "Status 404",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Contact Notes"
        ],
        "summary": "Delete a note for the specified contact",
        "description": "Delete a note for the specified contact",
        "operationId": "contacts-notes-delete",
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "204": {
            "description": "Status 204"
          },
          "404": {
            "description": "Status 404",
            "schema": {
              "$ref": "#/definitions/ErrorResponse"
            }
          }
        }
      },
      "parameters": [
        {
          "name": "contactId",
          "in": "path",
          "required": true,
          "type": "string"
        },
        {
          "name": "contactNoteId",
          "in": "path",
          "required": true,
          "type": "string"
        }
      ]
    }
  },
  "definitions": {
    "Contact": {
      "type": "object",
      "properties": {
        "contactId": {
          "type": "string",
          "example": "123e4567-e89b-12d3-a456-426655440000"
        },
        "contactTitle": {
          "type": "string",
          "example": "Dr"
        },
        "contactName": {
          "type": "string",
          "description": "The full name of the contact.",
          "example": "Joe Smith"
        },
        "emailAddresses": {
          "type": "array",
          "description": "An optional list of email addresses",
          "items": {
            "$ref": "#/definitions/EmailAddress"
          }
        },
        "phoneNumbers": {
          "type": "array",
          "description": "An optional list of phone numbers",
          "items": {
            "$ref": "#/definitions/PhoneNumber"
          }
        },
        "physicalAddresses": {
          "type": "array",
          "description": "An optional of mailing addresses.",
          "items": {
            "$ref": "#/definitions/PhysicalAddress"
          }
        },
        "contactTags": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/ContactTag"
          }
        },
        "primaryEmailAddressId": {
          "type": "string",
          "description": "The id of the primary contact email",
          "example": "123e4567-e89b-12d3-a456-426655440000"
        },
        "primaryPhoneNumberId": {
          "type": "string",
          "description": "The id of the primary contact phone number",
          "example": "123e4567-e89b-12d3-a456-426655440000"
        },
        "contactBirthday": {
          "type": "string",
          "pattern": "yyyy-MM-dd",
          "example": "2018-02-18"
        },
        "contactSupportPIN": {
          "type": "string",
          "example": "SupportPINGoesHere"
        },
        "contactCreatedByUserId": {
          "type": "string",
          "description": "The id of the user creating this Contact",
          "example": "123e4567-e89b-12d3-a456-426655440000"
        },
        "contactCreatedBy": {
          "type": "string",
          "description": "The name of the user creating this Contact",
          "example": "John Smith"
        },
        "metadata": {
          "type": "array",
          "description": "User defined data",
          "items": {
            "$ref": "#/definitions/MetadataElement"
          }
        },
        "dateCreated": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time the entity was created.",
          "example": "2016-02-28T16:41:41.090Z"
        },
        "lastUpdated": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time the entity was last modified.",
          "example": "2016-02-28T16:41:41.090Z"
        }
      }
    },
    "PhysicalAddress": {
      "type": "object",
      "properties": {
        "physicalAddressId": {
          "type": "string",
          "example": "123e4567-e89b-12d3-a456-426655440000"
        },
        "contactId": {
          "type": "string",
          "example": "123e4567-e89b-12d3-a456-426655440000"
        },
        "label": {
          "type": "string",
          "description": "A user defined label for this mailing address.",
          "example": "mailing"
        },
        "attention": {
          "type": "string",
          "example": "Sam Smith"
        },
        "addressLine1": {
          "type": "string",
          "example": "123 Elm"
        },
        "addressLine2": {
          "type": "string",
          "example": "Suite 102"
        },
        "city": {
          "type": "string",
          "example": "Anytown"
        },
        "stateOrProvince2Digit": {
          "type": "string",
          "example": "AZ"
        },
        "postalCode": {
          "type": "string",
          "example": "85034"
        },
        "countryCode2Digit": {
          "type": "string",
          "example": "US"
        }
      },
      "description": "Treated only as an embedded object (not standalone entity) to be incorporated in other entities (e.g. Contact)."
    },
    "PhoneNumber": {
      "type": "object",
      "properties": {
        "phoneNumberId": {
          "type": "string",
          "example": "123e4567-e89b-12d3-a456-426655440000"
        },
        "contactId": {
          "type": "string",
          "example": "123e4567-e89b-12d3-a456-426655440000"
        },
        "label": {
          "type": "string",
          "description": "A user defined label for this phone number.",
          "example": "cell"
        },
        "countryCode": {
          "type": "string",
          "description": "Phone number country code",
          "example": "1"
        },
        "phoneNumber": {
          "type": "string",
          "example": "1 (555) 123-1235"
        },
        "primaryPhoneNumber": {
          "type": "boolean",
          "default": false,
          "example": true
        }
      },
      "description": "Treated only as an embedded object (not standalone entity) to be incorporated in other entities (e.g. Contact).\n\nFollows the ITU E.164 International Public Telecommunication numbering plan: https://en.wikipedia.org/wiki/E.164\n\nAs used, by example Twilio: https://support.twilio.com/hc/en-us/articles/223183008-Formatting-International-Phone-Numbers"
    },
    "EmailAddress": {
      "type": "object",
      "properties": {
        "emailAddressId": {
          "type": "string",
          "example": "123e4567-e89b-12d3-a456-426655440000"
        },
        "contactId": {
          "type": "string",
          "example": "123e4567-e89b-12d3-a456-426655440000"
        },
        "label": {
          "type": "string",
          "description": "A user defined label for this email address",
          "example": "work"
        },
        "emailAddress": {
          "type": "string",
          "example": "joe@chassi.com"
        },
        "primaryEmailAddress": {
          "type": "boolean",
          "default": false,
          "example": true
        }
      }
    },
    "MetadataElement": {
      "type": "object",
      "required": [
        "key"
      ],
      "properties": {
        "metadataTag": {
          "type": "string",
          "description": "A namespace to group similar data",
          "example": "Customer"
        },
        "key": {
          "type": "string",
          "description": "Attribute name of metadata",
          "example": "birthdate"
        },
        "displayLabel": {
          "type": "string",
          "description": "Used to display the field label for the value",
          "example": "personal data"
        },
        "value": {
          "type": "string",
          "description": "Data value of metadata",
          "example": "1974-08-28T00:00:00.000Z"
        },
        "valueFormat": {
          "type": "string",
          "description": "Controlled enumerated types that realize value",
          "enum": [
            "String",
            "Text",
            "Number",
            "Date",
            "Time",
            "Datetime",
            "Boolean"
          ],
          "example": "String"
        }
      }
    },
    "FieldErrorResponse": {
      "type": "object",
      "properties": {
        "fieldName": {
          "type": "string"
        },
        "fieldError": {
          "type": "string"
        }
      }
    },
    "ErrorResponse": {
      "type": "object",
      "properties": {
        "statusCode": {
          "type": "number"
        },
        "errorMessage": {
          "type": "string"
        },
        "exceptionName": {
          "type": "string"
        },
        "fieldErrors": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/FieldErrorResponse"
          }
        }
      }
    },
    "ContactTag": {
      "type": "object",
      "properties": {
        "contactTagId": {
          "type": "string",
          "example": "123e4567-e89b-12d3-a456-426655440000"
        },
        "contactId": {
          "type": "string",
          "example": "123e4567-e89b-12d3-a456-426655440000"
        },
        "tagId": {
          "type": "string",
          "example": "123e4567-e89b-12d3-a456-426655440000"
        },
        "tagName": {
          "type": "string",
          "example": "Referral"
        }
      }
    },
    "ContactNote": {
      "type": "object",
      "properties": {
        "contactNoteId": {
          "type": "string",
          "example": "123e4567-e89b-12d3-a456-426655440000"
        },
        "noteDetail": {
          "type": "string",
          "example": "Once upon a time..."
        },
        "authorName": {
          "type": "string",
          "example": "Sam Jones"
        },
        "metadata": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/MetadataElement"
          }
        },
        "dateCreated": {
          "type": "string",
          "format": "date-time",
          "example": "2016-02-28T16:41:41.090Z"
        },
        "lastUpdated": {
          "type": "string",
          "format": "date-time",
          "example": "2016-02-28T16:41:41.090Z"
        }
      }
    }
  }
}
