---
agentTools:
  projectIndex: https://clientsuccess.readme.io/llms.txt
---

# /contact/{uuid}/patchExternalSystems

Update/add contact external system ids

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "ClientSuccess API",
    "description": "ClientSuccess CNS API",
    "version": "v2.0.0"
  },
  "servers": [
    {
      "url": "https://api.clientsuccess.com/v2"
    }
  ],
  "security": [
    {
      "gen-auth": []
    }
  ],
  "paths": {
    "/contact/{uuid}/patchExternalSystems": {
      "patch": {
        "tags": [
          "Contact"
        ],
        "description": "Update/add contact external system ids",
        "operationId": "patchContactExternalSystems_1",
        "parameters": [
          {
            "name": "uuid",
            "in": "path",
            "description": "Contact UUID",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ContactCustomFieldDto"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "$ref": "#/components/schemas/ResultClientContact"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ValidationError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string"
          },
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "fieldValue": {
            "type": "object"
          }
        }
      },
      "ValidationErrors": {
        "type": "object",
        "properties": {
          "objectName": {
            "type": "string"
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            }
          }
        }
      },
      "ClientContact": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "createdTime": {
            "type": "string",
            "format": "date-time"
          },
          "modifiedTime": {
            "type": "string",
            "format": "date-time"
          },
          "uuid": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "ACTIVE",
              "INACTIVE"
            ]
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "email": {
            "type": "string"
          },
          "phone": {
            "type": "string"
          },
          "mobile": {
            "type": "string"
          },
          "salesforceId": {
            "type": "string"
          },
          "linkedinUrl": {
            "type": "string"
          },
          "advocate": {
            "type": "boolean"
          },
          "champion": {
            "type": "boolean"
          },
          "executiveSponsor": {
            "type": "boolean"
          },
          "starred": {
            "type": "boolean"
          },
          "keyContact": {
            "type": "boolean"
          },
          "street": {
            "type": "string"
          },
          "city": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "zip": {
            "type": "string"
          },
          "country": {
            "type": "string"
          },
          "timezone": {
            "type": "string"
          },
          "notes": {
            "type": "string"
          },
          "externalId": {
            "type": "string"
          },
          "usageId": {
            "type": "string"
          },
          "engagementCount": {
            "type": "integer",
            "format": "int64"
          },
          "lastEngagementDate": {
            "type": "string",
            "format": "date-time"
          },
          "badges": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "ADVOCATE",
                "CHAMPION",
                "EXECUTIVE_SPONSOR",
                "STARRED",
                "KEY_CONTACT"
              ]
            }
          },
          "address": {
            "type": "string"
          },
          "tenantClientId": {
            "type": "integer",
            "format": "int64"
          },
          "externalSystems": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "ResultClientContact": {
        "type": "object",
        "properties": {
          "success": {
            "type": "boolean"
          },
          "message": {
            "type": "string"
          },
          "errors": {
            "$ref": "#/components/schemas/ValidationErrors"
          },
          "data": {
            "$ref": "#/components/schemas/ClientContact"
          },
          "rawData": {
            "type": "string"
          },
          "action": {
            "type": "string"
          }
        }
      },
      "ClientContactExternalSystem": {
        "type": "object",
        "properties": {
          "externalSystemId": {
            "type": "string",
            "description": "Identifier value of external system"
          },
          "type": {
            "type": "string",
            "description": "Type/enum of external system",
            "enum": [
              "SALESFORCE",
              "LINKEDIN",
              "ZENDESK",
              "EXCEL",
              "GOOGLE",
              "STRIPE",
              "DESK",
              "SLACK",
              "FRESHDESK",
              "USERVOICE",
              "JIRA",
              "IMAP",
              "INTERCOM",
              "OFFICE365",
              "DELIGHTED",
              "CLOUD_ELEMENTS",
              "MEDALLIA",
              "ASKNICELY",
              "HUBSPOT",
              "CLIENTSUCCESS",
              "SALESFORCE_V2",
              "ZENDESK_V2",
              "FRESHDESK_V2",
              "JIRA_V2",
              "PIPEDRIVE",
              "EMAIL_ADV",
              "ZOHOCRM",
              "HELPSCOUT",
              "IMPORT",
              "SATISMETER",
              "ZOOM",
              "SERVICE_NOW",
              "STATUS",
              "MICROSOFT_DYNAMICS",
              "PRODUCT_SIGNALS",
              "MICROSOFT_CALENDAR",
              "BATON",
              "GONG",
              "CHORUS"
            ]
          }
        }
      },
      "ContactCustomFieldDto": {
        "type": "object",
        "properties": {
          "externalSystems": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ClientContactExternalSystem"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "gen-auth": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 101,
      "1": 113,
      "2": 164,
      "3": 150,
      "4": 249,
      "5": 175,
      "6": 252,
      "7": 0,
      "8": 77,
      "9": 217,
      "10": 148,
      "11": 207
    }
  }
}
```