Skip to main content
Server path: /genesys-contacts | Type: Application | PCID required: Yes

Tools

ToolDescription
genesys_contacts_delete_contactDelete an external contact
genesys_contacts_delete_contact_noteDelete a note for an external contact
genesys_contacts_delete_externalsourceDelete 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 viewable.
genesys_contacts_delete_organizationDelete an external organization
genesys_contacts_delete_organization_noteDelete a note for an external organization
genesys_contacts_delete_organization_trustorUnlink the Trustor for this External Organization
genesys_contacts_delete_relationshipDelete a relationship
genesys_contacts_get_contactFetch an external contact
genesys_contacts_get_contact_identifiersList the identifiers for a contact
genesys_contacts_get_contact_journey_segmentsRetrieve segment assignments by external contact ID.
genesys_contacts_get_contact_journey_sessionsRetrieve all sessions for a given external contact.
genesys_contacts_get_contact_noteFetch a note for an external contact
genesys_contacts_get_contact_notesList notes for an external contact
genesys_contacts_get_contact_unresolvedFetch an unresolved external contact
genesys_contacts_get_contactsSearch for external contacts
genesys_contacts_get_externalcontacts_contactFetch an external contact
genesys_contacts_get_externalcontacts_contact_noteFetch a note for an external contact
genesys_contacts_get_externalcontacts_contact_notesList notes for an external contact
genesys_contacts_get_externalcontacts_contactsSearch for external contacts
genesys_contacts_get_externalcontacts_organizationFetch an external organization
genesys_contacts_get_externalcontacts_organization_contactsSearch for external contacts in an external organization
genesys_contacts_get_externalcontacts_organization_notesList notes for an external organization
genesys_contacts_get_externalcontacts_organizationsSearch for external organizations
genesys_contacts_get_externalsourceFetch an External Source
genesys_contacts_get_externalsourcesFetch a list of External Sources
genesys_contacts_get_organizationFetch an external organization
genesys_contacts_get_organization_contactsSearch for external contacts in an external organization
genesys_contacts_get_organization_identifiersList the identifiers for an external organization
genesys_contacts_get_organization_noteFetch a note for an external organization
genesys_contacts_get_organization_notesList notes for an external organization
genesys_contacts_get_organization_relationshipsFetch a relationship for an external organization
genesys_contacts_get_organizationsSearch for external organizations
genesys_contacts_get_relationshipFetch a relationship
genesys_contacts_get_reversewhitepageslookupLook up contacts based on an attribute. Maximum of 25 values returned.
genesys_contacts_patch_contact_identifiersClaim or release identifiers for a contact
genesys_contacts_patch_organization_identifiersClaim or release identifiers for an external organization
genesys_contacts_post_contact_journey_segmentsAssign/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 in the body for the client to retry, in the event of a partial success.
genesys_contacts_post_contact_notesCreate a note for an external contact
genesys_contacts_post_contact_promotionPromote an observed contact (ephemeral or identified) to a curated contact
genesys_contacts_post_contactsCreate an external contact
genesys_contacts_post_enrichModify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts.
genesys_contacts_post_externalcontacts_contact_notesCreate a note for an external contact
genesys_contacts_post_externalcontacts_contactsCreate an external contact
genesys_contacts_post_externalcontacts_identifierlookup_contactsFetch a contact using an identifier type and value.
genesys_contacts_post_externalsourcesCreate an External Source
genesys_contacts_post_identifierlookup_contactsFetch a contact using an identifier type and value.
genesys_contacts_post_identifierlookup_organizationsFetch an external organization using an identifier type and value.
genesys_contacts_post_mergeMerge up to 25 contacts into a new contact record
genesys_contacts_post_organization_notesCreate a note for an external organization
genesys_contacts_post_organizationsCreate an external organization
genesys_contacts_post_organizations_enrichModify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs.
genesys_contacts_post_relationshipsCreate a relationship
genesys_contacts_put_contactUpdate an external contact
genesys_contacts_put_contact_noteUpdate a note for an external contact
genesys_contacts_put_conversationAssociate/disassociate an external contact with a conversation
genesys_contacts_put_externalcontacts_contactUpdate an external contact
genesys_contacts_put_externalsourceUpdate an External Source
genesys_contacts_put_organizationUpdate an external organization
genesys_contacts_put_organization_noteUpdate a note for an external organization
genesys_contacts_put_organization_trustor_trustor_idLinks a Trustor with an External Organization
genesys_contacts_put_relationshipUpdate a relationship

