How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Genesys

Genesys External Contacts API

External Organizations, contacts, notes and relationships

Documentation Provider Profile APIs.io OpenAPI GitHub

Genesys External Contacts API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include External Contacts. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 134 operations across 92 paths, and defines 235 schemas. It is described by OpenAPI 2.0, at version v2.

Requests are made against the base URL https://api.mypurecloud.com.

134 operations 92 paths 235 schemas 10 DELETE57 GET7 PATCH47 POST13 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
Contact
PureCloud Developer Evangelists
License
UNLICENSED
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Genesys External Contacts API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest Chat JWT).

Paths & Operations 134

Across 92 paths, the API surfaces 134 operations — 10 DELETE, 57 GET, 7 PATCH, 47 POST, 13 PUT. Each is listed below with its method, path, parameters, and response codes.

External Contacts 134

External Organizations, contacts, notes and relationships

POST
/api/v2/externalcontacts/bulk/contacts/remove
Bulk remove contacts
postExternalcontactsBulkContactsRemove 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/contacts/add
Bulk add contacts
postExternalcontactsBulkContactsAdd 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/contacts
Bulk fetch contacts
postExternalcontactsBulkContacts 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/contacts/update
Bulk update contacts
postExternalcontactsBulkContactsUpdate 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/contacts/unresolved
Bulk fetch unresolved ancestor contacts
postExternalcontactsBulkContactsUnresolved 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/contacts/divisionviews
Bulk fetch contacts across divisions
postExternalcontactsBulkContactsDivisionviews 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/contacts/enrich
Bulk Enrich Contacts - Run up to 10 Enrich operations per request
postExternalcontactsBulkContactsEnrich 2 params → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/notes/remove
Bulk remove notes
postExternalcontactsBulkNotesRemove 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/notes
Bulk fetch notes
postExternalcontactsBulkNotes 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/notes/update
Bulk update notes
postExternalcontactsBulkNotesUpdate 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/notes/add
Bulk add notes
postExternalcontactsBulkNotesAdd 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/organizations/add
Bulk add organizations
postExternalcontactsBulkOrganizationsAdd 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/organizations/remove
Bulk remove organizations
postExternalcontactsBulkOrganizationsRemove 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/organizations
Bulk fetch organizations
postExternalcontactsBulkOrganizations 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/organizations/update
Bulk update organizations
postExternalcontactsBulkOrganizationsUpdate 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/organizations/divisionviews
Bulk fetch organizations across divisions
postExternalcontactsBulkOrganizationsDivisionviews 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/organizations/enrich
Bulk enrich external organizations - Run up to 10 Enrich operations per request
postExternalcontactsBulkOrganizationsEnrich 2 params → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/relationships/remove
Bulk remove relationships
postExternalcontactsBulkRelationshipsRemove 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/relationships
Bulk fetch relationships
postExternalcontactsBulkRelationships 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/relationships/update
Bulk update relationships
postExternalcontactsBulkRelationshipsUpdate 1 param → 200422400401403404408409
POST
/api/v2/externalcontacts/bulk/relationships/add
Bulk add relationships
postExternalcontactsBulkRelationshipsAdd 1 param → 200422400401403404408409
GET
/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}
Fetch a note for an external contact
getExternalcontactsContactNote 3 params → 200400401403404408409413
PUT
/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}
Update a note for an external contact
putExternalcontactsContactNote 3 params → 200400401403404408409413
DELETE
/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}
Delete a note for an external contact
deleteExternalcontactsContactNote 2 params → 200400401403404408409413
PATCH
/api/v2/externalcontacts/contacts/{contactId}/notes/{noteId}
Update a Contact Note
patchExternalcontactsContactNote 3 params → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/{contactId}/notes
List notes for an external contact
getExternalcontactsContactNotes 5 params → 200400401403404408409413
POST
/api/v2/externalcontacts/contacts/{contactId}/notes
Create a note for an external contact
postExternalcontactsContactNotes 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/{contactId}
Fetch an external contact
getExternalcontactsContact 2 params → 200400401403404408409413
PUT
/api/v2/externalcontacts/contacts/{contactId}
Update an external contact
putExternalcontactsContact 2 params → 200400401403404408409413
DELETE
/api/v2/externalcontacts/contacts/{contactId}
Delete an external contact
deleteExternalcontactsContact 1 param → 200400401403404408409413
PATCH
/api/v2/externalcontacts/contacts/{contactId}
Update specific fields of an external contact
patchExternalcontactsContact 2 params → 200400401403404408409413
POST
/api/v2/externalcontacts/contacts/{contactId}/promotion
Promote an observed contact (ephemeral or identified) to a curated contact
postExternalcontactsContactPromotion 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/{contactId}/identifiers
List the identifiers for a contact
getExternalcontactsContactIdentifiers 1 param → 200400401403404408409413
PATCH
/api/v2/externalcontacts/contacts/{contactId}/identifiers
Claim or release identifiers for a contact
patchExternalcontactsContactIdentifiers 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/schemas/{schemaId}
Get a schema
getExternalcontactsContactsSchema 1 param → 200400401403404408409413
PUT
/api/v2/externalcontacts/contacts/schemas/{schemaId}
Update a schema
putExternalcontactsContactsSchema 2 params → 200400401403404408409413
DELETE
/api/v2/externalcontacts/contacts/schemas/{schemaId}
Delete a schema
deleteExternalcontactsContactsSchema 1 param → 204400401403404408409413
GET
/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId}
Get a specific version of a schema
getExternalcontactsContactsSchemaVersion 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/schemas/{schemaId}/versions
Get all versions of an external contact's schema
getExternalcontactsContactsSchemaVersions 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/schemas
Get a list of schemas.
getExternalcontactsContactsSchemas → 200400401403404408409413
POST
/api/v2/externalcontacts/contacts/schemas
Create a schema
postExternalcontactsContactsSchemas 1 param → 200400401403404408409413
POST
/api/v2/externalcontacts/merge/contactsdeprecated
Merge two contacts into a new contact record
postExternalcontactsMergeContacts 1 param → 200400401403404408409413
POST
/api/v2/externalcontacts/contacts/merge
Merge up to 25 contacts into a new contact record
postExternalcontactsContactsMerge 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts
Search for external contacts
getExternalcontactsContacts 6 params → 200400401403404408409413
POST
/api/v2/externalcontacts/contacts
Create an external contact
postExternalcontactsContacts 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/scan/contacts/divisionviews/all
Scan for external contacts using paging
getExternalcontactsScanContactsDivisionviewsAll 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/scan/contacts
Scan for external contacts using paging
getExternalcontactsScanContacts 3 params → 200400401403404408409413
PUT
/api/v2/externalcontacts/conversations/{conversationId}
Associate/disassociate an external contact with a conversation
putExternalcontactsConversation 2 params → 202400401403404408409413
POST
/api/v2/externalcontacts/contacts/enrich
Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts.
postExternalcontactsContactsEnrich 2 params → 200201422400401403404408
POST
/api/v2/externalcontacts/organizations/enrich
Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs.
postExternalcontactsOrganizationsEnrich 2 params → 200201422400401403404408
GET
/api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts
Search for external contacts in an external organization
getExternalcontactsOrganizationContacts 6 params → 200400401403404408409413
GET
/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers
List the identifiers for an external organization
getExternalcontactsOrganizationIdentifiers 1 param → 200400401403404408409413
PATCH
/api/v2/externalcontacts/organizations/{externalOrganizationId}/identifiers
Claim or release identifiers for an external organization
patchExternalcontactsOrganizationIdentifiers 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}
Fetch a note for an external organization
getExternalcontactsOrganizationNote 3 params → 200400401403404408409413
PUT
/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}
Update a note for an external organization
putExternalcontactsOrganizationNote 3 params → 200400401403404408409413
DELETE
/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}
Delete a note for an external organization
deleteExternalcontactsOrganizationNote 2 params → 200400401403404408409413
PATCH
/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId}
Update an External Organization Note
patchExternalcontactsOrganizationNote 3 params → 200400401403404408409413
GET
/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes
List notes for an external organization
getExternalcontactsOrganizationNotes 5 params → 200400401403404408409413
POST
/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes
Create a note for an external organization
postExternalcontactsOrganizationNotes 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships
Fetch a relationship for an external organization
getExternalcontactsOrganizationRelationships 5 params → 200400401403404408409413
GET
/api/v2/externalcontacts/organizations/{externalOrganizationId}
Fetch an external organization
getExternalcontactsOrganization 3 params → 200400401403404408409413
PUT
/api/v2/externalcontacts/organizations/{externalOrganizationId}
Update an external organization
putExternalcontactsOrganization 2 params → 200400401403404408409413
DELETE
/api/v2/externalcontacts/organizations/{externalOrganizationId}
Delete an external organization
deleteExternalcontactsOrganization 1 param → 200400401403404408409413
PATCH
/api/v2/externalcontacts/organizations/{externalOrganizationId}
Update specific fields of an external organization
patchExternalcontactsOrganization 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/organizations/schemas/{schemaId}
Get a schema
getExternalcontactsOrganizationsSchema 1 param → 200400401403404408409413
PUT
/api/v2/externalcontacts/organizations/schemas/{schemaId}
Update a schema
putExternalcontactsOrganizationsSchema 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId}
Get a specific version of a schema
getExternalcontactsOrganizationsSchemaVersion 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/organizations/schemas/{schemaId}/versions
Get all versions of an external organization's schema
getExternalcontactsOrganizationsSchemaVersions 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/organizations/schemas
Get a list of schemas.
getExternalcontactsOrganizationsSchemas → 200400401403404408409413
POST
/api/v2/externalcontacts/organizations/schemas
Create a schema
postExternalcontactsOrganizationsSchemas 1 param → 200400401403404408409413
PUT
/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId}
Links a Trustor with an External Organization
putExternalcontactsOrganizationTrustorTrustorId 2 params → 200400401403404408409413
DELETE
/api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor
Unlink the Trustor for this External Organization
deleteExternalcontactsOrganizationTrustor 1 param → 204400401403404408409413
GET
/api/v2/externalcontacts/organizations
Search for external organizations
getExternalcontactsOrganizations 8 params → 200400401403404408409413
POST
/api/v2/externalcontacts/organizations
Create an external organization
postExternalcontactsOrganizations 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/scan/organizations/divisionviews/all
Scan for external organizations using paging
getExternalcontactsScanOrganizationsDivisionviewsAll 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/scan/organizations
Scan for external organizations using paging
getExternalcontactsScanOrganizations 3 params → 200400401403404408409413
GET
/api/v2/externalcontacts/externalsources/{externalSourceId}
Fetch an External Source
getExternalcontactsExternalsource 1 param → 200400401403404408409413
PUT
/api/v2/externalcontacts/externalsources/{externalSourceId}
Update an External Source
putExternalcontactsExternalsource 2 params → 200400401403404408409413
DELETE
/api/v2/externalcontacts/externalsources/{externalSourceId}
Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully…
deleteExternalcontactsExternalsource 1 param → 200204400401403404408409
GET
/api/v2/externalcontacts/externalsources
Fetch a list of External Sources
getExternalcontactsExternalsources 4 params → 200400401403404408409413
POST
/api/v2/externalcontacts/externalsources
Create an External Source
postExternalcontactsExternalsources 1 param → 200400401403404408409413
POST
/api/v2/externalcontacts/identifierlookup/contacts
Fetch a contact using an identifier type and value.
postExternalcontactsIdentifierlookupContacts 2 params → 200400401403404408409413
POST
/api/v2/externalcontacts/identifierlookup/organizations
Fetch an external organization using an identifier type and value.
postExternalcontactsIdentifierlookupOrganizations 2 params → 200400401403404408409413
POST
/api/v2/externalcontacts/identifierlookupdeprecated
Fetch a contact using an identifier type and value.
postExternalcontactsIdentifierlookup 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/{contactId}/journey/segments
Retrieve segment assignments by external contact ID.
getExternalcontactsContactJourneySegments 3 params → 200400401403404408409413
POST
/api/v2/externalcontacts/contacts/{contactId}/journey/segments
Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned…
postExternalcontactsContactJourneySegments 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/{contactId}/journey/sessions
Retrieve all sessions for a given external contact.
getExternalcontactsContactJourneySessions 4 params → 200400401403404408409413
GET
/api/v2/externalcontacts/scan/notes/divisionviews/all
Scan for notes using paging
getExternalcontactsScanNotesDivisionviewsAll 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/scan/notes
Scan for notes using paging
getExternalcontactsScanNotes 3 params → 200400401403404408409413
GET
/api/v2/externalcontacts/relationships/{relationshipId}
Fetch a relationship
getExternalcontactsRelationship 2 params → 200400401403404408409413
PUT
/api/v2/externalcontacts/relationships/{relationshipId}
Update a relationship
putExternalcontactsRelationship 2 params → 200400401403404408409413
DELETE
/api/v2/externalcontacts/relationships/{relationshipId}
Delete a relationship
deleteExternalcontactsRelationship 1 param → 200400401403404408409413
PATCH
/api/v2/externalcontacts/relationships/{relationshipId}
Update specific fields of a relationship
patchExternalcontactsRelationship 2 params → 200400401403404408409413
POST
/api/v2/externalcontacts/relationships
Create a relationship
postExternalcontactsRelationships 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/scan/relationships/divisionviews/all
Scan for relationships
getExternalcontactsScanRelationshipsDivisionviewsAll 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/scan/relationships
Scan for relationships
getExternalcontactsScanRelationships 3 params → 200400401403404408409413
GET
/api/v2/externalcontacts/reversewhitepageslookup
Look up contacts based on an attribute. Maximum of 25 values returned.
getExternalcontactsReversewhitepageslookup 3 params → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/{contactId}/unresolved
Fetch an unresolved external contact
getExternalcontactsContactUnresolved 2 params → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/schemas/coretypes/{coreTypeName}
Get a specific named core type.
getExternalcontactsContactsSchemasCoretype 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/schemas/coretypes
Get the core types from which all schemas are built.
getExternalcontactsContactsSchemasCoretypes → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/schemas/limits
Get quantitative limits on schemas
getExternalcontactsContactsSchemasLimits → 200400401403404408409413
GET
/api/v2/externalcontacts/organizations/schemas/coretypes/{coreTypeName}
Get a specific named core type.
getExternalcontactsOrganizationsSchemasCoretype 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/organizations/schemas/coretypes
Get the core types from which all schemas are built.
getExternalcontactsOrganizationsSchemasCoretypes → 200400401403404408409413
GET
/api/v2/externalcontacts/organizations/schemas/limits
Get quantitative limits on schemas
getExternalcontactsOrganizationsSchemasLimits → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/exports/{exportId}
Get export for exportId
getExternalcontactsContactsExport 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/contacts/exports
List contact exports for organization
getExternalcontactsContactsExports 3 params → 200400401403404408409413
POST
/api/v2/externalcontacts/contacts/exports
Create bulk export
postExternalcontactsContactsExports 1 param → 201400401403404408409413
GET
/api/v2/externalcontacts/notes/exports/{exportId}
Get notes export for exportId
getExternalcontactsNotesExport 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/notes/exports
List note exports for organization
getExternalcontactsNotesExports 3 params → 200400401403404408409413
POST
/api/v2/externalcontacts/notes/exports
Create notes export
postExternalcontactsNotesExports 1 param → 201400401403404408409413
GET
/api/v2/externalcontacts/organizations/exports/{exportId}
Get organizations export for exportId
getExternalcontactsOrganizationsExport 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/organizations/exports
List organization exports for organization
getExternalcontactsOrganizationsExports 3 params → 200400401403404408409413
POST
/api/v2/externalcontacts/organizations/exports
Create organizations export
postExternalcontactsOrganizationsExports 1 param → 201400401403404408409413
GET
/api/v2/externalcontacts/relationships/exports/{exportId}
Get relationships export for exportId
getExternalcontactsRelationshipsExport 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/relationships/exports
List relationship exports for organization
getExternalcontactsRelationshipsExports 3 params → 200400401403404408409413
POST
/api/v2/externalcontacts/relationships/exports
Create relationships export
postExternalcontactsRelationshipsExports 1 param → 201400401403404408409413
GET
/api/v2/externalcontacts/import/jobs/{jobId}
Get job based on id
getExternalcontactsImportJob 2 params → 200400401403404408409413
PUT
/api/v2/externalcontacts/import/jobs/{jobId}
Update Job's workflow status
putExternalcontactsImportJob 2 params → 200202400401403404408409
GET
/api/v2/externalcontacts/import/jobs
List jobs for organization
getExternalcontactsImportJobs 5 params → 200400401403404408409413
POST
/api/v2/externalcontacts/import/jobs
Create a new job
postExternalcontactsImportJobs 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/import/settings/{settingsId}
Get setting based on id
getExternalcontactsImportSetting 1 param → 200400401403404408409413
PUT
/api/v2/externalcontacts/import/settings/{settingsId}
Update settings
putExternalcontactsImportSetting 2 params → 200400401403404408409413
DELETE
/api/v2/externalcontacts/import/settings/{settingsId}
Delete Settings
deleteExternalcontactsImportSetting 1 param → 204400401403404408409413
GET
/api/v2/externalcontacts/import/settings
List settings for organization
getExternalcontactsImportSettings 4 params → 200400401403404408409413
POST
/api/v2/externalcontacts/import/settings
Create a new settings
postExternalcontactsImportSettings 1 param → 200400401403404408409413
POST
/api/v2/externalcontacts/import/csv/jobs
Create CSV import job
postExternalcontactsImportCsvJobs 1 param → 202400401403404408409413
GET
/api/v2/externalcontacts/import/csv/settings/{settingsId}
Get settings for CSV import
getExternalcontactsImportCsvSetting 1 param → 200400401403404408409413
PUT
/api/v2/externalcontacts/import/csv/settings/{settingsId}
Update settings for CSV import
putExternalcontactsImportCsvSetting 2 params → 200400401403404408409413
DELETE
/api/v2/externalcontacts/import/csv/settings/{settingsId}
Delete settings for CSV import
deleteExternalcontactsImportCsvSetting 1 param → 204400401403404408409413
GET
/api/v2/externalcontacts/import/csv/settings
Retrieve all settings for organization filtered by externalSettingsId if provided
getExternalcontactsImportCsvSettings 3 params → 200400401403404408409413
POST
/api/v2/externalcontacts/import/csv/settings
Create settings for CSV import
postExternalcontactsImportCsvSettings 1 param → 201400401403404408409413
GET
/api/v2/externalcontacts/import/csv/uploads/{uploadId}/details
Get details for CSV upload
getExternalcontactsImportCsvUploadDetails 1 param → 200400401403404408409413
GET
/api/v2/externalcontacts/import/csv/uploads/{uploadId}/preview
Get preview for CSV upload
getExternalcontactsImportCsvUploadPreview 1 param → 200400401403404408409413
POST
/api/v2/externalcontacts/import/csv/uploads
Get url for CSV upload
postExternalcontactsImportCsvUploads 1 param → 201400401403404408409413

