{
"opencollection": "1.0.0",
"info": {
"name": "Cvent REST APIs — Event Cloud Contacts API",
"version": "ea"
},
"items": [
{
"info": {
"name": "Contacts",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Contact Groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-platform.cvent.com/ea/contact-groups",
"params": [
{
"name": "after",
"value": "",
"type": "query",
"description": "Used to query records that have been added or updated after this time point. Default to the beginning of time of the data store."
},
{
"name": "before",
"value": "",
"type": "query",
"description": "Used to query records that have been added or updated before this time point."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of records to return per page."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Use filter query parameters to limit results\nto data that matches your criteria. See\n[Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.\n\nSupported fields and operators are listed below:\n\n| Field | Operators | Notes |\n|------------------|-------------------------------------|-------|\n| name | `eq`, `ne`, `sw`, `contains` | |\n| type | `eq` | Not supported with before or after parameters |\n\nThe following logical operators are supported for combining filters:\n* and\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Gets a paginated list of contact groups"
},
{
"info": {
"name": "Create Contact Group",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-platform.cvent.com/ea/contact-groups",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Create a contact group"
},
{
"info": {
"name": "Get Contact Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-platform.cvent.com/ea/contact-groups/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact group."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Get a single contact group"
},
{
"info": {
"name": "Update Contact Group",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-platform.cvent.com/ea/contact-groups/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact group."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Update a contact group"
},
{
"info": {
"name": "Delete Contact Group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api-platform.cvent.com/ea/contact-groups/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact group."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Delete a contact group"
},
{
"info": {
"name": "Get Ids in Contact Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-platform.cvent.com/ea/contact-groups/:id/contacts",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact group."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of records to return per page."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Get all contact ids in a single contact group"
},
{
"info": {
"name": "Add Contact To Group",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-platform.cvent.com/ea/contact-groups/:id/contacts/:contactId",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact group."
},
{
"name": "contactId",
"value": "",
"type": "path",
"description": "ID of a contact."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds a single Contact to a single Contact Group"
},
{
"info": {
"name": "Remove Contact From Group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api-platform.cvent.com/ea/contact-groups/:id/contacts/:contactId",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact group."
},
{
"name": "contactId",
"value": "",
"type": "path",
"description": "ID of a contact."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Removes a single Contact from a single Contact Group"
},
{
"info": {
"name": "List Contact Types",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-platform.cvent.com/ea/contact-types",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of records to return per page."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Use filter query parameters to limit results\nto data that matches your criteria. See\n[Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.\n\nSupported fields and operators are listed below:\n\n| Field | Operators |\n|------------------|-------------------------------------|\n| name | `eq`, `ne`, `sw`, `contains` |\n\nNo logical operators are supported on this endpoint, only one filter\ncan be passed in each request.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Gets a paginated list of contact types."
},
{
"info": {
"name": "List Contacts",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-platform.cvent.com/ea/contacts",
"params": [
{
"name": "after",
"value": "",
"type": "query",
"description": "Used to query records that have been added or updated after this time point. Default to the beginning of time of the data store."
},
{
"name": "before",
"value": "",
"type": "query",
"description": "Used to query records that have been added or updated before this time point."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of records to return per page."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Use filter query parameters to limit results\nto data that matches your criteria. See\n[Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.\n\nSupported fields and operators are listed below:\n\n| Field | Operators | Notes |\n|------------------|-------------------------------------|-------|\n| id | `eq`, `ne` | |\n| sourceId | `eq`, `ne` | |\n| firstName | `eq`, `ne`, `contains`, `sw` | |\n| lastName | `eq`, `ne`, `contains`, `sw` | |\n| email | `eq`, `ne`, `contains`, `sw` | |\n| ccEmail | `eq`, `ne` | |\n| company | `eq`, `ne` | |\n| type.id | `eq`, `ne` | |\n| nickname | `eq`, `ne` | |\n| title | `eq`, `ne` | |\n| workPhone | `eq`, `ne` | |\n| middleName | `eq`, `ne` | |\n| mobilePhone | `eq`, `ne` | |\n| homeFax | `eq`, `ne` | |\n| designation | `eq`, `ne` | |\n| homePhone | `eq`, `ne` | |\n| pager | `eq`, `ne` | |\n| workFax | `eq`, `ne` | |\n| lastModifiedBy | `eq`, `ne` | |\n| lastModified | `eq`, `ne`, `lt`, `le`, `gt`, `ge` | |\n| created | `eq`, `ne`, `lt`, `le`, `gt`, `ge` | |\n| createdBy | `eq`, `ne` | |\n| workAddress.address1 | `eq`, `ne` | |\n| workAddress.address2 | `eq`, `ne` | |\n| workAddress.address3 | `eq`, `ne` | |\n| workAddress.city | `eq`, `ne` | |\n| workAddress.country | `eq`, `ne` | |\n| homeAddress.address1 | `eq`, `ne` | |\n| homeAddress.address2 | `eq`, `ne` | |\n| homeAddress.address3 | `eq`, `ne` | |\n| homeAddress.city | `eq`, `ne` | |\n| homeAddress.country | `eq`, `ne` | |\n| deleted | `eq`, `ne` | Filters for deleted contacts. To retrieve purged contacts, see the `includePurged` parameter. |\n| customField.{uuid of custom field} | `eq`, `ne`, `lt`, `le`, `gt`, `ge`, `sw`, `contains` | |\n| optOut.optedOut | `eq`, `ne` | |\n\nThe following logical operators are supported for combining filters:\n* and\n* or\n"
},
{
"name": "includePurged",
"value": "",
"type": "query",
"description": "True means purged contacts can be included in the response. Purged contacts contain only limited display data (`id`, `lastModified`, and `purged`). When true, the filter query parameter can only filter by the `id` field. The `before`, `after`, `limit`, and `token` query parameters are still valid query parameters to use with this parameter. If false, only contacts that have not been purged will be returned.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Gets a paginated list of Contacts.\n\nFor information on reading secure contact fields, see the description of\nGET Contact.\n"
},
{
"info": {
"name": "Create Contacts",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-platform.cvent.com/ea/contacts",
"params": [
{
"name": "upsert",
"value": "",
"type": "query",
"description": "This parameter determines whether the POST operation should be treated as an upsert. Upserts update existing contacts if they already exist, and otherwise create new contacts.\n\nTrue indicates that this operation creates new contacts and updates existing contacts if they exist. False means that it only creates new contacts, and attempting to create an existing contact will result in the API returning an error.\n\nExisting contacts are matched to the upsert request via the account's [match key](https://support.cvent.com/s/communityarticle/Allowing-Multiple-People-to-Use-the-Same-Email-Address). By default, the match key for contacts is their email. The match key can also be altered to match contacts based on a combination of their first name, last name, and email.\n"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Creates a list of contacts based on the values provided in the request body. If you're changing [de-duplication fields](https://support.cvent.com/s/communityarticle/Allowing-Multiple-People-to-Use-the-Same-Email-Address), the new values must be unique in your account.\nFor information on creating contacts with secure contact fields, see the description of PUT Contact.\n"
},
{
"info": {
"name": "Update Contacts",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-platform.cvent.com/ea/contacts",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates a list of contacts based on the values provided in the request body. If you're changing [de-duplication fields](https://support.cvent.com/s/communityarticle/Allowing-Multiple-People-to-Use-the-Same-Email-Address), the new values must be unique in your account.\nFor information on updating secure contact fields, see the description of PUT Contact.\n"
},
{
"info": {
"name": "Patch Contacts",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api-platform.cvent.com/ea/contacts",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates a list of contacts based on the values provided only, keeping the existing values intact for every contact.\n\nFor information on PATCH behavior, see the description of\nPATCH Contact.\n\nFor information on updating secure contact fields, see the description of\nPUT Contact.\n"
},
{
"info": {
"name": "List Contacts",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-platform.cvent.com/ea/contacts/filter",
"params": [
{
"name": "after",
"value": "",
"type": "query",
"description": "Used to query records that have been added or updated after this time point. Default to the beginning of time of the data store."
},
{
"name": "before",
"value": "",
"type": "query",
"description": "Used to query records that have been added or updated before this time point."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of records to return per page."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Gets a paginated list of Contacts by sending a filter in the body of the request. This method will return the same data as the GET List Contacts but allows for longer filters.\nFor information on reading secure contact fields, see the description of GET Contact.\n"
},
{
"info": {
"name": "Get Obfuscation Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-platform.cvent.com/ea/contacts/obfuscate/:obfuscateId/status",
"params": [
{
"name": "obfuscateId",
"value": "",
"type": "path",
"description": "ID of an obfuscation request."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Get the obfuscation status of a contact by the Obfuscate ID provided."
},
{
"info": {
"name": "Get Contact Change History",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-platform.cvent.com/ea/contacts/:contactId/history",
"params": [
{
"name": "contactId",
"value": "",
"type": "path",
"description": "ID of a contact."
},
{
"name": "before",
"value": "",
"type": "query",
"description": "Used to query records that have been added or updated before this time point."
},
{
"name": "after",
"value": "",
"type": "query",
"description": "Used to query records that have been added or updated after this time point. Default to the beginning of time of the data store."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of records to return per page."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Get the change history for a specific contact."
},
{
"info": {
"name": "Get Contact",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-platform.cvent.com/ea/contacts/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Get a single contact.\n\nWhen reading a contact, the following secure contact fields are only returned when\nalso providing the `event/contacts:read-sensitive` scope:\n * socialSecurityNumber\n * passportNumber\n * nationalIdentificationNumber\n * dateOfBirth\n"
},
{
"info": {
"name": "Update Contact",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-platform.cvent.com/ea/contacts/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates a contact based on contact ID and the values provided in the request body. If you're changing [de-duplication fields](https://support.cvent.com/s/communityarticle/Allowing-Multiple-People-to-Use-the-Same-Email-Address), the new values must be unique in your account.\nWhen writing a contact, the following secure contact fields are only written when also providing the `event/contacts:write-sensitive` scope:\n * socialSecurityNumber\n * passportNumber\n * nationalIdentificationNumber\n * "
},
{
"info": {
"name": "Patch Contact",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api-platform.cvent.com/ea/contacts/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Updates a part of a contact based on the given contactId.\n\nTo update a field, pass the value to be updated. To delete a field, set the field to null. Fields not passed in the request body will remain unchanged.\n\nFor information on updating secure contact fields, see the description of\nPUT Contact.\n"
},
{
"info": {
"name": "Delete Contact",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api-platform.cvent.com/ea/contacts/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a contact from the address book but does not remove the contact from events."
},
{
"info": {
"name": "Update Custom Field Answers",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-platform.cvent.com/ea/contacts/:id/custom-fields/:customFieldId/answers",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact."
},
{
"name": "customFieldId",
"value": "",
"type": "path",
"description": "ID of a custom field."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Update custom field answers for a single custom field and single contact"
},
{
"info": {
"name": "Merge Contacts",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-platform.cvent.com/ea/contacts/:id/merge",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Merges two or three contacts into a single contact."
},
{
"info": {
"name": "Obfuscate a Contact",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api-platform.cvent.com/ea/contacts/:id/obfuscate",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Initiate obfuscation of a contact based on the given ID. Verify the status of the obfuscation using\n[Get Obfuscation Status](#operation/getContactObfuscationStatusById). Once this process succeeds, all\nthe data for the contact will be obfuscated and will no longer be retrievable. See the\n[Obfuscation User Guide](https://developers.cvent.com/docs/rest-api/guides/obfuscation-guide) for\nmore details.\n"
},
{
"info": {
"name": "Assign Contact Profile Picture",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-platform.cvent.com/ea/contacts/:id/profile-images",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Assign a profile picture to a contact with a file UUID from file upload endpoint. This will replace the current profile picture if one is assigned."
},
{
"info": {
"name": "Delete Contact Profile Picture",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api-platform.cvent.com/ea/contacts/:id/profile-images",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes the profile picture of the given contact."
},
{
"info": {
"name": "Get Related Contact Ids",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api-platform.cvent.com/ea/contacts/:id/related-contacts",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of records to return per page."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n"
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Get all contact Ids related to the provided contact."
},
{
"info": {
"name": "Add Contact Relationship",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api-platform.cvent.com/ea/contacts/:id/related-contacts/:relatedContactId",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact."
},
{
"name": "relatedContactId",
"value": "",
"type": "path",
"description": "ID of a related contact."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Adds a single contact relationship between the two contact Ids provided."
},
{
"info": {
"name": "Delete Contact Relationship",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api-platform.cvent.com/ea/contacts/:id/related-contacts/:relatedContactId",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID of a contact."
},
{
"name": "relatedContactId",
"value": "",
"type": "path",
"description": "ID of a related contact."
}
],
"auth": {
"type": "oauth2",
"flow": "client_credentials",
"accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token",
"credentials": {
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}
}
},
"docs": "Deletes a single contact relationship between the two contact Ids provided."
}
]
}
],
"bundled": true
}