genesys_contacts_delete_contact

Delete an external contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact ID

genesys_contacts_delete_contact_note

Delete a note for an external contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact Id
noteIdstringYesNote Id

genesys_contacts_delete_externalsource

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 viewable. Parameters:
ParameterTypeRequiredDefaultDescription
externalSourceIdstringYesExternal Source ID

genesys_contacts_delete_organization

Delete an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization ID

genesys_contacts_delete_organization_note

Delete a note for an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization Id
noteIdstringYesNote Id

genesys_contacts_delete_organization_trustor

Unlink the Trustor for this External Organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization ID

genesys_contacts_delete_relationship

Delete a relationship Parameters:
ParameterTypeRequiredDefaultDescription
relationshipIdstringYesRelationship Id

genesys_contacts_get_contact

Fetch an external contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact ID
expandany[]Nowhich fields, if any, to expand

genesys_contacts_get_contact_identifiers

List the identifiers for a contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact ID

genesys_contacts_get_contact_journey_segments

Retrieve segment assignments by external contact ID. Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact ID
includeMergedbooleanNoIndicates whether to return segment assignments from all external contacts in the merge-set of the given one.
limitintegerNoNumber of entities to return. Default of 25, maximum of 500.

genesys_contacts_get_contact_journey_sessions

Retrieve all sessions for a given external contact. Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact ID
pageSizestringNoNumber of entities to return. Maximum of 200.
afterstringNoThe cursor that points to the end of the set of entities that has been returned.
includeMergedbooleanNoIndicates whether to return sessions from all external contacts in the merge-set of the given one.

genesys_contacts_get_contact_note

Fetch a note for an external contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact Id
noteIdstringYesNote Id
expandany[]Nowhich fields, if any, to expand

genesys_contacts_get_contact_notes

List notes for an external contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact Id
pageSizeintegerNoPage size (limited to fetching first 1,000 records; pageSize <= 100; pageNumber * pageSize must be <= 1,000)
pageNumberintegerNoPage number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
sortOrderstringNoThe Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. “createDate:asc”, “createDate:desc”
expandany[]Nowhich fields, if any, to expand. mergeset will include notes attached to ancestor contacts which have been merged into this one.

genesys_contacts_get_contact_unresolved

Fetch an unresolved external contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact ID
expandany[]Nowhich fields, if any, to expand

genesys_contacts_get_contacts

Search for external contacts Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
pageNumberintegerNoPage number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
qstringNoUser supplied search keywords (no special syntax is currently supported)
sortOrderstringNoThe External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. “firstName:asc”, “title:desc”
expandany[]Nowhich fields, if any, to expand
divisionIdsany[]Nowhich divisions to search, up to 50

genesys_contacts_get_externalcontacts_contact

Fetch an external contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact ID
expandany[]Nowhich fields, if any, to expand

genesys_contacts_get_externalcontacts_contact_note

Fetch a note for an external contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact Id
noteIdstringYesNote Id
expandany[]Nowhich fields, if any, to expand

genesys_contacts_get_externalcontacts_contact_notes

List notes for an external contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact Id
pageSizeintegerNoPage size (limited to fetching first 1,000 records; pageSize <= 100; pageNumber * pageSize must be <= 1,000)
pageNumberintegerNoPage number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
sortOrderstringNoThe Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. “createDate:asc”, “createDate:desc”
expandany[]Nowhich fields, if any, to expand. mergeset will include notes attached to ancestor contacts which have been merged into this one.

genesys_contacts_get_externalcontacts_contacts

Search for external contacts Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
pageNumberintegerNoPage number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
qstringNoUser supplied search keywords (no special syntax is currently supported)
sortOrderstringNoThe External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. “firstName:asc”, “title:desc”
expandany[]Nowhich fields, if any, to expand
divisionIdsany[]Nowhich divisions to search, up to 50