Schemas 235

The contract defines 235 schemas that model the data the API accepts and returns. The most detailed are Session (51 properties), OrgUser (39 properties), User (39 properties), ExternalContact (38 properties). Each schema is shown below with its type and property counts.

SegmentAssignmentSegment
object
2 properties 1 required
Team
object
8 properties 1 required
WorkPlanBidRanks
object
4 properties
Trustor
object
7 properties 1 required
AddressableEntityRef
object
2 properties
JsonSchemaDocument
object
A JSON Schema document.
8 properties
ExternalId
object
2 properties 2 required
UnprocessedSegmentAssignments
object
3 properties 1 required
CursorExternalSourceListing
object
5 properties
SegmentAssignment
object
5 properties 4 required
ContactImportField
object
2 properties 2 required
ResourcePermissionPolicy
object
11 properties
CustomEventAttribute
object
2 properties 2 required
WritableDivision
object
3 properties
WhatsAppId
object
User information for a WhatsApp account
2 properties 1 required
Cursors
object
2 properties
NoteListing
object
11 properties
ContactListing
object
11 properties
TwitterId
object
User information for a twitter account. Either id OR screenName (or both) must be present
5 properties
BulkResponseResultExternalContactContactEnrichRequestBulkEntityErrorContactEnrichRequest
object
5 properties
UserStations
object
4 properties
MergeContactsRequest
object
2 properties 1 required
NotesExportQueryConditions
object
2 properties
OAuthLastTokenIssued
object
1 property
MediaSummary
object
2 properties
SdkLibrary
object
2 properties 2 required
CoretypeListing
object
3 properties
LocationAddressVerificationDetails
object
4 properties
BulkFetchOrganizationsResponse
object
3 properties
BulkNotesResponse
object
3 properties
ContactAddress
object
6 properties
RelationshipsExportQueryConditions
object
2 properties
BulkOrganizationsResponse
object
3 properties
Referrer
object
9 properties 5 required
BulkEntityErrorNote
object
6 properties
MaxLength
object
2 properties 2 required
ExternalOrganizationTrustorLink
object
5 properties
FacebookScopedId
object
Scoped ID for a Facebook user interacting with a page or app
1 property 1 required
Geolocation
object
11 properties
NotesExportFieldListFilter
object
2 properties 2 required
OrganizationsExportFieldFilter
object
2 properties 2 required
ExternalSource
object
5 properties 1 required
ConversationUserDisposition
object
3 properties 2 required
ExternalOrganizationListing
object
11 properties
OrganizationsExportQueryConditions
object
2 properties
BulkContactsEnrichRequest
object
1 property
Listing
object
4 properties
BulkEntityErrorExternalOrganization
object
6 properties
UserRoutingLanguage
object
Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
6 properties
CsvUploadPreviewResponse
object
3 properties 3 required
UpdateSegmentAssignmentRequest
object
2 properties
OrganizationsExportFilter
object
7 properties
ContactsExport
object
10 properties
BulkResponseResultExternalOrganizationExternalOrganizationEnrichRequestBulkEntityErrorExternalOrganizationEnrichRequest
object
5 properties
BulkNotesRequest
object
1 property
BulkRelationshipsResponse
object
3 properties
ExternalOrganizationEnrichRequest
object
6 properties
CursorRelationshipListing
object
5 properties
ContactsPatchChange
object
3 properties 2 required
ContactImportSettings
object
8 properties 4 required
DataSchemaListing
object
3 properties
AssignedSegment
object
2 properties 1 required
ContactIdentifierListing
object
1 property
ConnectedQueue
object
2 properties
RelationshipsExportFilter
object
7 properties
BulkResponseResultVoidEntityBulkEntityErrorEntity
object
5 properties
BulkOrganizationsRequest
object
1 property
ContactImportJobStatusUpdateResponse
object
2 properties
BulkResponseResultRelationshipRelationshipBulkEntityErrorRelationship
object
5 properties
NotesExportListing
object
4 properties
User
object
39 properties 1 required
MediaSummaryDetail
object
2 properties
CsvUploadDetailsResponse
object
3 properties 2 required
NotesExportFilter
object
7 properties
Biography
object
5 properties
RelationshipsExportFieldFilter
object
2 properties 2 required
CsvUploadResponse
object
3 properties 3 required
ExternalDataSource
object
Describes a link to a record in an external system that contributed data to a Relate record
2 properties
TrusteeAuthorization
object
1 property
ContactImportSettingsEntityListing
object
5 properties
LineId
object
User information for a Line account
2 properties 1 required
RelationshipsExportComparisonFieldFilter
object
2 properties 2 required
IdentifierClaimRequest
object
2 properties 2 required
CursorOrganizationListing
object
5 properties
MergeRequest
object
2 properties 2 required
ContactAddressableEntityRef
object
2 properties
ResourceConditionNode
object
5 properties
BulkOrganizationsEnrichResponse
object
3 properties
SegmentForUnassignment
object
1 property 1 required
MinLength
object
2 properties 2 required
SegmentUnassignments
object
1 property 1 required
BulkResponseResultExternalOrganizationExternalOrganizationBulkEntityErrorExternalOrganization
object
5 properties
SessionLastEvent
object
3 properties 3 required
UpdateSegmentAssignmentResponse
object
1 property 1 required
MergeOperation
object
3 properties
DomainEntityRef
object
3 properties
ContactsExportFieldListFilter
object
2 properties 2 required
ConversationAssociation
object
4 properties 3 required
ContactImportJobEntityListing
object
5 properties
CursorNoteListing
object
5 properties
OrganizationsExportListing
object
4 properties
Empty
object
SegmentAssignments
object
1 property 1 required
ValidationResult
object
3 properties 3 required
BulkIdsRequest
object
1 property
ExternalContactsEntity
object
1 property
CustomEventAttributeList
object
2 properties 2 required
ContactImportJobRequest
object
2 properties 1 required
BulkDeleteResponse
object
3 properties
DomainRole
object
2 properties
RelationshipsExportListing
object
4 properties
CsvMappingEntry
object
2 properties 2 required
OrganizationsExport
object
10 properties
NetworkConnectivity
object
4 properties 3 required
BulkOrganizationsEnrichRequest
object
1 property
UserRoutingSkill
object
Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
6 properties
OrgUser
object
39 properties 1 required
PresenceDefinition
object
3 properties
BulkEntityErrorExternalContact
object
6 properties
Detail
object
4 properties
CursorContactListing
object
5 properties
Organization
object
15 properties 1 required
BulkFetchNotesResponse
object
3 properties
ReverseWhitepagesLookupResult
object
1 property
ExternalOrganizationIdentifierClaimRequest
object
2 properties 2 required
ExternalOrganizationIdentifierListing
object
1 property
DataSchema
object
9 properties 2 required
InstagramId
object
User information for an Instagram account
3 properties 1 required
UserAuthorization
object
4 properties
ConversationChannel
object
3 properties 1 required
ContactsExportQueryConditions
object
2 properties
NotesExport
object
10 properties
StarrableDivision
object
3 properties
BulkEntityErrorRelationship
object
6 properties
ExternalOrganizationIdentifier
object
5 properties 2 required
OutOfOffice
object
8 properties
ValidationLimits
object
6 properties
UserPresence
object
10 properties
LineUserId
object
Channel-specific User ID for Line accounts
1 property 1 required
LocationEmergencyNumber
object
3 properties
Entity
object
1 property
SegmentForAssignment
object
1 property 1 required
AchievedOutcome
object
2 properties 1 required
EmployerInfo
object
4 properties
OutcomeAchievement
object
2 properties 2 required
ContactIdentifier
object
5 properties 2 required
BulkContactsResponse
object
3 properties
Device
object
10 properties 5 required
ContactImportJobMetadata
object
7 properties
Ticker
object
2 properties 2 required
BulkErrorDetail
object
3 properties
ContactImportJobResponse
object
9 properties 1 required
RoutingStatus
object
3 properties
ResourceConditionValue
object
2 properties
Browser
object
11 properties 6 required
BulkFetchRelationshipsResponse
object
3 properties
Void
object
ContactEnrichOptions
object
1 property
BulkResponseResultExternalOrganizationEntityBulkEntityErrorEntity
object
5 properties
Limit
object
3 properties
JourneyCaseAssociation
object
The representation of a case association on a journey session.
5 properties 1 required
BulkRelationshipsRequest
object
1 property
JourneyPage
object
10 properties 5 required
JourneyGeolocation
object
10 properties
ContactsExportListing
object
4 properties
BulkFetchContactsResponse
object
3 properties
BulkEntityErrorContactEnrichRequest
object
6 properties
Chat
object
1 property
EnrichFieldRules
object
3 properties
GroupContact
object
5 properties 3 required
CsvSettings
object
4 properties 1 required
FacebookId
object
User information for a Facebook user interacting with a page or app
2 properties 1 required
CsvUploadRequest
object
2 properties 1 required
CsvJobResponse
object
1 property 1 required
Contact
object
7 properties
LocationDefinition
object
16 properties
SessionListing
object
4 properties
NotesExportFieldFilter
object
2 properties 2 required
RelationshipsExportFieldListFilter
object
2 properties 2 required
ContactsExportComparisonFieldFilter
object
2 properties 2 required
Items
object
2 properties
ContactsExportFilter
object
7 properties
UserConversationSummary
object
8 properties
SchemaQuantityLimits
object
16 properties
Image
object
2 properties
Note
object
10 properties 1 required
Header
object
2 properties
Education
object
5 properties
Coretype
object
11 properties
RelationshipListing
object
11 properties
NotesExportComparisonFieldFilter
object
2 properties 2 required
SessionSegmentAssignment
object
2 properties 2 required
ErrorBody
object
11 properties
LocationImage
object
2 properties
Division
object
3 properties
Relationship
object
7 properties 3 required
SegmentAssignmentSession
object
3 properties 2 required
RelationshipsExport
object
10 properties
InstagramScopedId
object
Scoped ID for an Instagram user interacting with a page or app
1 property 1 required
BulkEntityErrorExternalOrganizationEnrichRequest
object
6 properties
BulkResponseResultRelationshipEntityBulkEntityErrorEntity
object
5 properties
ContactImportJobStatusUpdateRequest
object
2 properties 2 required
WritableStarrableDivision
object
3 properties
BulkResponseResultNoteNoteBulkEntityErrorNote
object
5 properties
UserStation
object
8 properties
ExternalOrganization
object
24 properties 1 required
ContactsExportFieldFilter
object
2 properties 2 required
ExternalContact
object
38 properties
Group
object
17 properties 4 required
BulkResponseResultNoteEntityBulkEntityErrorEntity
object
5 properties
Location
object
5 properties
EnrichFieldRule
object
3 properties
BulkContactsRequest
object
1 property
Session
object
51 properties 6 required
OrganizationsExportFieldListFilter
object
2 properties 2 required
BulkResponseResultExternalContactEntityBulkEntityErrorEntity
object
5 properties
BulkResponseResultExternalContactExternalContactBulkEntityErrorExternalContact
object
5 properties
BulkContactsEnrichResponse
object
3 properties
OrganizationsExportComparisonFieldFilter
object
2 properties 2 required
JourneyApp
object
4 properties 4 required
ConnectedUser
object
2 properties
LinkConfiguration
object
1 property 1 required
SegmentAssignmentListing
object
1 property
ErrorInfo
object
2 properties
Schema
object
5 properties
CsvJobRequest
object
3 properties 2 required
AppleOpaqueId
object
1 property
PhoneNumber
object
7 properties
BulkEntityErrorEntity
object
6 properties
ContactEnrichRequest
object
7 properties 2 required
ValidationError
object
2 properties 2 required
LocationAddress
object
7 properties
ItemValidationLimits
object
2 properties 2 required
ExternalContactsPatchRequest
object
1 property
JourneyCampaign
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-external-contacts-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
AE Profile APIs.io
Genesys Agent Copilot API
AE Profile APIs.io
Genesys Agent UI API
AE Profile APIs.io
Genesys AI Studio API
AE Profile APIs.io
Genesys Alerting API
AE Profile APIs.io
Genesys Analytics API
AE Profile APIs.io
Genesys Architect API
AE Profile APIs.io
Genesys Assistant Copilot Variations API
AE Profile APIs.io
Genesys Audit API
AE Profile APIs.io
Genesys Authorization API
AE Profile APIs.io
Genesys Background Assistant API
AE Profile APIs.io
Genesys Billing API
AE Profile APIs.io
#External Contacts
← Back to G APIs
API Details
ID
genesys:genesys-external-contacts-api
Base URL
https://api.mypurecloud.com
Docs
https://developer.genesys.cloud/platform/api/
Provider
Genesys
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=genesys-external-contacts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-external-contacts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Genesys External Contacts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.