/genesys-contacts | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
genesys_contacts_delete_contact | Delete an external contact |
genesys_contacts_delete_contact_note | Delete a note for an external contact |
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. |
genesys_contacts_delete_organization | Delete an external organization |
genesys_contacts_delete_organization_note | Delete a note for an external organization |
genesys_contacts_delete_organization_trustor | Unlink the Trustor for this External Organization |
genesys_contacts_delete_relationship | Delete a relationship |
genesys_contacts_get_contact | Fetch an external contact |
genesys_contacts_get_contact_identifiers | List the identifiers for a contact |
genesys_contacts_get_contact_journey_segments | Retrieve segment assignments by external contact ID. |
genesys_contacts_get_contact_journey_sessions | Retrieve all sessions for a given external contact. |
genesys_contacts_get_contact_note | Fetch a note for an external contact |
genesys_contacts_get_contact_notes | List notes for an external contact |
genesys_contacts_get_contact_unresolved | Fetch an unresolved external contact |
genesys_contacts_get_contacts | Search for external contacts |
genesys_contacts_get_externalcontacts_contact | Fetch an external contact |
genesys_contacts_get_externalcontacts_contact_note | Fetch a note for an external contact |
genesys_contacts_get_externalcontacts_contact_notes | List notes for an external contact |
genesys_contacts_get_externalcontacts_contacts | Search for external contacts |
genesys_contacts_get_externalcontacts_organization | Fetch an external organization |
genesys_contacts_get_externalcontacts_organization_contacts | Search for external contacts in an external organization |
genesys_contacts_get_externalcontacts_organization_notes | List notes for an external organization |
genesys_contacts_get_externalcontacts_organizations | Search for external organizations |
genesys_contacts_get_externalsource | Fetch an External Source |
genesys_contacts_get_externalsources | Fetch a list of External Sources |
genesys_contacts_get_organization | Fetch an external organization |
genesys_contacts_get_organization_contacts | Search for external contacts in an external organization |
genesys_contacts_get_organization_identifiers | List the identifiers for an external organization |
genesys_contacts_get_organization_note | Fetch a note for an external organization |
genesys_contacts_get_organization_notes | List notes for an external organization |
genesys_contacts_get_organization_relationships | Fetch a relationship for an external organization |
genesys_contacts_get_organizations | Search for external organizations |
genesys_contacts_get_relationship | Fetch a relationship |
genesys_contacts_get_reversewhitepageslookup | Look up contacts based on an attribute. Maximum of 25 values returned. |
genesys_contacts_patch_contact_identifiers | Claim or release identifiers for a contact |
genesys_contacts_patch_organization_identifiers | Claim or release identifiers for an external organization |
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. |
genesys_contacts_post_contact_notes | Create a note for an external contact |
genesys_contacts_post_contact_promotion | Promote an observed contact (ephemeral or identified) to a curated contact |
genesys_contacts_post_contacts | Create an external contact |
genesys_contacts_post_enrich | Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts. |
genesys_contacts_post_externalcontacts_contact_notes | Create a note for an external contact |
genesys_contacts_post_externalcontacts_contacts | Create an external contact |
genesys_contacts_post_externalcontacts_identifierlookup_contacts | Fetch a contact using an identifier type and value. |
genesys_contacts_post_externalsources | Create an External Source |
genesys_contacts_post_identifierlookup_contacts | Fetch a contact using an identifier type and value. |
genesys_contacts_post_identifierlookup_organizations | Fetch an external organization using an identifier type and value. |
genesys_contacts_post_merge | Merge up to 25 contacts into a new contact record |
genesys_contacts_post_organization_notes | Create a note for an external organization |
genesys_contacts_post_organizations | Create an external organization |
genesys_contacts_post_organizations_enrich | Modify or create an External Org, with powerful behaviors for finding and combining data with pre-existing External Orgs. |
genesys_contacts_post_relationships | Create a relationship |
genesys_contacts_put_contact | Update an external contact |
genesys_contacts_put_contact_note | Update a note for an external contact |
genesys_contacts_put_conversation | Associate/disassociate an external contact with a conversation |
genesys_contacts_put_externalcontacts_contact | Update an external contact |
genesys_contacts_put_externalsource | Update an External Source |
genesys_contacts_put_organization | Update an external organization |
genesys_contacts_put_organization_note | Update a note for an external organization |
genesys_contacts_put_organization_trustor_trustor_id | Links a Trustor with an External Organization |
genesys_contacts_put_relationship | Update a relationship |
genesys_contacts_delete_contact
Delete an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
genesys_contacts_delete_contact_note
Delete a note for an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact Id |
noteId | string | Yes | — | Note 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalSourceId | string | Yes | — | External Source ID |
genesys_contacts_delete_organization
Delete an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
genesys_contacts_delete_organization_note
Delete a note for an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization Id |
noteId | string | Yes | — | Note Id |
genesys_contacts_delete_organization_trustor
Unlink the Trustor for this External Organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
genesys_contacts_delete_relationship
Delete a relationship Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
relationshipId | string | Yes | — | Relationship Id |
genesys_contacts_get_contact
Fetch an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
expand | any[] | No | — | which fields, if any, to expand |
genesys_contacts_get_contact_identifiers
List the identifiers for a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
genesys_contacts_get_contact_journey_segments
Retrieve segment assignments by external contact ID. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
includeMerged | boolean | No | — | Indicates whether to return segment assignments from all external contacts in the merge-set of the given one. |
limit | integer | No | — | Number 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
pageSize | string | No | — | Number of entities to return. Maximum of 200. |
after | string | No | — | The cursor that points to the end of the set of entities that has been returned. |
includeMerged | boolean | No | — | Indicates 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact Id |
noteId | string | Yes | — | Note Id |
expand | any[] | No | — | which fields, if any, to expand |
genesys_contacts_get_contact_notes
List notes for an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact Id |
pageSize | integer | No | — | Page size (limited to fetching first 1,000 records; pageSize <= 100; pageNumber * pageSize must be <= 1,000) |
pageNumber | integer | No | — | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
sortOrder | string | No | — | The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. “createDate:asc”, “createDate:desc” |
expand | any[] | No | — | which 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
expand | any[] | No | — | which fields, if any, to expand |
genesys_contacts_get_contacts
Search for external contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
pageNumber | integer | No | — | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
q | string | No | — | User supplied search keywords (no special syntax is currently supported) |
sortOrder | string | No | — | The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. “firstName:asc”, “title:desc” |
expand | any[] | No | — | which fields, if any, to expand |
divisionIds | any[] | No | — | which divisions to search, up to 50 |
genesys_contacts_get_externalcontacts_contact
Fetch an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
expand | any[] | No | — | which fields, if any, to expand |
genesys_contacts_get_externalcontacts_contact_note
Fetch a note for an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact Id |
noteId | string | Yes | — | Note Id |
expand | any[] | No | — | which fields, if any, to expand |
genesys_contacts_get_externalcontacts_contact_notes
List notes for an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact Id |
pageSize | integer | No | — | Page size (limited to fetching first 1,000 records; pageSize <= 100; pageNumber * pageSize must be <= 1,000) |
pageNumber | integer | No | — | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
sortOrder | string | No | — | The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. “createDate:asc”, “createDate:desc” |
expand | any[] | No | — | which 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
pageNumber | integer | No | — | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
q | string | No | — | User supplied search keywords (no special syntax is currently supported) |
sortOrder | string | No | — | The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. “firstName:asc”, “title:desc” |
expand | any[] | No | — | which fields, if any, to expand |
divisionIds | any[] | No | — | which divisions to search, up to 50 |
genesys_contacts_get_externalcontacts_organization
Fetch an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
expand | any[] | No | — | which fields, if any, to expand |
includeTrustors | boolean | No | — | (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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
pageSize | integer | No | — | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
pageNumber | integer | No | — | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
q | string | No | — | User supplied search keywords (no special syntax is currently supported) |
sortOrder | string | No | — | The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. “firstName:asc”, “title:desc” |
expand | any[] | No | — | which fields, if any, to expand |
genesys_contacts_get_externalcontacts_organization_notes
List notes for an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization Id |
pageSize | integer | No | — | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
pageNumber | integer | No | — | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
sortOrder | string | No | — | The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. “createDate:asc”, “createDate:desc” |
expand | any[] | No | — | which fields, if any, to expand |
genesys_contacts_get_externalcontacts_organizations
Search for external organizations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
pageNumber | integer | No | — | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
q | string | No | — | Search query |
trustorId | any[] | No | — | Search for external organizations by trustorIds (limit 25). If supplied, the ‘q’ parameters is ignored. Items are returned in the order requested |
sortOrder | string | No | — | The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. “companyType:asc”, “industry:desc” |
expand | any[] | No | — | which fields, if any, to expand |
includeTrustors | boolean | No | — | (true or false) whether or not to include trustor information embedded in the externalOrganization |
divisionIds | any[] | No | — | which divisions to search, up to 50 |
genesys_contacts_get_externalsource
Fetch an External Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalSourceId | string | Yes | — | External Source ID |
genesys_contacts_get_externalsources
Fetch a list of External Sources Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL |
limit | integer | No | — | The number of ExternalSources per page; must be between 10 and 200, default is 100 |
name | string | No | — | Filter by external source name. Filtering is prefix filtering and not an exact match |
active | boolean | No | — | Filter by active status of external source |
genesys_contacts_get_organization
Fetch an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
expand | any[] | No | — | which fields, if any, to expand |
includeTrustors | boolean | No | — | (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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
pageSize | integer | No | — | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
pageNumber | integer | No | — | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
q | string | No | — | User supplied search keywords (no special syntax is currently supported) |
sortOrder | string | No | — | The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. “firstName:asc”, “title:desc” |
expand | any[] | No | — | which fields, if any, to expand |
genesys_contacts_get_organization_identifiers
List the identifiers for an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
genesys_contacts_get_organization_note
Fetch a note for an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization Id |
noteId | string | Yes | — | Note Id |
expand | any[] | No | — | which fields, if any, to expand |
genesys_contacts_get_organization_notes
List notes for an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization Id |
pageSize | integer | No | — | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
pageNumber | integer | No | — | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
sortOrder | string | No | — | The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. “createDate:asc”, “createDate:desc” |
expand | any[] | No | — | which fields, if any, to expand |
genesys_contacts_get_organization_relationships
Fetch a relationship for an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
pageSize | integer | No | — | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
pageNumber | integer | No | — | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
expand | any[] | No | — | which fields, if any, to expand |
sortOrder | string | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pageSize | integer | No | — | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
pageNumber | integer | No | — | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) |
q | string | No | — | Search query |
trustorId | any[] | No | — | Search for external organizations by trustorIds (limit 25). If supplied, the ‘q’ parameters is ignored. Items are returned in the order requested |
sortOrder | string | No | — | The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. “companyType:asc”, “industry:desc” |
expand | any[] | No | — | which fields, if any, to expand |
includeTrustors | boolean | No | — | (true or false) whether or not to include trustor information embedded in the externalOrganization |
divisionIds | any[] | No | — | which divisions to search, up to 50 |
genesys_contacts_get_relationship
Fetch a relationship Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
relationshipId | string | Yes | — | Relationship Id |
expand | any[] | No | — | which fields, if any, to expand |
genesys_contacts_get_reversewhitepageslookup
Look up contacts based on an attribute. Maximum of 25 values returned. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
lookupVal | string | Yes | — | User supplied value to lookup contacts (supports email addresses, e164 phone numbers, Twitter screen names) |
expand | any[] | No | — | which field, if any, to expand |
divisionId | string | No | — | Specifies which division to lookup contacts in, for the given lookup value |
genesys_contacts_patch_contact_identifiers
Claim or release identifiers for a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
identifier | object | Yes | — | identifier |
operation | string | Yes | — | The operation to perform claim/release |
genesys_contacts_patch_organization_identifiers
Claim or release identifiers for an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
identifier | object | Yes | — | identifier |
operation | string | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
assign | object | No | — | assign |
unassign | object | No | — | unassign |
genesys_contacts_post_contact_notes
Create a note for an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact Id |
createDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
createdBy | object | No | — | createdBy |
division | object | No | — | division |
entityId | string | No | — | The id of the contact or organization to which this note refers. This only needs to be set for input when using the Bulk APIs. |
entityType | string | No | — | This is only need to be set when using Bulk API. Using any other value than contact or organization will result in null being used. |
externalDataSources | any[] | No | — | Links 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. |
id | string | No | — | The globally unique identifier for the object. |
modifyDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
noteText | string | Yes | — | Between 1 and 32,000 characters. |
selfUri | string | No | — | The URI for this object |
genesys_contacts_post_contact_promotion
Promote an observed contact (ephemeral or identified) to a curated contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
genesys_contacts_post_contacts
Create an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | object | No | — | address |
appleOpaqueIds | any[] | No | — | User information for an Apple account. Max: 10 ids |
canonicalContact | object | No | — | canonicalContact |
cellPhone | object | No | — | cellPhone |
createDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
customFields | object | No | — | Custom fields defined in the schema referenced by schemaId and schemaVersion. |
division | object | No | — | division |
externalDataSources | any[] | No | — | Links 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. |
externalIds | any[] | No | — | A list of external identifiers that identify this contact in an external system. Max: 10 ids |
externalOrganization | object | No | — | externalOrganization |
externalSystemUrl | string | No | — | A 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. |
facebookId | object | No | — | User information for a Facebook user interacting with a page or app |
firstName | string | No | — | The first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
homePhone | object | No | — | homePhone |
id | string | No | — | The globally unique identifier for the object. |
identifiers | any[] | No | — | Identifiers claimed by this contact |
instagramId | object | No | — | User information for an Instagram account |
lastName | string | No | — | The last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
lineId | object | No | — | User information for a Line account |
mergedFrom | any[] | No | — | The input contacts from the merge operation. |
mergedTo | object | No | — | mergedTo |
mergeOperation | object | No | — | mergeOperation |
mergeSet | any[] | No | — | The set of all contacts that are a part of the merge tree. If null, this contact is not a part of any merge. |
middleName | string | No | — | The middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
modifyDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
otherEmail | string | No | — | The other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format |
otherPhone | object | No | — | otherPhone |
personalEmail | string | No | — | The personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format |
salutation | string | No | — | The salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
schema | object | No | — | schema |
selfUri | string | No | — | The URI for this object |
surveyOptOut | boolean | No | — | surveyOptOut |
title | string | No | — | The title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
twitterId | object | No | — | User information for a twitter account. Either id OR screenName (or both) must be present |
type | string | No | — | The type of contact |
whatsAppId | object | No | — | User information for a WhatsApp account |
workEmail | string | No | — | The work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format |
workPhone | object | No | — | workPhone |
genesys_contacts_post_enrich
Modify or create an External Contact, with powerful behaviors for finding and combining data with pre-existing Contacts. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dryRun | boolean | No | — | If true, the request will not make any modifications, but will show you what the end result would be. |
action | string | Yes | — | The action that should be taken based on any Contacts found by matchingIdentifiers. |
contact | object | No | — | contact |
division | object | No | — | division |
fieldRules | object | No | — | fieldRules |
id | string | No | — | A 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. |
matchingIdentifiers | any[] | Yes | — | An 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. |
options | object | No | — | options |
genesys_contacts_post_externalcontacts_contact_notes
Create a note for an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact Id |
createDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
createdBy | object | No | — | createdBy |
division | object | No | — | division |
entityId | string | No | — | The id of the contact or organization to which this note refers. This only needs to be set for input when using the Bulk APIs. |
entityType | string | No | — | This is only need to be set when using Bulk API. Using any other value than contact or organization will result in null being used. |
externalDataSources | any[] | No | — | Links 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. |
id | string | No | — | The globally unique identifier for the object. |
modifyDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
noteText | string | Yes | — | Between 1 and 32,000 characters. |
selfUri | string | No | — | The URI for this object |
genesys_contacts_post_externalcontacts_contacts
Create an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | object | No | — | address |
appleOpaqueIds | any[] | No | — | User information for an Apple account. Max: 10 ids |
canonicalContact | object | No | — | canonicalContact |
cellPhone | object | No | — | cellPhone |
createDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
customFields | object | No | — | Custom fields defined in the schema referenced by schemaId and schemaVersion. |
division | object | No | — | division |
externalDataSources | any[] | No | — | Links 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. |
externalIds | any[] | No | — | A list of external identifiers that identify this contact in an external system. Max: 10 ids |
externalOrganization | object | No | — | externalOrganization |
externalSystemUrl | string | No | — | A 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. |
facebookId | object | No | — | User information for a Facebook user interacting with a page or app |
firstName | string | No | — | The first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
homePhone | object | No | — | homePhone |
id | string | No | — | The globally unique identifier for the object. |
identifiers | any[] | No | — | Identifiers claimed by this contact |
instagramId | object | No | — | User information for an Instagram account |
lastName | string | No | — | The last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
lineId | object | No | — | User information for a Line account |
mergedFrom | any[] | No | — | The input contacts from the merge operation. |
mergedTo | object | No | — | mergedTo |
mergeOperation | object | No | — | mergeOperation |
mergeSet | any[] | No | — | The set of all contacts that are a part of the merge tree. If null, this contact is not a part of any merge. |
middleName | string | No | — | The middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
modifyDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
otherEmail | string | No | — | The other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format |
otherPhone | object | No | — | otherPhone |
personalEmail | string | No | — | The personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format |
salutation | string | No | — | The salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
schema | object | No | — | schema |
selfUri | string | No | — | The URI for this object |
surveyOptOut | boolean | No | — | surveyOptOut |
title | string | No | — | The title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
twitterId | object | No | — | User information for a twitter account. Either id OR screenName (or both) must be present |
type | string | No | — | The type of contact |
whatsAppId | object | No | — | User information for a WhatsApp account |
workEmail | string | No | — | The work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format |
workPhone | object | No | — | workPhone |
genesys_contacts_post_externalcontacts_identifierlookup_contacts
Fetch a contact using an identifier type and value. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | any[] | No | — | which field, if any, to expand |
dateCreated | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
division | object | No | — | division |
externalSource | object | No | — | externalSource |
id | string | No | — | The globally unique identifier for the object. |
selfUri | string | No | — | The URI for this object |
type | string | Yes | — | The type of this identifier |
value | string | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
active | boolean | No | — | active |
id | string | No | — | The globally unique identifier for the object. |
linkConfiguration | object | No | — | linkConfiguration |
name | string | Yes | — | The name of the external source. Must be unique. Max: 200 characters. Leading and trailing whitespace stripped. |
selfUri | string | No | — | The URI for this object |
genesys_contacts_post_identifierlookup_contacts
Fetch a contact using an identifier type and value. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | any[] | No | — | which field, if any, to expand |
dateCreated | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
division | object | No | — | division |
externalSource | object | No | — | externalSource |
id | string | No | — | The globally unique identifier for the object. |
selfUri | string | No | — | The URI for this object |
type | string | Yes | — | The type of this identifier |
value | string | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | any[] | No | — | which field, if any, to expand |
dateCreated | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
division | object | No | — | division |
externalSource | object | No | — | externalSource |
id | string | No | — | The globally unique identifier for the object. |
selfUri | string | No | — | The URI for this object |
type | string | Yes | — | The type of this identifier |
value | string | Yes | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactIds | any[] | Yes | — | The IDs of all contacts involved in the merge operation (must be between 2 and 25). |
valueOverride | object | No | — | valueOverride |
genesys_contacts_post_organization_notes
Create a note for an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization Id |
createDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
createdBy | object | No | — | createdBy |
division | object | No | — | division |
entityId | string | No | — | The id of the contact or organization to which this note refers. This only needs to be set for input when using the Bulk APIs. |
entityType | string | No | — | This is only need to be set when using Bulk API. Using any other value than contact or organization will result in null being used. |
externalDataSources | any[] | No | — | Links 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. |
id | string | No | — | The globally unique identifier for the object. |
modifyDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
noteText | string | Yes | — | Between 1 and 32,000 characters. |
selfUri | string | No | — | The URI for this object |
genesys_contacts_post_organizations
Create an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | object | No | — | address |
companyType | string | No | — | companyType |
createDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
customFields | object | No | — | Custom fields defined in the schema referenced by schemaId and schemaVersion. |
division | object | No | — | division |
employeeCount | integer | No | — | employeeCount |
externalDataSources | any[] | No | — | Links 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. |
externalIds | any[] | No | — | A list of external identifiers that identify this External Organization in an external system. Max 10 items. |
externalSystemUrl | string | No | — | A 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. |
faxNumber | object | No | — | faxNumber |
id | string | No | — | The globally unique identifier for the object. |
identifiers | any[] | No | — | Identifiers claimed by this external org |
industry | string | No | — | industry |
modifyDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
name | string | Yes | — | The name of the company. Max: 1000 characters. Leading and trailing whitespace stripped. |
phoneNumber | object | No | — | phoneNumber |
revenue | integer | No | — | revenue |
schema | object | No | — | schema |
selfUri | string | No | — | The URI for this object |
tags | any[] | No | — | tags |
tickers | any[] | No | — | tickers |
trustor | object | No | — | trustor |
twitterId | object | No | — | User information for a twitter account. Either id OR screenName (or both) must be present |
websites | any[] | No | — | websites |
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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dryRun | boolean | No | — | If true, the request will not make any modifications, but will show you what the end result would be. |
action | string | No | — | The action that should be taken based on any External Organization found by matchingIdentifiers. |
division | object | No | — | division |
externalOrganization | object | No | — | externalOrganization |
fieldRules | object | No | — | fieldRules |
id | string | No | — | A 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. |
matchingIdentifiers | any[] | No | — | An 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. |
selfUri | string | No | — | The URI for this object |
genesys_contacts_post_relationships
Create a relationship Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
division | object | No | — | division |
externalDataSources | any[] | No | — | Links 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. |
externalOrganization | object | Yes | — | externalOrganization |
id | string | No | — | The globally unique identifier for the object. |
relationship | string | Yes | — | The relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant. Between 1 and 100 characters. |
selfUri | string | No | — | The URI for this object |
user | object | Yes | — | user |
genesys_contacts_put_contact
Update an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
address | object | No | — | address |
appleOpaqueIds | any[] | No | — | User information for an Apple account. Max: 10 ids |
canonicalContact | object | No | — | canonicalContact |
cellPhone | object | No | — | cellPhone |
createDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
customFields | object | No | — | Custom fields defined in the schema referenced by schemaId and schemaVersion. |
division | object | No | — | division |
externalDataSources | any[] | No | — | Links 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. |
externalIds | any[] | No | — | A list of external identifiers that identify this contact in an external system. Max: 10 ids |
externalOrganization | object | No | — | externalOrganization |
externalSystemUrl | string | No | — | A 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. |
facebookId | object | No | — | User information for a Facebook user interacting with a page or app |
firstName | string | No | — | The first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
homePhone | object | No | — | homePhone |
id | string | No | — | The globally unique identifier for the object. |
identifiers | any[] | No | — | Identifiers claimed by this contact |
instagramId | object | No | — | User information for an Instagram account |
lastName | string | No | — | The last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
lineId | object | No | — | User information for a Line account |
mergedFrom | any[] | No | — | The input contacts from the merge operation. |
mergedTo | object | No | — | mergedTo |
mergeOperation | object | No | — | mergeOperation |
mergeSet | any[] | No | — | The set of all contacts that are a part of the merge tree. If null, this contact is not a part of any merge. |
middleName | string | No | — | The middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
modifyDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
otherEmail | string | No | — | The other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format |
otherPhone | object | No | — | otherPhone |
personalEmail | string | No | — | The personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format |
salutation | string | No | — | The salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
schema | object | No | — | schema |
selfUri | string | No | — | The URI for this object |
surveyOptOut | boolean | No | — | surveyOptOut |
title | string | No | — | The title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
twitterId | object | No | — | User information for a twitter account. Either id OR screenName (or both) must be present |
type | string | No | — | The type of contact |
whatsAppId | object | No | — | User information for a WhatsApp account |
workEmail | string | No | — | The work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format |
workPhone | object | No | — | workPhone |
genesys_contacts_put_contact_note
Update a note for an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact Id |
noteId | string | Yes | — | Note Id |
createDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
createdBy | object | Yes | — | createdBy |
division | object | No | — | division |
entityId | string | No | — | The id of the contact or organization to which this note refers. This only needs to be set for input when using the Bulk APIs. |
entityType | string | No | — | This is only need to be set when using Bulk API. Using any other value than contact or organization will result in null being used. |
externalDataSources | any[] | No | — | Links 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. |
id | string | No | — | The globally unique identifier for the object. |
modifyDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
noteText | string | No | — | Between 1 and 32,000 characters. |
selfUri | string | No | — | The URI for this object |
genesys_contacts_put_conversation
Associate/disassociate an external contact with a conversation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
conversationId | string | Yes | — | Conversation ID |
communicationId | string | Yes | — | Communication ID |
externalContactId | string | No | — | An external contact ID. If not supplied, implies the conversation should be disassociated with any external contact. |
mediaType | string | Yes | — | Media type |
genesys_contacts_put_externalcontacts_contact
Update an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
address | object | No | — | address |
appleOpaqueIds | any[] | No | — | User information for an Apple account. Max: 10 ids |
canonicalContact | object | No | — | canonicalContact |
cellPhone | object | No | — | cellPhone |
createDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
customFields | object | No | — | Custom fields defined in the schema referenced by schemaId and schemaVersion. |
division | object | No | — | division |
externalDataSources | any[] | No | — | Links 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. |
externalIds | any[] | No | — | A list of external identifiers that identify this contact in an external system. Max: 10 ids |
externalOrganization | object | No | — | externalOrganization |
externalSystemUrl | string | No | — | A 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. |
facebookId | object | No | — | User information for a Facebook user interacting with a page or app |
firstName | string | No | — | The first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
homePhone | object | No | — | homePhone |
id | string | No | — | The globally unique identifier for the object. |
identifiers | any[] | No | — | Identifiers claimed by this contact |
instagramId | object | No | — | User information for an Instagram account |
lastName | string | No | — | The last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
lineId | object | No | — | User information for a Line account |
mergedFrom | any[] | No | — | The input contacts from the merge operation. |
mergedTo | object | No | — | mergedTo |
mergeOperation | object | No | — | mergeOperation |
mergeSet | any[] | No | — | The set of all contacts that are a part of the merge tree. If null, this contact is not a part of any merge. |
middleName | string | No | — | The middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
modifyDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
otherEmail | string | No | — | The other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format |
otherPhone | object | No | — | otherPhone |
personalEmail | string | No | — | The personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format |
salutation | string | No | — | The salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
schema | object | No | — | schema |
selfUri | string | No | — | The URI for this object |
surveyOptOut | boolean | No | — | surveyOptOut |
title | string | No | — | The title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped. |
twitterId | object | No | — | User information for a twitter account. Either id OR screenName (or both) must be present |
type | string | No | — | The type of contact |
whatsAppId | object | No | — | User information for a WhatsApp account |
workEmail | string | No | — | The work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format |
workPhone | object | No | — | workPhone |
genesys_contacts_put_externalsource
Update an External Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalSourceId | string | Yes | — | External Source ID |
active | boolean | No | — | active |
id | string | No | — | The globally unique identifier for the object. |
linkConfiguration | object | No | — | linkConfiguration |
name | string | Yes | — | The name of the external source. Must be unique. Max: 200 characters. Leading and trailing whitespace stripped. |
selfUri | string | No | — | The URI for this object |
genesys_contacts_put_organization
Update an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
address | object | No | — | address |
companyType | string | No | — | companyType |
createDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
customFields | object | No | — | Custom fields defined in the schema referenced by schemaId and schemaVersion. |
division | object | No | — | division |
employeeCount | integer | No | — | employeeCount |
externalDataSources | any[] | No | — | Links 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. |
externalIds | any[] | No | — | A list of external identifiers that identify this External Organization in an external system. Max 10 items. |
externalSystemUrl | string | No | — | A 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. |
faxNumber | object | No | — | faxNumber |
id | string | No | — | The globally unique identifier for the object. |
identifiers | any[] | No | — | Identifiers claimed by this external org |
industry | string | No | — | industry |
modifyDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
name | string | Yes | — | The name of the company. Max: 1000 characters. Leading and trailing whitespace stripped. |
phoneNumber | object | No | — | phoneNumber |
revenue | integer | No | — | revenue |
schema | object | No | — | schema |
selfUri | string | No | — | The URI for this object |
tags | any[] | No | — | tags |
tickers | any[] | No | — | tickers |
trustor | object | No | — | trustor |
twitterId | object | No | — | User information for a twitter account. Either id OR screenName (or both) must be present |
websites | any[] | No | — | websites |
genesys_contacts_put_organization_note
Update a note for an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization Id |
noteId | string | Yes | — | Note Id |
createDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
createdBy | object | Yes | — | createdBy |
division | object | No | — | division |
entityId | string | No | — | The id of the contact or organization to which this note refers. This only needs to be set for input when using the Bulk APIs. |
entityType | string | No | — | This is only need to be set when using Bulk API. Using any other value than contact or organization will result in null being used. |
externalDataSources | any[] | No | — | Links 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. |
id | string | No | — | The globally unique identifier for the object. |
modifyDate | string | No | — | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z |
noteText | string | No | — | Between 1 and 32,000 characters. |
selfUri | string | No | — | The URI for this object |
genesys_contacts_put_organization_trustor_trustor_id
Links a Trustor with an External Organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
trustorId | string | Yes | — | Trustor ID |
genesys_contacts_put_relationship
Update a relationship Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
relationshipId | string | Yes | — | Relationship Id |
division | object | No | — | division |
externalDataSources | any[] | No | — | Links 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. |
externalOrganization | object | Yes | — | externalOrganization |
id | string | No | — | The globally unique identifier for the object. |
relationship | string | Yes | — | The relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant. Between 1 and 100 characters. |
selfUri | string | No | — | The URI for this object |
user | object | Yes | — | user |