genesys_contacts_get_externalcontacts_organization

Fetch an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization ID
expandany[]Nowhich fields, if any, to expand
includeTrustorsbooleanNo(true or false) whether or not to include trustor information embedded in the externalOrganization

genesys_contacts_get_externalcontacts_organization_contacts

Search for external contacts in an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization ID
pageSizeintegerNoPage size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
pageNumberintegerNoPage number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
qstringNoUser supplied search keywords (no special syntax is currently supported)
sortOrderstringNoThe External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. “firstName:asc”, “title:desc”
expandany[]Nowhich fields, if any, to expand

genesys_contacts_get_externalcontacts_organization_notes

List notes for an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization Id
pageSizeintegerNoPage size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
pageNumberintegerNoPage number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
sortOrderstringNoThe Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. “createDate:asc”, “createDate:desc”
expandany[]Nowhich fields, if any, to expand

genesys_contacts_get_externalcontacts_organizations

Search for external organizations Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
pageNumberintegerNoPage number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
qstringNoSearch query
trustorIdany[]NoSearch for external organizations by trustorIds (limit 25). If supplied, the ‘q’ parameters is ignored. Items are returned in the order requested
sortOrderstringNoThe Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. “companyType:asc”, “industry:desc”
expandany[]Nowhich fields, if any, to expand
includeTrustorsbooleanNo(true or false) whether or not to include trustor information embedded in the externalOrganization
divisionIdsany[]Nowhich divisions to search, up to 50

genesys_contacts_get_externalsource

Fetch an External Source Parameters:
ParameterTypeRequiredDefaultDescription
externalSourceIdstringYesExternal Source ID

genesys_contacts_get_externalsources

Fetch a list of External Sources Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoIndicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
limitintegerNoThe number of ExternalSources per page; must be between 10 and 200, default is 100
namestringNoFilter by external source name. Filtering is prefix filtering and not an exact match
activebooleanNoFilter by active status of external source

genesys_contacts_get_organization

Fetch an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization ID
expandany[]Nowhich fields, if any, to expand
includeTrustorsbooleanNo(true or false) whether or not to include trustor information embedded in the externalOrganization

genesys_contacts_get_organization_contacts

Search for external contacts in an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization ID
pageSizeintegerNoPage size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
pageNumberintegerNoPage number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
qstringNoUser supplied search keywords (no special syntax is currently supported)
sortOrderstringNoThe External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. “firstName:asc”, “title:desc”
expandany[]Nowhich fields, if any, to expand

genesys_contacts_get_organization_identifiers

List the identifiers for an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization ID

genesys_contacts_get_organization_note

Fetch a note for an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization Id
noteIdstringYesNote Id
expandany[]Nowhich fields, if any, to expand

genesys_contacts_get_organization_notes

List notes for an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization Id
pageSizeintegerNoPage size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
pageNumberintegerNoPage number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
sortOrderstringNoThe Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. “createDate:asc”, “createDate:desc”
expandany[]Nowhich fields, if any, to expand

genesys_contacts_get_organization_relationships

Fetch a relationship for an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization ID
pageSizeintegerNoPage size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
pageNumberintegerNoPage number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
expandany[]Nowhich fields, if any, to expand
sortOrderstringNoThe Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. “createDate:asc”, “relationship:desc”

genesys_contacts_get_organizations

Search for external organizations Parameters:
ParameterTypeRequiredDefaultDescription
pageSizeintegerNoPage size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
pageNumberintegerNoPage number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)
qstringNoSearch query
trustorIdany[]NoSearch for external organizations by trustorIds (limit 25). If supplied, the ‘q’ parameters is ignored. Items are returned in the order requested
sortOrderstringNoThe Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. “companyType:asc”, “industry:desc”
expandany[]Nowhich fields, if any, to expand
includeTrustorsbooleanNo(true or false) whether or not to include trustor information embedded in the externalOrganization
divisionIdsany[]Nowhich divisions to search, up to 50

genesys_contacts_get_relationship

Fetch a relationship Parameters:
ParameterTypeRequiredDefaultDescription
relationshipIdstringYesRelationship Id
expandany[]Nowhich fields, if any, to expand

genesys_contacts_get_reversewhitepageslookup

Look up contacts based on an attribute. Maximum of 25 values returned. Parameters:
ParameterTypeRequiredDefaultDescription
lookupValstringYesUser supplied value to lookup contacts (supports email addresses, e164 phone numbers, Twitter screen names)
expandany[]Nowhich field, if any, to expand
divisionIdstringNoSpecifies which division to lookup contacts in, for the given lookup value

genesys_contacts_patch_contact_identifiers

Claim or release identifiers for a contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact ID
identifierobjectYesidentifier
operationstringYesThe operation to perform claim/release

genesys_contacts_patch_organization_identifiers

Claim or release identifiers for an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization ID
identifierobjectYesidentifier
operationstringYesThe operation to perform claim/release

genesys_contacts_post_contact_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 in the body for the client to retry, in the event of a partial success. Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact ID
assignobjectNoassign
unassignobjectNounassign

genesys_contacts_post_contact_notes

Create a note for an external contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact Id
createDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
createdByobjectNocreatedBy
divisionobjectNodivision
entityIdstringNoThe id of the contact or organization to which this note refers. This only needs to be set for input when using the Bulk APIs.
entityTypestringNoThis is only need to be set when using Bulk API. Using any other value than contact or organization will result in null being used.
externalDataSourcesany[]NoLinks to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.
idstringNoThe globally unique identifier for the object.
modifyDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
noteTextstringYesBetween 1 and 32,000 characters.
selfUristringNoThe URI for this object

genesys_contacts_post_contact_promotion

Promote an observed contact (ephemeral or identified) to a curated contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact ID

genesys_contacts_post_contacts

Create an external contact Parameters:
ParameterTypeRequiredDefaultDescription
addressobjectNoaddress
appleOpaqueIdsany[]NoUser information for an Apple account. Max: 10 ids
canonicalContactobjectNocanonicalContact
cellPhoneobjectNocellPhone
createDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
customFieldsobjectNoCustom fields defined in the schema referenced by schemaId and schemaVersion.
divisionobjectNodivision
externalDataSourcesany[]NoLinks to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.
externalIdsany[]NoA list of external identifiers that identify this contact in an external system. Max: 10 ids
externalOrganizationobjectNoexternalOrganization
externalSystemUrlstringNoA string that identifies an external system-of-record resource that may have more detailed information on the contact. Should be a valid URL (including the http/https protocol, port, and path [if any]). Leading and trailing whitespace stripped. Max 1000 characters.
facebookIdobjectNoUser information for a Facebook user interacting with a page or app
firstNamestringNoThe first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
homePhoneobjectNohomePhone
idstringNoThe globally unique identifier for the object.
identifiersany[]NoIdentifiers claimed by this contact
instagramIdobjectNoUser information for an Instagram account
lastNamestringNoThe last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
lineIdobjectNoUser information for a Line account
mergedFromany[]NoThe input contacts from the merge operation.
mergedToobjectNomergedTo
mergeOperationobjectNomergeOperation
mergeSetany[]NoThe set of all contacts that are a part of the merge tree. If null, this contact is not a part of any merge.
middleNamestringNoThe middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
modifyDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
otherEmailstringNoThe other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
otherPhoneobjectNootherPhone
personalEmailstringNoThe personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
salutationstringNoThe salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
schemaobjectNoschema
selfUristringNoThe URI for this object
surveyOptOutbooleanNosurveyOptOut
titlestringNoThe title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
twitterIdobjectNoUser information for a twitter account. Either id OR screenName (or both) must be present
typestringNoThe type of contact
whatsAppIdobjectNoUser information for a WhatsApp account
workEmailstringNoThe work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
workPhoneobjectNoworkPhone

genesys_contacts_post_enrich

Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts. Parameters:
ParameterTypeRequiredDefaultDescription
dryRunbooleanNoIf true, the request will not make any modifications, but will show you what the end result would be.
actionstringYesThe action that should be taken based on any Contacts found by matchingIdentifiers.
contactobjectNocontact
divisionobjectNodivision
fieldRulesobjectNofieldRules
idstringNoA user-specified tracker string, only useful in the Bulk-Enrich API. If one Bulk-Enrich operation in a request fails, the requested operation will be repeated in the Bulk API response, including this id field, allowing associating of request and response operations.
matchingIdentifiersany[]YesAn ordered list of one or more Identifiers which might each be claimed by a Contact. action describes what to do with any possibly matching Contacts. Identifier lookups will occur in the order specified here. Between 1 and 25.
optionsobjectNooptions

genesys_contacts_post_externalcontacts_contact_notes

Create a note for an external contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact Id
createDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
createdByobjectNocreatedBy
divisionobjectNodivision
entityIdstringNoThe id of the contact or organization to which this note refers. This only needs to be set for input when using the Bulk APIs.
entityTypestringNoThis is only need to be set when using Bulk API. Using any other value than contact or organization will result in null being used.
externalDataSourcesany[]NoLinks to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.
idstringNoThe globally unique identifier for the object.
modifyDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
noteTextstringYesBetween 1 and 32,000 characters.
selfUristringNoThe URI for this object

genesys_contacts_post_externalcontacts_contacts

Create an external contact Parameters:
ParameterTypeRequiredDefaultDescription
addressobjectNoaddress
appleOpaqueIdsany[]NoUser information for an Apple account. Max: 10 ids
canonicalContactobjectNocanonicalContact
cellPhoneobjectNocellPhone
createDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
customFieldsobjectNoCustom fields defined in the schema referenced by schemaId and schemaVersion.
divisionobjectNodivision
externalDataSourcesany[]NoLinks to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.
externalIdsany[]NoA list of external identifiers that identify this contact in an external system. Max: 10 ids
externalOrganizationobjectNoexternalOrganization
externalSystemUrlstringNoA string that identifies an external system-of-record resource that may have more detailed information on the contact. Should be a valid URL (including the http/https protocol, port, and path [if any]). Leading and trailing whitespace stripped. Max 1000 characters.
facebookIdobjectNoUser information for a Facebook user interacting with a page or app
firstNamestringNoThe first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
homePhoneobjectNohomePhone
idstringNoThe globally unique identifier for the object.
identifiersany[]NoIdentifiers claimed by this contact
instagramIdobjectNoUser information for an Instagram account
lastNamestringNoThe last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
lineIdobjectNoUser information for a Line account
mergedFromany[]NoThe input contacts from the merge operation.
mergedToobjectNomergedTo
mergeOperationobjectNomergeOperation
mergeSetany[]NoThe set of all contacts that are a part of the merge tree. If null, this contact is not a part of any merge.
middleNamestringNoThe middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
modifyDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
otherEmailstringNoThe other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
otherPhoneobjectNootherPhone
personalEmailstringNoThe personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
salutationstringNoThe salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
schemaobjectNoschema
selfUristringNoThe URI for this object
surveyOptOutbooleanNosurveyOptOut
titlestringNoThe title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
twitterIdobjectNoUser information for a twitter account. Either id OR screenName (or both) must be present
typestringNoThe type of contact
whatsAppIdobjectNoUser information for a WhatsApp account
workEmailstringNoThe work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
workPhoneobjectNoworkPhone

genesys_contacts_post_externalcontacts_identifierlookup_contacts

Fetch a contact using an identifier type and value. Parameters:
ParameterTypeRequiredDefaultDescription
expandany[]Nowhich field, if any, to expand
dateCreatedstringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
divisionobjectNodivision
externalSourceobjectNoexternalSource
idstringNoThe globally unique identifier for the object.
selfUristringNoThe URI for this object
typestringYesThe type of this identifier
valuestringYesThe string value of the identifier. Will vary in syntax by type. Max: 255 characters. Leading and trailing whitespace stripped.

genesys_contacts_post_externalsources

Create an External Source Parameters:
ParameterTypeRequiredDefaultDescription
activebooleanNoactive
idstringNoThe globally unique identifier for the object.
linkConfigurationobjectNolinkConfiguration
namestringYesThe name of the external source. Must be unique. Max: 200 characters. Leading and trailing whitespace stripped.
selfUristringNoThe URI for this object

genesys_contacts_post_identifierlookup_contacts

Fetch a contact using an identifier type and value. Parameters:
ParameterTypeRequiredDefaultDescription
expandany[]Nowhich field, if any, to expand
dateCreatedstringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
divisionobjectNodivision
externalSourceobjectNoexternalSource
idstringNoThe globally unique identifier for the object.
selfUristringNoThe URI for this object
typestringYesThe type of this identifier
valuestringYesThe string value of the identifier. Will vary in syntax by type. Max: 255 characters. Leading and trailing whitespace stripped.

genesys_contacts_post_identifierlookup_organizations

Fetch an external organization using an identifier type and value. Parameters:
ParameterTypeRequiredDefaultDescription
expandany[]Nowhich field, if any, to expand
dateCreatedstringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
divisionobjectNodivision
externalSourceobjectNoexternalSource
idstringNoThe globally unique identifier for the object.
selfUristringNoThe URI for this object
typestringYesThe type of this identifier
valuestringYesThe string value of the identifier. Will vary in syntax by type. Max: 255 characters.

genesys_contacts_post_merge

Merge up to 25 contacts into a new contact record Parameters:
ParameterTypeRequiredDefaultDescription
contactIdsany[]YesThe IDs of all contacts involved in the merge operation (must be between 2 and 25).
valueOverrideobjectNovalueOverride

genesys_contacts_post_organization_notes

Create a note for an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization Id
createDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
createdByobjectNocreatedBy
divisionobjectNodivision
entityIdstringNoThe id of the contact or organization to which this note refers. This only needs to be set for input when using the Bulk APIs.
entityTypestringNoThis is only need to be set when using Bulk API. Using any other value than contact or organization will result in null being used.
externalDataSourcesany[]NoLinks to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.
idstringNoThe globally unique identifier for the object.
modifyDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
noteTextstringYesBetween 1 and 32,000 characters.
selfUristringNoThe URI for this object

genesys_contacts_post_organizations

Create an external organization Parameters:
ParameterTypeRequiredDefaultDescription
addressobjectNoaddress
companyTypestringNocompanyType
createDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
customFieldsobjectNoCustom fields defined in the schema referenced by schemaId and schemaVersion.
divisionobjectNodivision
employeeCountintegerNoemployeeCount
externalDataSourcesany[]NoLinks to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.
externalIdsany[]NoA list of external identifiers that identify this External Organization in an external system. Max 10 items.
externalSystemUrlstringNoA string that identifies an external system-of-record resource that may have more detailed information on the organization. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace.
faxNumberobjectNofaxNumber
idstringNoThe globally unique identifier for the object.
identifiersany[]NoIdentifiers claimed by this external org
industrystringNoindustry
modifyDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
namestringYesThe name of the company. Max: 1000 characters. Leading and trailing whitespace stripped.
phoneNumberobjectNophoneNumber
revenueintegerNorevenue
schemaobjectNoschema
selfUristringNoThe URI for this object
tagsany[]Notags
tickersany[]Notickers
trustorobjectNotrustor
twitterIdobjectNoUser information for a twitter account. Either id OR screenName (or both) must be present
websitesany[]Nowebsites

genesys_contacts_post_organizations_enrich

Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs. Parameters:
ParameterTypeRequiredDefaultDescription
dryRunbooleanNoIf true, the request will not make any modifications, but will show you what the end result would be.
actionstringNoThe action that should be taken based on any External Organization found by matchingIdentifiers.
divisionobjectNodivision
externalOrganizationobjectNoexternalOrganization
fieldRulesobjectNofieldRules
idstringNoA user-specified tracker string, only useful in the Bulk-Enrich API. If one Bulk-Enrich operation in a request fails, the requested operation will be repeated in the Bulk API response, including this id field, allowing associating request and response operations.
matchingIdentifiersany[]NoAn ordered list of one or more Identifiers which might each be claimed by an External Organization. action describes what to do with any possibly matching External Organization. Identifier lookups will occur in the order specified here.
selfUristringNoThe URI for this object

genesys_contacts_post_relationships

Create a relationship Parameters:
ParameterTypeRequiredDefaultDescription
divisionobjectNodivision
externalDataSourcesany[]NoLinks to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.
externalOrganizationobjectYesexternalOrganization
idstringNoThe globally unique identifier for the object.
relationshipstringYesThe relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant. Between 1 and 100 characters.
selfUristringNoThe URI for this object
userobjectYesuser

genesys_contacts_put_contact

Update an external contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact ID
addressobjectNoaddress
appleOpaqueIdsany[]NoUser information for an Apple account. Max: 10 ids
canonicalContactobjectNocanonicalContact
cellPhoneobjectNocellPhone
createDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
customFieldsobjectNoCustom fields defined in the schema referenced by schemaId and schemaVersion.
divisionobjectNodivision
externalDataSourcesany[]NoLinks to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.
externalIdsany[]NoA list of external identifiers that identify this contact in an external system. Max: 10 ids
externalOrganizationobjectNoexternalOrganization
externalSystemUrlstringNoA string that identifies an external system-of-record resource that may have more detailed information on the contact. Should be a valid URL (including the http/https protocol, port, and path [if any]). Leading and trailing whitespace stripped. Max 1000 characters.
facebookIdobjectNoUser information for a Facebook user interacting with a page or app
firstNamestringNoThe first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
homePhoneobjectNohomePhone
idstringNoThe globally unique identifier for the object.
identifiersany[]NoIdentifiers claimed by this contact
instagramIdobjectNoUser information for an Instagram account
lastNamestringNoThe last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
lineIdobjectNoUser information for a Line account
mergedFromany[]NoThe input contacts from the merge operation.
mergedToobjectNomergedTo
mergeOperationobjectNomergeOperation
mergeSetany[]NoThe set of all contacts that are a part of the merge tree. If null, this contact is not a part of any merge.
middleNamestringNoThe middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
modifyDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
otherEmailstringNoThe other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
otherPhoneobjectNootherPhone
personalEmailstringNoThe personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
salutationstringNoThe salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
schemaobjectNoschema
selfUristringNoThe URI for this object
surveyOptOutbooleanNosurveyOptOut
titlestringNoThe title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
twitterIdobjectNoUser information for a twitter account. Either id OR screenName (or both) must be present
typestringNoThe type of contact
whatsAppIdobjectNoUser information for a WhatsApp account
workEmailstringNoThe work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
workPhoneobjectNoworkPhone

genesys_contacts_put_contact_note

Update a note for an external contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact Id
noteIdstringYesNote Id
createDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
createdByobjectYescreatedBy
divisionobjectNodivision
entityIdstringNoThe id of the contact or organization to which this note refers. This only needs to be set for input when using the Bulk APIs.
entityTypestringNoThis is only need to be set when using Bulk API. Using any other value than contact or organization will result in null being used.
externalDataSourcesany[]NoLinks to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.
idstringNoThe globally unique identifier for the object.
modifyDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
noteTextstringNoBetween 1 and 32,000 characters.
selfUristringNoThe URI for this object

genesys_contacts_put_conversation

Associate/disassociate an external contact with a conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversationIdstringYesConversation ID
communicationIdstringYesCommunication ID
externalContactIdstringNoAn external contact ID. If not supplied, implies the conversation should be disassociated with any external contact.
mediaTypestringYesMedia type

genesys_contacts_put_externalcontacts_contact

Update an external contact Parameters:
ParameterTypeRequiredDefaultDescription
contactIdstringYesExternalContact ID
addressobjectNoaddress
appleOpaqueIdsany[]NoUser information for an Apple account. Max: 10 ids
canonicalContactobjectNocanonicalContact
cellPhoneobjectNocellPhone
createDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
customFieldsobjectNoCustom fields defined in the schema referenced by schemaId and schemaVersion.
divisionobjectNodivision
externalDataSourcesany[]NoLinks to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.
externalIdsany[]NoA list of external identifiers that identify this contact in an external system. Max: 10 ids
externalOrganizationobjectNoexternalOrganization
externalSystemUrlstringNoA string that identifies an external system-of-record resource that may have more detailed information on the contact. Should be a valid URL (including the http/https protocol, port, and path [if any]). Leading and trailing whitespace stripped. Max 1000 characters.
facebookIdobjectNoUser information for a Facebook user interacting with a page or app
firstNamestringNoThe first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
homePhoneobjectNohomePhone
idstringNoThe globally unique identifier for the object.
identifiersany[]NoIdentifiers claimed by this contact
instagramIdobjectNoUser information for an Instagram account
lastNamestringNoThe last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
lineIdobjectNoUser information for a Line account
mergedFromany[]NoThe input contacts from the merge operation.
mergedToobjectNomergedTo
mergeOperationobjectNomergeOperation
mergeSetany[]NoThe set of all contacts that are a part of the merge tree. If null, this contact is not a part of any merge.
middleNamestringNoThe middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
modifyDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
otherEmailstringNoThe other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
otherPhoneobjectNootherPhone
personalEmailstringNoThe personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
salutationstringNoThe salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
schemaobjectNoschema
selfUristringNoThe URI for this object
surveyOptOutbooleanNosurveyOptOut
titlestringNoThe title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
twitterIdobjectNoUser information for a twitter account. Either id OR screenName (or both) must be present
typestringNoThe type of contact
whatsAppIdobjectNoUser information for a WhatsApp account
workEmailstringNoThe work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
workPhoneobjectNoworkPhone

genesys_contacts_put_externalsource

Update an External Source Parameters:
ParameterTypeRequiredDefaultDescription
externalSourceIdstringYesExternal Source ID
activebooleanNoactive
idstringNoThe globally unique identifier for the object.
linkConfigurationobjectNolinkConfiguration
namestringYesThe name of the external source. Must be unique. Max: 200 characters. Leading and trailing whitespace stripped.
selfUristringNoThe URI for this object

genesys_contacts_put_organization

Update an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization ID
addressobjectNoaddress
companyTypestringNocompanyType
createDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
customFieldsobjectNoCustom fields defined in the schema referenced by schemaId and schemaVersion.
divisionobjectNodivision
employeeCountintegerNoemployeeCount
externalDataSourcesany[]NoLinks to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.
externalIdsany[]NoA list of external identifiers that identify this External Organization in an external system. Max 10 items.
externalSystemUrlstringNoA string that identifies an external system-of-record resource that may have more detailed information on the organization. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace.
faxNumberobjectNofaxNumber
idstringNoThe globally unique identifier for the object.
identifiersany[]NoIdentifiers claimed by this external org
industrystringNoindustry
modifyDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
namestringYesThe name of the company. Max: 1000 characters. Leading and trailing whitespace stripped.
phoneNumberobjectNophoneNumber
revenueintegerNorevenue
schemaobjectNoschema
selfUristringNoThe URI for this object
tagsany[]Notags
tickersany[]Notickers
trustorobjectNotrustor
twitterIdobjectNoUser information for a twitter account. Either id OR screenName (or both) must be present
websitesany[]Nowebsites

genesys_contacts_put_organization_note

Update a note for an external organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization Id
noteIdstringYesNote Id
createDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
createdByobjectYescreatedBy
divisionobjectNodivision
entityIdstringNoThe id of the contact or organization to which this note refers. This only needs to be set for input when using the Bulk APIs.
entityTypestringNoThis is only need to be set when using Bulk API. Using any other value than contact or organization will result in null being used.
externalDataSourcesany[]NoLinks to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.
idstringNoThe globally unique identifier for the object.
modifyDatestringNoDate time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
noteTextstringNoBetween 1 and 32,000 characters.
selfUristringNoThe URI for this object

genesys_contacts_put_organization_trustor_trustor_id

Links a Trustor with an External Organization Parameters:
ParameterTypeRequiredDefaultDescription
externalOrganizationIdstringYesExternal Organization ID
trustorIdstringYesTrustor ID

genesys_contacts_put_relationship

Update a relationship Parameters:
ParameterTypeRequiredDefaultDescription
relationshipIdstringYesRelationship Id
divisionobjectNodivision
externalDataSourcesany[]NoLinks to the sources of data (e.g. one source might be a CRM) that contributed data to this record. Read-only, and only populated when requested via expand param.
externalOrganizationobjectYesexternalOrganization
idstringNoThe globally unique identifier for the object.
relationshipstringYesThe relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant. Between 1 and 100 characters.
selfUristringNoThe URI for this object
userobjectYesuser