/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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact ID"
}
},
"required": [
"PCID",
"contactId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact Id"
},
"noteId": {
"type": "string",
"description": "Note Id"
}
},
"required": [
"PCID",
"contactId",
"noteId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalSourceId": {
"type": "string",
"description": "External Source ID"
}
},
"required": [
"PCID",
"externalSourceId"
]
}
genesys_contacts_delete_organization
Delete an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization ID"
}
},
"required": [
"PCID",
"externalOrganizationId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization Id"
},
"noteId": {
"type": "string",
"description": "Note Id"
}
},
"required": [
"PCID",
"externalOrganizationId",
"noteId"
]
}
genesys_contacts_delete_organization_trustor
Unlink the Trustor for this External Organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization ID"
}
},
"required": [
"PCID",
"externalOrganizationId"
]
}
genesys_contacts_delete_relationship
Delete a relationship Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
relationshipId | string | Yes | — | Relationship Id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id"
}
},
"required": [
"PCID",
"relationshipId"
]
}
genesys_contacts_get_contact
Fetch an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
expand | string[] | No | — | which fields, if any, to expand |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact ID"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"externalOrganization",
"externalDataSources",
"identifiers",
"externalSources",
"division"
]
},
"description": "which fields, if any, to expand"
}
},
"required": [
"PCID",
"contactId"
]
}
genesys_contacts_get_contact_identifiers
List the identifiers for a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact ID"
}
},
"required": [
"PCID",
"contactId"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact ID"
},
"includeMerged": {
"type": "boolean",
"description": "Indicates whether to return segment assignments from all external contacts in the merge-set of the given one."
},
"limit": {
"type": "integer",
"description": "Number of entities to return. Default of 25, maximum of 500."
}
},
"required": [
"PCID",
"contactId"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact ID"
},
"pageSize": {
"type": "string",
"description": "Number of entities to return. Maximum of 200."
},
"after": {
"type": "string",
"description": "The cursor that points to the end of the set of entities that has been returned."
},
"includeMerged": {
"type": "boolean",
"description": "Indicates whether to return sessions from all external contacts in the merge-set of the given one."
}
},
"required": [
"PCID",
"contactId"
]
}
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 | string[] | No | — | which fields, if any, to expand |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact Id"
},
"noteId": {
"type": "string",
"description": "Note Id"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"author",
"externalDataSources",
"division"
]
},
"description": "which fields, if any, to expand"
}
},
"required": [
"PCID",
"contactId",
"noteId"
]
}
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 | string[] | No | — | which fields, if any, to expand. mergeset will include notes attached to ancestor contacts which have been merged into this one. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact Id"
},
"pageSize": {
"type": "integer",
"description": "Page size (limited to fetching first 1,000 records; pageSize <= 100; pageNumber * pageSize must be <= 1,000)"
},
"pageNumber": {
"type": "integer",
"description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"sortOrder": {
"type": "string",
"description": "The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\""
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"author",
"externalDataSources",
"division",
"mergeset"
]
},
"description": "which fields, if any, to expand. mergeset will include notes attached to ancestor contacts which have been merged into this one."
}
},
"required": [
"PCID",
"contactId"
]
}
genesys_contacts_get_contact_unresolved
Fetch an unresolved external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
expand | string[] | No | — | which fields, if any, to expand |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact ID"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"externalOrganization",
"externalDataSources",
"identifiers",
"division"
]
},
"description": "which fields, if any, to expand"
}
},
"required": [
"PCID",
"contactId"
]
}
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 | string[] | No | — | which fields, if any, to expand |
divisionIds | string[] | No | — | which divisions to search, up to 50 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"pageNumber": {
"type": "integer",
"description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"q": {
"type": "string",
"description": "User supplied search keywords (no special syntax is currently supported)"
},
"sortOrder": {
"type": "string",
"description": "The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\""
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"externalOrganization",
"externalDataSources",
"identifiers",
"externalSources",
"division"
]
},
"description": "which fields, if any, to expand"
},
"divisionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "which divisions to search, up to 50"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact ID"
},
"expand": {
"type": "array",
"description": "which fields, if any, to expand"
}
},
"required": [
"PCID",
"contactId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact Id"
},
"noteId": {
"type": "string",
"description": "Note Id"
},
"expand": {
"type": "array",
"description": "which fields, if any, to expand"
}
},
"required": [
"PCID",
"contactId",
"noteId"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact Id"
},
"pageSize": {
"type": "integer",
"description": "Page size (limited to fetching first 1,000 records; pageSize <= 100; pageNumber * pageSize must be <= 1,000)"
},
"pageNumber": {
"type": "integer",
"description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"sortOrder": {
"type": "string",
"description": "The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\""
},
"expand": {
"type": "array",
"description": "which fields, if any, to expand. mergeset will include notes attached to ancestor contacts which have been merged into this one."
}
},
"required": [
"PCID",
"contactId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"pageNumber": {
"type": "integer",
"description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"q": {
"type": "string",
"description": "User supplied search keywords (no special syntax is currently supported)"
},
"sortOrder": {
"type": "string",
"description": "The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\""
},
"expand": {
"type": "array",
"description": "which fields, if any, to expand"
},
"divisionIds": {
"type": "array",
"description": "which divisions to search, up to 50"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization ID"
},
"expand": {
"type": "array",
"description": "which fields, if any, to expand"
},
"includeTrustors": {
"type": "boolean",
"description": "(true or false) whether or not to include trustor information embedded in the externalOrganization"
}
},
"required": [
"PCID",
"externalOrganizationId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization ID"
},
"pageSize": {
"type": "integer",
"description": "Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"pageNumber": {
"type": "integer",
"description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"q": {
"type": "string",
"description": "User supplied search keywords (no special syntax is currently supported)"
},
"sortOrder": {
"type": "string",
"description": "The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\""
},
"expand": {
"type": "array",
"description": "which fields, if any, to expand"
}
},
"required": [
"PCID",
"externalOrganizationId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization Id"
},
"pageSize": {
"type": "integer",
"description": "Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"pageNumber": {
"type": "integer",
"description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"sortOrder": {
"type": "string",
"description": "The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\""
},
"expand": {
"type": "array",
"description": "which fields, if any, to expand"
}
},
"required": [
"PCID",
"externalOrganizationId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"pageNumber": {
"type": "integer",
"description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"q": {
"type": "string",
"description": "Search query"
},
"trustorId": {
"type": "array",
"description": "Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested"
},
"sortOrder": {
"type": "string",
"description": "The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. \"companyType:asc\", \"industry:desc\""
},
"expand": {
"type": "array",
"description": "which fields, if any, to expand"
},
"includeTrustors": {
"type": "boolean",
"description": "(true or false) whether or not to include trustor information embedded in the externalOrganization"
},
"divisionIds": {
"type": "array",
"description": "which divisions to search, up to 50"
}
},
"required": [
"PCID"
]
}
genesys_contacts_get_externalsource
Fetch an External Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalSourceId | string | Yes | — | External Source ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalSourceId": {
"type": "string",
"description": "External Source ID"
}
},
"required": [
"PCID",
"externalSourceId"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cursor": {
"type": "string",
"description": "Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL"
},
"limit": {
"type": "integer",
"description": "The number of ExternalSources per page; must be between 10 and 200, default is 100"
},
"name": {
"type": "string",
"description": "Filter by external source name. Filtering is prefix filtering and not an exact match"
},
"active": {
"type": "boolean",
"description": "Filter by active status of external source"
}
},
"required": [
"PCID"
]
}
genesys_contacts_get_organization
Fetch an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
expand | string[] | No | — | which fields, if any, to expand |
includeTrustors | boolean | No | — | (true or false) whether or not to include trustor information embedded in the externalOrganization |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization ID"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"externalDataSources",
"division",
"identifiers",
"externalSources"
]
},
"description": "which fields, if any, to expand"
},
"includeTrustors": {
"type": "boolean",
"description": "(true or false) whether or not to include trustor information embedded in the externalOrganization"
}
},
"required": [
"PCID",
"externalOrganizationId"
]
}
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 | string[] | No | — | which fields, if any, to expand |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization ID"
},
"pageSize": {
"type": "integer",
"description": "Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"pageNumber": {
"type": "integer",
"description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"q": {
"type": "string",
"description": "User supplied search keywords (no special syntax is currently supported)"
},
"sortOrder": {
"type": "string",
"description": "The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \"firstName:asc\", \"title:desc\""
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"externalOrganization",
"externalDataSources",
"identifiers",
"externalSources",
"division"
]
},
"description": "which fields, if any, to expand"
}
},
"required": [
"PCID",
"externalOrganizationId"
]
}
genesys_contacts_get_organization_identifiers
List the identifiers for an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization ID"
}
},
"required": [
"PCID",
"externalOrganizationId"
]
}
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 | string[] | No | — | which fields, if any, to expand |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization Id"
},
"noteId": {
"type": "string",
"description": "Note Id"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"author",
"externalDataSources",
"division"
]
},
"description": "which fields, if any, to expand"
}
},
"required": [
"PCID",
"externalOrganizationId",
"noteId"
]
}
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 | string[] | No | — | which fields, if any, to expand |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization Id"
},
"pageSize": {
"type": "integer",
"description": "Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"pageNumber": {
"type": "integer",
"description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"sortOrder": {
"type": "string",
"description": "The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"createDate:desc\""
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"author",
"externalDataSources",
"division"
]
},
"description": "which fields, if any, to expand"
}
},
"required": [
"PCID",
"externalOrganizationId"
]
}
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 | string[] | 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” |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization ID"
},
"pageSize": {
"type": "integer",
"description": "Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"pageNumber": {
"type": "integer",
"description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"externalDataSources",
"division"
]
},
"description": "which fields, if any, to expand"
},
"sortOrder": {
"type": "string",
"description": "The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. \"createDate:asc\", \"relationship:desc\""
}
},
"required": [
"PCID",
"externalOrganizationId"
]
}
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 | string[] | 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 | string[] | 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 | string[] | No | — | which divisions to search, up to 50 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"pageSize": {
"type": "integer",
"description": "Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"pageNumber": {
"type": "integer",
"description": "Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)"
},
"q": {
"type": "string",
"description": "Search query"
},
"trustorId": {
"type": "array",
"items": {
"type": "string"
},
"description": "Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested"
},
"sortOrder": {
"type": "string",
"description": "The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. \"companyType:asc\", \"industry:desc\""
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"externalDataSources",
"division",
"identifiers",
"externalSources"
]
},
"description": "which fields, if any, to expand"
},
"includeTrustors": {
"type": "boolean",
"description": "(true or false) whether or not to include trustor information embedded in the externalOrganization"
},
"divisionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "which divisions to search, up to 50"
}
},
"required": [
"PCID"
]
}
genesys_contacts_get_relationship
Fetch a relationship Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
relationshipId | string | Yes | — | Relationship Id |
expand | string[] | No | — | which fields, if any, to expand |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"externalDataSources",
"division"
]
},
"description": "which fields, if any, to expand"
}
},
"required": [
"PCID",
"relationshipId"
]
}
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 | string[] | No | — | which field, if any, to expand |
divisionId | string | No | — | Specifies which division to lookup contacts in, for the given lookup value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"lookupVal": {
"type": "string",
"description": "User supplied value to lookup contacts (supports email addresses, e164 phone numbers, Twitter screen names)"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"contacts.externalOrganization",
"externalDataSources",
"division"
]
},
"description": "which field, if any, to expand"
},
"divisionId": {
"type": "string",
"description": "Specifies which division to lookup contacts in, for the given lookup value"
}
},
"required": [
"PCID",
"lookupVal"
]
}
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 | — | The identifier value |
operation | string | Yes | — | The operation to perform claim/release |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact ID"
},
"identifier": {
"type": "object",
"description": "The identifier value",
"properties": {
"division": {
"type": "object",
"description": "The division value"
},
"type": {
"type": "string",
"description": "The type of this identifier",
"enum": [
"SocialLine",
"SocialFacebook",
"SocialTwitter",
"SocialWhatsapp",
"SocialInstagram",
"SocialWhatsappBsuid",
"AppleOpaqueId",
"Email",
"Phone",
"Cookie",
"ExternalId"
]
},
"value": {
"type": "string",
"description": "The string value of the identifier. Will vary in syntax by type. Max: 255 characters. Leading and trailing whitespace stripped."
},
"dateCreated": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"externalSource": {
"type": "object",
"description": "External Source"
}
},
"required": [
"type",
"value"
]
},
"operation": {
"type": "string",
"description": "The operation to perform claim/release",
"enum": [
"Claim",
"Release"
]
}
},
"required": [
"PCID",
"contactId",
"identifier",
"operation"
]
}
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 | — | The identifier value |
operation | string | Yes | — | The operation to perform claim/release |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization ID"
},
"identifier": {
"type": "object",
"description": "The identifier value",
"properties": {
"division": {
"type": "object",
"description": "The division value"
},
"type": {
"type": "string",
"description": "The type of this identifier",
"enum": [
"ExternalId"
]
},
"value": {
"type": "string",
"description": "The string value of the identifier. Will vary in syntax by type. Max: 255 characters."
},
"dateCreated": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"externalSource": {
"type": "object",
"description": "External Source"
}
},
"required": [
"type",
"value"
]
},
"operation": {
"type": "string",
"description": "The operation to perform claim/release",
"enum": [
"Claim",
"Release"
]
}
},
"required": [
"PCID",
"externalOrganizationId",
"identifier",
"operation"
]
}
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 | — | The assign value |
unassign | object | No | — | The unassign value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact ID"
},
"assign": {
"type": "object",
"description": "The assign value",
"properties": {
"segments": {
"type": "array",
"items": {
"type": "object"
},
"description": "The segments to be assigned."
}
},
"required": [
"segments"
]
},
"unassign": {
"type": "object",
"description": "The unassign value",
"properties": {
"segments": {
"type": "array",
"items": {
"type": "object"
},
"description": "The segments to be unassigned."
}
},
"required": [
"segments"
]
}
},
"required": [
"PCID",
"contactId"
]
}
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 | — | Created By |
division | object | No | — | The division value |
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 | object[] | 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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact Id"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createdBy": {
"type": "object",
"description": "Created By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"entityId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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.",
"enum": [
"contact",
"organization"
]
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"SALESFORCE"
],
"description": "The platform that was the source of the data. Example: a CRM like SALESFORCE."
},
"url": {
"type": "string",
"description": "An URL that links to the source record that contributed data to the associated entity."
}
}
},
"description": "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": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"noteText": {
"type": "string",
"description": "Between 1 and 32,000 characters."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"contactId",
"noteText"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact ID"
}
},
"required": [
"PCID",
"contactId"
]
}
genesys_contacts_post_contacts
Create an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | object | No | — | The address value |
appleOpaqueIds | object[] | No | — | User information for an Apple account. Max: 10 ids |
canonicalContact | object | No | — | Canonical Contact |
cellPhone | object | No | — | Cell Phone |
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 | — | The division value |
externalDataSources | object[] | 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 | object[] | No | — | A list of external identifiers that identify this contact in an external system. Max: 10 ids |
externalOrganization | object | No | — | External Organization |
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 | — | Home Phone |
id | string | No | — | The globally unique identifier for the object. |
identifiers | object[] | 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 | object[] | No | — | The input contacts from the merge operation. |
mergedTo | object | No | — | Merged To |
mergeOperation | object | No | — | Merge Operation |
mergeSet | object[] | 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 | — | Other Phone |
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 | — | The schema value |
selfUri | string | No | — | The URI for this object |
surveyOptOut | boolean | No | — | Survey Opt Out |
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 | — | Work Phone |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"address": {
"type": "object",
"description": "The address value",
"properties": {
"address1": {
"type": "string",
"description": "Max: 200 characters. Leading and trailing whitespace stripped."
},
"address2": {
"type": "string",
"description": "Max: 200 characters. Leading and trailing whitespace stripped."
},
"city": {
"type": "string",
"description": "Max: 100 characters. Leading and trailing whitespace stripped."
},
"state": {
"type": "string",
"description": "Max: 50 characters. Leading and trailing whitespace stripped."
},
"postalCode": {
"type": "string",
"description": "Max: 25 characters. Leading and trailing whitespace stripped."
},
"countryCode": {
"type": "string",
"description": "Max: 25 characters. Leading and trailing whitespace stripped."
}
}
},
"appleOpaqueIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Max: 255 characters. Leading and trailing whitespace stripped."
}
}
},
"description": "User information for an Apple account. Max: 10 ids"
},
"canonicalContact": {
"type": "object",
"description": "Canonical Contact",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
}
}
},
"cellPhone": {
"type": "object",
"description": "Cell Phone",
"properties": {
"display": {
"type": "string",
"description": "The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field. Max: 512 characters."
},
"extension": {
"type": "integer",
"description": "An optional extension for the provided phone number."
},
"acceptsSMS": {
"type": "boolean",
"description": "Whether this phone number can accept SMS messages."
},
"normalizationCountryCode": {
"type": "string",
"description": "The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America)."
},
"userInput": {
"type": "string",
"description": "The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system."
},
"e164": {
"type": "string",
"description": "The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."
},
"countryCode": {
"type": "string",
"description": "The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164. Max: 4 characters."
}
}
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by schemaId and schemaVersion."
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"SALESFORCE"
],
"description": "The platform that was the source of the data. Example: a CRM like SALESFORCE."
},
"url": {
"type": "string",
"description": "An URL that links to the source record that contributed data to the associated entity."
}
}
},
"description": "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": {
"type": "array",
"items": {
"type": "object",
"properties": {
"externalSource": {
"type": "object",
"description": "External Source"
},
"value": {
"type": "string",
"description": "The string value of the identifier. Max: 255 characters. Leading and trailing whitespace stripped."
}
},
"required": [
"externalSource",
"value"
]
},
"description": "A list of external identifiers that identify this contact in an external system. Max: 10 ids"
},
"externalOrganization": {
"type": "object",
"description": "External Organization",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name of the company. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"division": {
"type": "object",
"description": "The division value"
},
"companyType": {
"type": "string",
"description": "Company Type"
},
"industry": {
"type": "string",
"description": "The industry value"
},
"address": {
"type": "object",
"description": "The address value"
},
"phoneNumber": {
"type": "object",
"description": "Phone Number"
},
"faxNumber": {
"type": "object",
"description": "Fax Number"
},
"employeeCount": {
"type": "integer",
"description": "Employee Count"
},
"revenue": {
"type": "integer",
"description": "The revenue value"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"websites": {
"type": "array",
"items": {
"type": "string"
},
"description": "The websites value"
},
"tickers": {
"type": "array",
"items": {
"type": "object"
},
"description": "The tickers value"
},
"twitterId": {
"type": "object",
"description": "User information for a twitter account. Either id OR screenName (or both) must be present"
},
"externalSystemUrl": {
"type": "string",
"description": "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."
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"trustor": {
"type": "object",
"description": "The trustor value"
},
"schema": {
"type": "object",
"description": "The schema value"
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by schemaId and schemaVersion."
},
"identifiers": {
"type": "array",
"items": {
"type": "object"
},
"description": "Identifiers claimed by this external org"
},
"externalIds": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of external identifiers that identify this External Organization in an external system. Max 10 items."
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object"
},
"description": "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."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"name"
]
},
"externalSystemUrl": {
"type": "string",
"description": "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": {
"type": "object",
"description": "User information for a Facebook user interacting with a page or app",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "object"
},
"description": "The set of scopedIds that this person has. Each scopedId is specific to a page or app that the user interacts with. Max: 1 Id"
},
"displayName": {
"type": "string",
"description": "The displayName of this person's Facebook account. Roughly translates to user.first_name + ' ' + user.last_name in the Facebook API. Max: 100 characters."
}
},
"required": [
"ids"
]
},
"firstName": {
"type": "string",
"description": "The first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"homePhone": {
"type": "object",
"description": "Home Phone",
"properties": {
"display": {
"type": "string",
"description": "The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field. Max: 512 characters."
},
"extension": {
"type": "integer",
"description": "An optional extension for the provided phone number."
},
"acceptsSMS": {
"type": "boolean",
"description": "Whether this phone number can accept SMS messages."
},
"normalizationCountryCode": {
"type": "string",
"description": "The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America)."
},
"userInput": {
"type": "string",
"description": "The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system."
},
"e164": {
"type": "string",
"description": "The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."
},
"countryCode": {
"type": "string",
"description": "The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164. Max: 4 characters."
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"identifiers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"division": {
"type": "object",
"description": "The division value"
},
"type": {
"type": "string",
"enum": [
"SocialLine",
"SocialFacebook",
"SocialTwitter",
"SocialWhatsapp",
"SocialInstagram",
"SocialWhatsappBsuid",
"AppleOpaqueId",
"Email",
"Phone",
"Cookie",
"ExternalId"
],
"description": "The type of this identifier"
},
"value": {
"type": "string",
"description": "The string value of the identifier. Will vary in syntax by type. Max: 255 characters. Leading and trailing whitespace stripped."
},
"dateCreated": {
"type": "string",
"format": "date-time",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"externalSource": {
"type": "object",
"description": "External Source"
}
},
"required": [
"type",
"value"
]
},
"description": "Identifiers claimed by this contact"
},
"instagramId": {
"type": "object",
"description": "User information for an Instagram account",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "object"
},
"description": "The set of scopedIds that this person has. Each scopedId is specific to an Instagram page or app that the user interacts with. Max 1 id."
},
"displayName": {
"type": "string",
"description": "The displayName of the person who owns this Instagram account. Max: 100 characters."
},
"handle": {
"type": "string",
"description": "The handle of the person who owns this Instagram account. Max: 100 characters."
}
},
"required": [
"ids"
]
},
"lastName": {
"type": "string",
"description": "The last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"lineId": {
"type": "object",
"description": "User information for a Line account",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "object"
},
"description": "The set of Line userIds that this person has. Each userId is specific to the Line channel that the user interacts with. Max 1 Id."
},
"displayName": {
"type": "string",
"description": "The displayName of this person's account in Line. Max: 100 characters."
}
},
"required": [
"ids"
]
},
"mergedFrom": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "Self Uri"
}
}
},
"description": "The input contacts from the merge operation."
},
"mergedTo": {
"type": "object",
"description": "Merged To",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
}
}
},
"mergeOperation": {
"type": "object",
"description": "Merge Operation",
"properties": {
"sourceContact": {
"type": "object",
"description": "Source Contact"
},
"targetContact": {
"type": "object",
"description": "Target Contact"
},
"resultingContact": {
"type": "object",
"description": "Resulting Contact"
}
}
},
"mergeSet": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "Self Uri"
}
}
},
"description": "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": {
"type": "string",
"description": "The middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"otherEmail": {
"type": "string",
"description": "The other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"otherPhone": {
"type": "object",
"description": "Other Phone",
"properties": {
"display": {
"type": "string",
"description": "The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field. Max: 512 characters."
},
"extension": {
"type": "integer",
"description": "An optional extension for the provided phone number."
},
"acceptsSMS": {
"type": "boolean",
"description": "Whether this phone number can accept SMS messages."
},
"normalizationCountryCode": {
"type": "string",
"description": "The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America)."
},
"userInput": {
"type": "string",
"description": "The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system."
},
"e164": {
"type": "string",
"description": "The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."
},
"countryCode": {
"type": "string",
"description": "The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164. Max: 4 characters."
}
}
},
"personalEmail": {
"type": "string",
"description": "The personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"salutation": {
"type": "string",
"description": "The salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"schema": {
"type": "object",
"description": "The schema value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the schema. Only required if a schema is used for custom fields during external entity creation or updates."
},
"name": {
"type": "string",
"description": "The name value"
},
"version": {
"type": "integer",
"description": "The schema's version, a positive integer. Required for updates."
},
"appliesTo": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CONTACT",
"CONVERSATION",
"EXTERNAL_ORGANIZATION",
"OPEN_ACTION",
"WORKITEM",
"DECISION_TABLE",
"USER_CUSTOM_ATTRIBUTES",
"EXTERNAL_EVENTS"
]
},
"description": "Indicates the built-in entity type to which this schema applies."
},
"enabled": {
"type": "boolean",
"description": "The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists."
},
"createdBy": {
"type": "object",
"description": "Created By"
},
"dateCreated": {
"type": "string",
"description": "The date and time this schema version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"jsonSchema": {
"type": "object",
"description": "A JSON Schema document."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"jsonSchema",
"version"
]
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"surveyOptOut": {
"type": "boolean",
"description": "Survey Opt Out"
},
"title": {
"type": "string",
"description": "The title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"twitterId": {
"type": "object",
"description": "User information for a twitter account. Either id OR screenName (or both) must be present",
"properties": {
"id": {
"type": "string",
"description": "twitter user.id_str. Max: 255 characters"
},
"name": {
"type": "string",
"description": "twitter user.name. Max: 255 characters"
},
"screenName": {
"type": "string",
"description": "twitter user.screen_name. Max: 255 characters. Must match pattern: ^@?[A-Za-z0-9_]+$"
},
"verified": {
"type": "boolean",
"description": "whether this data has been verified using the twitter API"
},
"profileUrl": {
"type": "string",
"description": "url of user's twitter profile"
}
}
},
"type": {
"type": "string",
"description": "The type of contact",
"enum": [
"Ephemeral",
"Identified",
"Curated"
]
},
"whatsAppId": {
"type": "object",
"description": "User information for a WhatsApp account",
"properties": {
"phoneNumber": {
"type": "object",
"description": "Phone Number"
},
"displayName": {
"type": "string",
"description": "The displayName of this person's account in WhatsApp. Max: 100 characters."
}
},
"required": [
"phoneNumber"
]
},
"workEmail": {
"type": "string",
"description": "The work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"workPhone": {
"type": "object",
"description": "Work Phone",
"properties": {
"display": {
"type": "string",
"description": "The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field. Max: 512 characters."
},
"extension": {
"type": "integer",
"description": "An optional extension for the provided phone number."
},
"acceptsSMS": {
"type": "boolean",
"description": "Whether this phone number can accept SMS messages."
},
"normalizationCountryCode": {
"type": "string",
"description": "The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America)."
},
"userInput": {
"type": "string",
"description": "The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system."
},
"e164": {
"type": "string",
"description": "The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."
},
"countryCode": {
"type": "string",
"description": "The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164. Max: 4 characters."
}
}
}
},
"required": [
"PCID"
]
}
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 | — | The contact value |
division | object | No | — | The division value |
fieldRules | object | No | — | Field Rules |
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 | object[] | 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 | — | The options value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"dryRun": {
"type": "boolean",
"description": "If true, the request will not make any modifications, but will show you what the end result *would* be."
},
"action": {
"type": "string",
"description": "The action that should be taken based on any Contacts found by `matchingIdentifiers`.",
"enum": [
"Merge",
"Upsert",
"Update",
"Insert"
]
},
"contact": {
"type": "object",
"description": "The contact value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"division": {
"type": "object",
"description": "The division value"
},
"firstName": {
"type": "string",
"description": "The first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"middleName": {
"type": "string",
"description": "The middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"lastName": {
"type": "string",
"description": "The last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"salutation": {
"type": "string",
"description": "The salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"title": {
"type": "string",
"description": "The title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"workPhone": {
"type": "object",
"description": "Work Phone"
},
"cellPhone": {
"type": "object",
"description": "Cell Phone"
},
"homePhone": {
"type": "object",
"description": "Home Phone"
},
"otherPhone": {
"type": "object",
"description": "Other Phone"
},
"workEmail": {
"type": "string",
"description": "The work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"personalEmail": {
"type": "string",
"description": "The personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"otherEmail": {
"type": "string",
"description": "The other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"address": {
"type": "object",
"description": "The address value"
},
"twitterId": {
"type": "object",
"description": "User information for a twitter account. Either id OR screenName (or both) must be present"
},
"lineId": {
"type": "object",
"description": "User information for a Line account"
},
"whatsAppId": {
"type": "object",
"description": "User information for a WhatsApp account"
},
"facebookId": {
"type": "object",
"description": "User information for a Facebook user interacting with a page or app"
},
"instagramId": {
"type": "object",
"description": "User information for an Instagram account"
},
"appleOpaqueIds": {
"type": "array",
"items": {
"type": "object"
},
"description": "User information for an Apple account. Max: 10 ids"
},
"externalIds": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of external identifiers that identify this contact in an external system. Max: 10 ids"
},
"identifiers": {
"type": "array",
"items": {
"type": "object"
},
"description": "Identifiers claimed by this contact"
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"externalOrganization": {
"type": "object",
"description": "External Organization"
},
"surveyOptOut": {
"type": "boolean",
"description": "Survey Opt Out"
},
"externalSystemUrl": {
"type": "string",
"description": "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."
},
"schema": {
"type": "object",
"description": "The schema value"
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by schemaId and schemaVersion."
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object"
},
"description": "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."
},
"type": {
"type": "string",
"description": "The type of contact",
"enum": [
"Ephemeral",
"Identified",
"Curated"
]
},
"canonicalContact": {
"type": "object",
"description": "Canonical Contact"
},
"mergeSet": {
"type": "array",
"items": {
"type": "object"
},
"description": "The set of all contacts that are a part of the merge tree. If null, this contact is not a part of any merge."
},
"mergedFrom": {
"type": "array",
"items": {
"type": "object"
},
"description": "The input contacts from the merge operation."
},
"mergedTo": {
"type": "object",
"description": "Merged To"
},
"mergeOperation": {
"type": "object",
"description": "Merge Operation"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"fieldRules": {
"type": "object",
"description": "Field Rules",
"properties": {
"defaultAction": {
"type": "string",
"description": "Default behavior for combining data from the submitted request with any entity found in the database. The default behavior if unspecified is `PreferProvided`, meaning any non-null fields in the submitted request will override data in the database, but all null fields will remain unchanged. Omitting a field in the request payload means that it will be treated as null.",
"enum": [
"AlwaysUseProvided",
"PreferExisting",
"PreferProvided"
]
},
"rules": {
"type": "array",
"items": {
"type": "object"
},
"description": "Field-specific behaviors for how to combine data from different sources. For example, you can set a `defaultAction` of `PreferProvided`, but use different behaviors such as `AlwaysUseProvided` or `PreferExisting` for specific fields."
},
"defaultArrayAction": {
"type": "string",
"description": "Default behavior for combining items in array field from the submitted request with any array entity found in the database. The default behavior if unspecified is `fill`, meaning the field value will always be the partial concatenation of both the array in the Database and the array in the contact body, up to the size limit of the array",
"enum": [
"Replace",
"Extend",
"Fill"
]
}
}
},
"id": {
"type": "string",
"description": "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": {
"type": "array",
"items": {
"type": "object",
"properties": {
"division": {
"type": "object",
"description": "The division value"
},
"type": {
"type": "string",
"enum": [
"SocialLine",
"SocialFacebook",
"SocialTwitter",
"SocialWhatsapp",
"SocialInstagram",
"SocialWhatsappBsuid",
"AppleOpaqueId",
"Email",
"Phone",
"Cookie",
"ExternalId"
],
"description": "The type of this identifier"
},
"value": {
"type": "string",
"description": "The string value of the identifier. Will vary in syntax by type. Max: 255 characters. Leading and trailing whitespace stripped."
},
"dateCreated": {
"type": "string",
"format": "date-time",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"externalSource": {
"type": "object",
"description": "External Source"
}
},
"required": [
"type",
"value"
]
},
"description": "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": {
"type": "object",
"description": "The options value",
"properties": {
"promote": {
"type": "boolean",
"description": "If true, any matched contact will have its type updated to Curated. If false, any matched contact will keep its original type in the operation."
}
}
}
},
"required": [
"PCID",
"action",
"matchingIdentifiers"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact Id"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createdBy": {
"type": "object",
"description": "createdBy"
},
"division": {
"type": "object",
"description": "division"
},
"entityId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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.",
"enum": [
"contact",
"organization"
]
},
"externalDataSources": {
"type": "array",
"description": "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": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"noteText": {
"type": "string",
"description": "Between 1 and 32,000 characters."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"contactId",
"noteText"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"address": {
"type": "object",
"description": "address"
},
"appleOpaqueIds": {
"type": "array",
"description": "User information for an Apple account. Max: 10 ids"
},
"canonicalContact": {
"type": "object",
"description": "canonicalContact"
},
"cellPhone": {
"type": "object",
"description": "cellPhone"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by schemaId and schemaVersion."
},
"division": {
"type": "object",
"description": "division"
},
"externalDataSources": {
"type": "array",
"description": "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": {
"type": "array",
"description": "A list of external identifiers that identify this contact in an external system. Max: 10 ids"
},
"externalOrganization": {
"type": "object",
"description": "externalOrganization"
},
"externalSystemUrl": {
"type": "string",
"description": "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": {
"type": "object",
"description": "User information for a Facebook user interacting with a page or app"
},
"firstName": {
"type": "string",
"description": "The first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"homePhone": {
"type": "object",
"description": "homePhone"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"identifiers": {
"type": "array",
"description": "Identifiers claimed by this contact"
},
"instagramId": {
"type": "object",
"description": "User information for an Instagram account"
},
"lastName": {
"type": "string",
"description": "The last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"lineId": {
"type": "object",
"description": "User information for a Line account"
},
"mergedFrom": {
"type": "array",
"description": "The input contacts from the merge operation."
},
"mergedTo": {
"type": "object",
"description": "mergedTo"
},
"mergeOperation": {
"type": "object",
"description": "mergeOperation"
},
"mergeSet": {
"type": "array",
"description": "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": {
"type": "string",
"description": "The middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"otherEmail": {
"type": "string",
"description": "The other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"otherPhone": {
"type": "object",
"description": "otherPhone"
},
"personalEmail": {
"type": "string",
"description": "The personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"salutation": {
"type": "string",
"description": "The salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"schema": {
"type": "object",
"description": "schema"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"surveyOptOut": {
"type": "boolean",
"description": "surveyOptOut"
},
"title": {
"type": "string",
"description": "The title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"twitterId": {
"type": "object",
"description": "User information for a twitter account. Either id OR screenName (or both) must be present"
},
"type": {
"type": "string",
"description": "The type of contact",
"enum": [
"Ephemeral",
"Identified",
"Curated"
]
},
"whatsAppId": {
"type": "object",
"description": "User information for a WhatsApp account"
},
"workEmail": {
"type": "string",
"description": "The work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"workPhone": {
"type": "object",
"description": "workPhone"
}
},
"required": [
"PCID"
]
}
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "array",
"description": "which field, if any, to expand"
},
"dateCreated": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"division": {
"type": "object",
"description": "division"
},
"externalSource": {
"type": "object",
"description": "externalSource"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"type": {
"type": "string",
"description": "The type of this identifier",
"enum": [
"SocialLine",
"SocialFacebook",
"SocialTwitter",
"SocialWhatsapp",
"SocialInstagram",
"AppleOpaqueId",
"Email",
"Phone",
"Cookie",
"ExternalId"
]
},
"value": {
"type": "string",
"description": "The string value of the identifier. Will vary in syntax by type. Max: 255 characters. Leading and trailing whitespace stripped."
}
},
"required": [
"PCID",
"type",
"value"
]
}
genesys_contacts_post_externalsources
Create an External Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
active | boolean | No | — | The active value |
id | string | No | — | The globally unique identifier for the object. |
linkConfiguration | object | No | — | Link Configuration |
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"active": {
"type": "boolean",
"description": "The active value"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"linkConfiguration": {
"type": "object",
"description": "Link Configuration",
"properties": {
"uriTemplate": {
"type": "string",
"description": "Should be a valid URL (including the http/https protocol, port, and path [if any]). Leading and trailing whitespace stripped. Max 400 characters."
}
},
"required": [
"uriTemplate"
]
},
"name": {
"type": "string",
"description": "The name of the external source. Must be unique. Max: 200 characters. Leading and trailing whitespace stripped."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"name"
]
}
genesys_contacts_post_identifierlookup_contacts
Fetch a contact using an identifier type and value. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | 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 | — | The division value |
externalSource | object | No | — | External Source |
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"externalOrganization",
"identifiers",
"externalSources",
"division"
]
},
"description": "which field, if any, to expand"
},
"dateCreated": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"externalSource": {
"type": "object",
"description": "External Source",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name of the external source. Must be unique. Max: 200 characters. Leading and trailing whitespace stripped."
},
"active": {
"type": "boolean",
"description": "The active value"
},
"linkConfiguration": {
"type": "object",
"description": "Link Configuration"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"name"
]
},
"type": {
"type": "string",
"description": "The type of this identifier",
"enum": [
"SocialLine",
"SocialFacebook",
"SocialTwitter",
"SocialWhatsapp",
"SocialInstagram",
"SocialWhatsappBsuid",
"AppleOpaqueId",
"Email",
"Phone",
"Cookie",
"ExternalId"
]
},
"value": {
"type": "string",
"description": "The string value of the identifier. Will vary in syntax by type. Max: 255 characters. Leading and trailing whitespace stripped."
}
},
"required": [
"PCID",
"type",
"value"
]
}
genesys_contacts_post_identifierlookup_organizations
Fetch an external organization using an identifier type and value. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | 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 | — | The division value |
externalSource | object | No | — | External Source |
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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"identifiers",
"externalSources",
"division"
]
},
"description": "which field, if any, to expand"
},
"dateCreated": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"externalSource": {
"type": "object",
"description": "External Source",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name of the external source. Must be unique. Max: 200 characters. Leading and trailing whitespace stripped."
},
"active": {
"type": "boolean",
"description": "The active value"
},
"linkConfiguration": {
"type": "object",
"description": "Link Configuration"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"name"
]
},
"type": {
"type": "string",
"description": "The type of this identifier",
"enum": [
"ExternalId"
]
},
"value": {
"type": "string",
"description": "The string value of the identifier. Will vary in syntax by type. Max: 255 characters."
}
},
"required": [
"PCID",
"type",
"value"
]
}
genesys_contacts_post_merge
Merge up to 25 contacts into a new contact record Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactIds | string[] | Yes | — | The IDs of all contacts involved in the merge operation (must be between 2 and 25). |
valueOverride | object | No | — | Value Override |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "The IDs of all contacts involved in the merge operation (must be between 2 and 25)."
},
"valueOverride": {
"type": "object",
"description": "Value Override",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"division": {
"type": "object",
"description": "The division value"
},
"firstName": {
"type": "string",
"description": "The first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"middleName": {
"type": "string",
"description": "The middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"lastName": {
"type": "string",
"description": "The last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"salutation": {
"type": "string",
"description": "The salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"title": {
"type": "string",
"description": "The title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"workPhone": {
"type": "object",
"description": "Work Phone"
},
"cellPhone": {
"type": "object",
"description": "Cell Phone"
},
"homePhone": {
"type": "object",
"description": "Home Phone"
},
"otherPhone": {
"type": "object",
"description": "Other Phone"
},
"workEmail": {
"type": "string",
"description": "The work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"personalEmail": {
"type": "string",
"description": "The personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"otherEmail": {
"type": "string",
"description": "The other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"address": {
"type": "object",
"description": "The address value"
},
"twitterId": {
"type": "object",
"description": "User information for a twitter account. Either id OR screenName (or both) must be present"
},
"lineId": {
"type": "object",
"description": "User information for a Line account"
},
"whatsAppId": {
"type": "object",
"description": "User information for a WhatsApp account"
},
"facebookId": {
"type": "object",
"description": "User information for a Facebook user interacting with a page or app"
},
"instagramId": {
"type": "object",
"description": "User information for an Instagram account"
},
"appleOpaqueIds": {
"type": "array",
"items": {
"type": "object"
},
"description": "User information for an Apple account. Max: 10 ids"
},
"externalIds": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of external identifiers that identify this contact in an external system. Max: 10 ids"
},
"identifiers": {
"type": "array",
"items": {
"type": "object"
},
"description": "Identifiers claimed by this contact"
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"externalOrganization": {
"type": "object",
"description": "External Organization"
},
"surveyOptOut": {
"type": "boolean",
"description": "Survey Opt Out"
},
"externalSystemUrl": {
"type": "string",
"description": "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."
},
"schema": {
"type": "object",
"description": "The schema value"
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by schemaId and schemaVersion."
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object"
},
"description": "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."
},
"type": {
"type": "string",
"description": "The type of contact",
"enum": [
"Ephemeral",
"Identified",
"Curated"
]
},
"canonicalContact": {
"type": "object",
"description": "Canonical Contact"
},
"mergeSet": {
"type": "array",
"items": {
"type": "object"
},
"description": "The set of all contacts that are a part of the merge tree. If null, this contact is not a part of any merge."
},
"mergedFrom": {
"type": "array",
"items": {
"type": "object"
},
"description": "The input contacts from the merge operation."
},
"mergedTo": {
"type": "object",
"description": "Merged To"
},
"mergeOperation": {
"type": "object",
"description": "Merge Operation"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
}
},
"required": [
"PCID",
"contactIds"
]
}
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 | — | Created By |
division | object | No | — | The division value |
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 | object[] | 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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization Id"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createdBy": {
"type": "object",
"description": "Created By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"entityId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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.",
"enum": [
"contact",
"organization"
]
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"SALESFORCE"
],
"description": "The platform that was the source of the data. Example: a CRM like SALESFORCE."
},
"url": {
"type": "string",
"description": "An URL that links to the source record that contributed data to the associated entity."
}
}
},
"description": "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": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"noteText": {
"type": "string",
"description": "Between 1 and 32,000 characters."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"externalOrganizationId",
"noteText"
]
}
genesys_contacts_post_organizations
Create an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | object | No | — | The address value |
companyType | string | No | — | Company Type |
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 | — | The division value |
employeeCount | integer | No | — | Employee Count |
externalDataSources | object[] | 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 | object[] | 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 | — | Fax Number |
id | string | No | — | The globally unique identifier for the object. |
identifiers | object[] | No | — | Identifiers claimed by this external org |
industry | string | No | — | The industry value |
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 | — | Phone Number |
revenue | integer | No | — | The revenue value |
schema | object | No | — | The schema value |
selfUri | string | No | — | The URI for this object |
tags | string[] | No | — | The tags value |
tickers | object[] | No | — | The tickers value |
trustor | object | No | — | The trustor value |
twitterId | object | No | — | User information for a twitter account. Either id OR screenName (or both) must be present |
websites | string[] | No | — | The websites value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"address": {
"type": "object",
"description": "The address value",
"properties": {
"address1": {
"type": "string",
"description": "Max: 200 characters. Leading and trailing whitespace stripped."
},
"address2": {
"type": "string",
"description": "Max: 200 characters. Leading and trailing whitespace stripped."
},
"city": {
"type": "string",
"description": "Max: 100 characters. Leading and trailing whitespace stripped."
},
"state": {
"type": "string",
"description": "Max: 50 characters. Leading and trailing whitespace stripped."
},
"postalCode": {
"type": "string",
"description": "Max: 25 characters. Leading and trailing whitespace stripped."
},
"countryCode": {
"type": "string",
"description": "Max: 25 characters. Leading and trailing whitespace stripped."
}
}
},
"companyType": {
"type": "string",
"description": "Company Type"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by schemaId and schemaVersion."
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"employeeCount": {
"type": "integer",
"description": "Employee Count"
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"SALESFORCE"
],
"description": "The platform that was the source of the data. Example: a CRM like SALESFORCE."
},
"url": {
"type": "string",
"description": "An URL that links to the source record that contributed data to the associated entity."
}
}
},
"description": "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": {
"type": "array",
"items": {
"type": "object",
"properties": {
"externalSource": {
"type": "object",
"description": "External Source"
},
"value": {
"type": "string",
"description": "The string value of the identifier. Max: 255 characters. Leading and trailing whitespace stripped."
}
},
"required": [
"externalSource",
"value"
]
},
"description": "A list of external identifiers that identify this External Organization in an external system. Max 10 items."
},
"externalSystemUrl": {
"type": "string",
"description": "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": {
"type": "object",
"description": "Fax Number",
"properties": {
"display": {
"type": "string",
"description": "The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field. Max: 512 characters."
},
"extension": {
"type": "integer",
"description": "An optional extension for the provided phone number."
},
"acceptsSMS": {
"type": "boolean",
"description": "Whether this phone number can accept SMS messages."
},
"normalizationCountryCode": {
"type": "string",
"description": "The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America)."
},
"userInput": {
"type": "string",
"description": "The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system."
},
"e164": {
"type": "string",
"description": "The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."
},
"countryCode": {
"type": "string",
"description": "The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164. Max: 4 characters."
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"identifiers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"division": {
"type": "object",
"description": "The division value"
},
"type": {
"type": "string",
"enum": [
"ExternalId"
],
"description": "The type of this identifier"
},
"value": {
"type": "string",
"description": "The string value of the identifier. Will vary in syntax by type. Max: 255 characters."
},
"dateCreated": {
"type": "string",
"format": "date-time",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"externalSource": {
"type": "object",
"description": "External Source"
}
},
"required": [
"type",
"value"
]
},
"description": "Identifiers claimed by this external org"
},
"industry": {
"type": "string",
"description": "The industry value"
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"name": {
"type": "string",
"description": "The name of the company. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"phoneNumber": {
"type": "object",
"description": "Phone Number",
"properties": {
"display": {
"type": "string",
"description": "The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field. Max: 512 characters."
},
"extension": {
"type": "integer",
"description": "An optional extension for the provided phone number."
},
"acceptsSMS": {
"type": "boolean",
"description": "Whether this phone number can accept SMS messages."
},
"normalizationCountryCode": {
"type": "string",
"description": "The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America)."
},
"userInput": {
"type": "string",
"description": "The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system."
},
"e164": {
"type": "string",
"description": "The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."
},
"countryCode": {
"type": "string",
"description": "The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164. Max: 4 characters."
}
}
},
"revenue": {
"type": "integer",
"description": "The revenue value"
},
"schema": {
"type": "object",
"description": "The schema value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the schema. Only required if a schema is used for custom fields during external entity creation or updates."
},
"name": {
"type": "string",
"description": "The name value"
},
"version": {
"type": "integer",
"description": "The schema's version, a positive integer. Required for updates."
},
"appliesTo": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CONTACT",
"CONVERSATION",
"EXTERNAL_ORGANIZATION",
"OPEN_ACTION",
"WORKITEM",
"DECISION_TABLE",
"USER_CUSTOM_ATTRIBUTES",
"EXTERNAL_EVENTS"
]
},
"description": "Indicates the built-in entity type to which this schema applies."
},
"enabled": {
"type": "boolean",
"description": "The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists."
},
"createdBy": {
"type": "object",
"description": "Created By"
},
"dateCreated": {
"type": "string",
"description": "The date and time this schema version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"jsonSchema": {
"type": "object",
"description": "A JSON Schema document."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"jsonSchema",
"version"
]
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"tickers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The ticker symbol for this organization. Example: ININ, AAPL, MSFT, etc."
},
"exchange": {
"type": "string",
"description": "The exchange for this ticker symbol. Examples: NYSE, FTSE, NASDAQ, etc."
}
},
"required": [
"exchange",
"symbol"
]
},
"description": "The tickers value"
},
"trustor": {
"type": "object",
"description": "The trustor value",
"properties": {
"id": {
"type": "string",
"description": "Organization Id for this trust."
},
"enabled": {
"type": "boolean",
"description": "If disabled no trustee user will have access, even if they were previously added."
},
"dateCreated": {
"type": "string",
"description": "Date Trust was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createdBy": {
"type": "object",
"description": "Created By"
},
"organization": {
"type": "object",
"description": "The organization value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"enabled"
]
},
"twitterId": {
"type": "object",
"description": "User information for a twitter account. Either id OR screenName (or both) must be present",
"properties": {
"id": {
"type": "string",
"description": "twitter user.id_str. Max: 255 characters"
},
"name": {
"type": "string",
"description": "twitter user.name. Max: 255 characters"
},
"screenName": {
"type": "string",
"description": "twitter user.screen_name. Max: 255 characters. Must match pattern: ^@?[A-Za-z0-9_]+$"
},
"verified": {
"type": "boolean",
"description": "whether this data has been verified using the twitter API"
},
"profileUrl": {
"type": "string",
"description": "url of user's twitter profile"
}
}
},
"websites": {
"type": "array",
"items": {
"type": "string"
},
"description": "The websites value"
}
},
"required": [
"PCID",
"name"
]
}
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 | — | The division value |
externalOrganization | object | No | — | External Organization |
fieldRules | object | No | — | Field Rules |
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 | object[] | 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. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"dryRun": {
"type": "boolean",
"description": "If true, the request will not make any modifications, but will show you what the end result *would* be."
},
"action": {
"type": "string",
"description": "The action that should be taken based on any External Organization found by `matchingIdentifiers`.",
"enum": [
"Upsert",
"Update",
"Insert"
]
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"externalOrganization": {
"type": "object",
"description": "External Organization",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name of the company. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"division": {
"type": "object",
"description": "The division value"
},
"companyType": {
"type": "string",
"description": "Company Type"
},
"industry": {
"type": "string",
"description": "The industry value"
},
"address": {
"type": "object",
"description": "The address value"
},
"phoneNumber": {
"type": "object",
"description": "Phone Number"
},
"faxNumber": {
"type": "object",
"description": "Fax Number"
},
"employeeCount": {
"type": "integer",
"description": "Employee Count"
},
"revenue": {
"type": "integer",
"description": "The revenue value"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"websites": {
"type": "array",
"items": {
"type": "string"
},
"description": "The websites value"
},
"tickers": {
"type": "array",
"items": {
"type": "object"
},
"description": "The tickers value"
},
"twitterId": {
"type": "object",
"description": "User information for a twitter account. Either id OR screenName (or both) must be present"
},
"externalSystemUrl": {
"type": "string",
"description": "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."
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"trustor": {
"type": "object",
"description": "The trustor value"
},
"schema": {
"type": "object",
"description": "The schema value"
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by schemaId and schemaVersion."
},
"identifiers": {
"type": "array",
"items": {
"type": "object"
},
"description": "Identifiers claimed by this external org"
},
"externalIds": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of external identifiers that identify this External Organization in an external system. Max 10 items."
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object"
},
"description": "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."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"name"
]
},
"fieldRules": {
"type": "object",
"description": "Field Rules",
"properties": {
"defaultAction": {
"type": "string",
"description": "Default behavior for combining data from the submitted request with any entity found in the database. The default behavior if unspecified is `PreferProvided`, meaning any non-null fields in the submitted request will override data in the database, but all null fields will remain unchanged. Omitting a field in the request payload means that it will be treated as null.",
"enum": [
"AlwaysUseProvided",
"PreferExisting",
"PreferProvided"
]
},
"rules": {
"type": "array",
"items": {
"type": "object"
},
"description": "Field-specific behaviors for how to combine data from different sources. For example, you can set a `defaultAction` of `PreferProvided`, but use different behaviors such as `AlwaysUseProvided` or `PreferExisting` for specific fields."
},
"defaultArrayAction": {
"type": "string",
"description": "Default behavior for combining items in array field from the submitted request with any array entity found in the database. The default behavior if unspecified is `fill`, meaning the field value will always be the partial concatenation of both the array in the Database and the array in the contact body, up to the size limit of the array",
"enum": [
"Replace",
"Extend",
"Fill"
]
}
}
},
"id": {
"type": "string",
"description": "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": {
"type": "array",
"items": {
"type": "object",
"properties": {
"division": {
"type": "object",
"description": "The division value"
},
"type": {
"type": "string",
"enum": [
"ExternalId"
],
"description": "The type of this identifier"
},
"value": {
"type": "string",
"description": "The string value of the identifier. Will vary in syntax by type. Max: 255 characters."
},
"dateCreated": {
"type": "string",
"format": "date-time",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"externalSource": {
"type": "object",
"description": "External Source"
}
},
"required": [
"type",
"value"
]
},
"description": "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."
}
},
"required": [
"PCID"
]
}
genesys_contacts_post_relationships
Create a relationship Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
division | object | No | — | The division value |
externalDataSources | object[] | 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 | — | External Organization |
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 | — | The user value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"SALESFORCE"
],
"description": "The platform that was the source of the data. Example: a CRM like SALESFORCE."
},
"url": {
"type": "string",
"description": "An URL that links to the source record that contributed data to the associated entity."
}
}
},
"description": "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": {
"type": "object",
"description": "External Organization",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name of the company. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"division": {
"type": "object",
"description": "The division value"
},
"companyType": {
"type": "string",
"description": "Company Type"
},
"industry": {
"type": "string",
"description": "The industry value"
},
"address": {
"type": "object",
"description": "The address value"
},
"phoneNumber": {
"type": "object",
"description": "Phone Number"
},
"faxNumber": {
"type": "object",
"description": "Fax Number"
},
"employeeCount": {
"type": "integer",
"description": "Employee Count"
},
"revenue": {
"type": "integer",
"description": "The revenue value"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"websites": {
"type": "array",
"items": {
"type": "string"
},
"description": "The websites value"
},
"tickers": {
"type": "array",
"items": {
"type": "object"
},
"description": "The tickers value"
},
"twitterId": {
"type": "object",
"description": "User information for a twitter account. Either id OR screenName (or both) must be present"
},
"externalSystemUrl": {
"type": "string",
"description": "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."
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"trustor": {
"type": "object",
"description": "The trustor value"
},
"schema": {
"type": "object",
"description": "The schema value"
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by schemaId and schemaVersion."
},
"identifiers": {
"type": "array",
"items": {
"type": "object"
},
"description": "Identifiers claimed by this external org"
},
"externalIds": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of external identifiers that identify this External Organization in an external system. Max 10 items."
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object"
},
"description": "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."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"name"
]
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"relationship": {
"type": "string",
"description": "The relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant. Between 1 and 100 characters."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"user": {
"type": "object",
"description": "The user value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
}
},
"required": [
"PCID",
"externalOrganization",
"relationship",
"user"
]
}
genesys_contacts_put_contact
Update an external contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactId | string | Yes | — | ExternalContact ID |
address | object | No | — | The address value |
appleOpaqueIds | object[] | No | — | User information for an Apple account. Max: 10 ids |
canonicalContact | object | No | — | Canonical Contact |
cellPhone | object | No | — | Cell Phone |
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 | — | The division value |
externalDataSources | object[] | 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 | object[] | No | — | A list of external identifiers that identify this contact in an external system. Max: 10 ids |
externalOrganization | object | No | — | External Organization |
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 | — | Home Phone |
id | string | No | — | The globally unique identifier for the object. |
identifiers | object[] | 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 | object[] | No | — | The input contacts from the merge operation. |
mergedTo | object | No | — | Merged To |
mergeOperation | object | No | — | Merge Operation |
mergeSet | object[] | 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 | — | Other Phone |
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 | — | The schema value |
selfUri | string | No | — | The URI for this object |
surveyOptOut | boolean | No | — | Survey Opt Out |
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 | — | Work Phone |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact ID"
},
"address": {
"type": "object",
"description": "The address value",
"properties": {
"address1": {
"type": "string",
"description": "Max: 200 characters. Leading and trailing whitespace stripped."
},
"address2": {
"type": "string",
"description": "Max: 200 characters. Leading and trailing whitespace stripped."
},
"city": {
"type": "string",
"description": "Max: 100 characters. Leading and trailing whitespace stripped."
},
"state": {
"type": "string",
"description": "Max: 50 characters. Leading and trailing whitespace stripped."
},
"postalCode": {
"type": "string",
"description": "Max: 25 characters. Leading and trailing whitespace stripped."
},
"countryCode": {
"type": "string",
"description": "Max: 25 characters. Leading and trailing whitespace stripped."
}
}
},
"appleOpaqueIds": {
"type": "array",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "Max: 255 characters. Leading and trailing whitespace stripped."
}
}
},
"description": "User information for an Apple account. Max: 10 ids"
},
"canonicalContact": {
"type": "object",
"description": "Canonical Contact",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
}
}
},
"cellPhone": {
"type": "object",
"description": "Cell Phone",
"properties": {
"display": {
"type": "string",
"description": "The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field. Max: 512 characters."
},
"extension": {
"type": "integer",
"description": "An optional extension for the provided phone number."
},
"acceptsSMS": {
"type": "boolean",
"description": "Whether this phone number can accept SMS messages."
},
"normalizationCountryCode": {
"type": "string",
"description": "The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America)."
},
"userInput": {
"type": "string",
"description": "The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system."
},
"e164": {
"type": "string",
"description": "The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."
},
"countryCode": {
"type": "string",
"description": "The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164. Max: 4 characters."
}
}
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by schemaId and schemaVersion."
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"SALESFORCE"
],
"description": "The platform that was the source of the data. Example: a CRM like SALESFORCE."
},
"url": {
"type": "string",
"description": "An URL that links to the source record that contributed data to the associated entity."
}
}
},
"description": "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": {
"type": "array",
"items": {
"type": "object",
"properties": {
"externalSource": {
"type": "object",
"description": "External Source"
},
"value": {
"type": "string",
"description": "The string value of the identifier. Max: 255 characters. Leading and trailing whitespace stripped."
}
},
"required": [
"externalSource",
"value"
]
},
"description": "A list of external identifiers that identify this contact in an external system. Max: 10 ids"
},
"externalOrganization": {
"type": "object",
"description": "External Organization",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name of the company. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"division": {
"type": "object",
"description": "The division value"
},
"companyType": {
"type": "string",
"description": "Company Type"
},
"industry": {
"type": "string",
"description": "The industry value"
},
"address": {
"type": "object",
"description": "The address value"
},
"phoneNumber": {
"type": "object",
"description": "Phone Number"
},
"faxNumber": {
"type": "object",
"description": "Fax Number"
},
"employeeCount": {
"type": "integer",
"description": "Employee Count"
},
"revenue": {
"type": "integer",
"description": "The revenue value"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"websites": {
"type": "array",
"items": {
"type": "string"
},
"description": "The websites value"
},
"tickers": {
"type": "array",
"items": {
"type": "object"
},
"description": "The tickers value"
},
"twitterId": {
"type": "object",
"description": "User information for a twitter account. Either id OR screenName (or both) must be present"
},
"externalSystemUrl": {
"type": "string",
"description": "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."
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"trustor": {
"type": "object",
"description": "The trustor value"
},
"schema": {
"type": "object",
"description": "The schema value"
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by schemaId and schemaVersion."
},
"identifiers": {
"type": "array",
"items": {
"type": "object"
},
"description": "Identifiers claimed by this external org"
},
"externalIds": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of external identifiers that identify this External Organization in an external system. Max 10 items."
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object"
},
"description": "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."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"name"
]
},
"externalSystemUrl": {
"type": "string",
"description": "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": {
"type": "object",
"description": "User information for a Facebook user interacting with a page or app",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "object"
},
"description": "The set of scopedIds that this person has. Each scopedId is specific to a page or app that the user interacts with. Max: 1 Id"
},
"displayName": {
"type": "string",
"description": "The displayName of this person's Facebook account. Roughly translates to user.first_name + ' ' + user.last_name in the Facebook API. Max: 100 characters."
}
},
"required": [
"ids"
]
},
"firstName": {
"type": "string",
"description": "The first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"homePhone": {
"type": "object",
"description": "Home Phone",
"properties": {
"display": {
"type": "string",
"description": "The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field. Max: 512 characters."
},
"extension": {
"type": "integer",
"description": "An optional extension for the provided phone number."
},
"acceptsSMS": {
"type": "boolean",
"description": "Whether this phone number can accept SMS messages."
},
"normalizationCountryCode": {
"type": "string",
"description": "The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America)."
},
"userInput": {
"type": "string",
"description": "The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system."
},
"e164": {
"type": "string",
"description": "The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."
},
"countryCode": {
"type": "string",
"description": "The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164. Max: 4 characters."
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"identifiers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"division": {
"type": "object",
"description": "The division value"
},
"type": {
"type": "string",
"enum": [
"SocialLine",
"SocialFacebook",
"SocialTwitter",
"SocialWhatsapp",
"SocialInstagram",
"SocialWhatsappBsuid",
"AppleOpaqueId",
"Email",
"Phone",
"Cookie",
"ExternalId"
],
"description": "The type of this identifier"
},
"value": {
"type": "string",
"description": "The string value of the identifier. Will vary in syntax by type. Max: 255 characters. Leading and trailing whitespace stripped."
},
"dateCreated": {
"type": "string",
"format": "date-time",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"externalSource": {
"type": "object",
"description": "External Source"
}
},
"required": [
"type",
"value"
]
},
"description": "Identifiers claimed by this contact"
},
"instagramId": {
"type": "object",
"description": "User information for an Instagram account",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "object"
},
"description": "The set of scopedIds that this person has. Each scopedId is specific to an Instagram page or app that the user interacts with. Max 1 id."
},
"displayName": {
"type": "string",
"description": "The displayName of the person who owns this Instagram account. Max: 100 characters."
},
"handle": {
"type": "string",
"description": "The handle of the person who owns this Instagram account. Max: 100 characters."
}
},
"required": [
"ids"
]
},
"lastName": {
"type": "string",
"description": "The last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"lineId": {
"type": "object",
"description": "User information for a Line account",
"properties": {
"ids": {
"type": "array",
"items": {
"type": "object"
},
"description": "The set of Line userIds that this person has. Each userId is specific to the Line channel that the user interacts with. Max 1 Id."
},
"displayName": {
"type": "string",
"description": "The displayName of this person's account in Line. Max: 100 characters."
}
},
"required": [
"ids"
]
},
"mergedFrom": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "Self Uri"
}
}
},
"description": "The input contacts from the merge operation."
},
"mergedTo": {
"type": "object",
"description": "Merged To",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"description": "Self Uri"
}
}
},
"mergeOperation": {
"type": "object",
"description": "Merge Operation",
"properties": {
"sourceContact": {
"type": "object",
"description": "Source Contact"
},
"targetContact": {
"type": "object",
"description": "Target Contact"
},
"resultingContact": {
"type": "object",
"description": "Resulting Contact"
}
}
},
"mergeSet": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id value"
},
"selfUri": {
"type": "string",
"format": "uri",
"description": "Self Uri"
}
}
},
"description": "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": {
"type": "string",
"description": "The middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"otherEmail": {
"type": "string",
"description": "The other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"otherPhone": {
"type": "object",
"description": "Other Phone",
"properties": {
"display": {
"type": "string",
"description": "The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field. Max: 512 characters."
},
"extension": {
"type": "integer",
"description": "An optional extension for the provided phone number."
},
"acceptsSMS": {
"type": "boolean",
"description": "Whether this phone number can accept SMS messages."
},
"normalizationCountryCode": {
"type": "string",
"description": "The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America)."
},
"userInput": {
"type": "string",
"description": "The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system."
},
"e164": {
"type": "string",
"description": "The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."
},
"countryCode": {
"type": "string",
"description": "The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164. Max: 4 characters."
}
}
},
"personalEmail": {
"type": "string",
"description": "The personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"salutation": {
"type": "string",
"description": "The salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"schema": {
"type": "object",
"description": "The schema value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the schema. Only required if a schema is used for custom fields during external entity creation or updates."
},
"name": {
"type": "string",
"description": "The name value"
},
"version": {
"type": "integer",
"description": "The schema's version, a positive integer. Required for updates."
},
"appliesTo": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CONTACT",
"CONVERSATION",
"EXTERNAL_ORGANIZATION",
"OPEN_ACTION",
"WORKITEM",
"DECISION_TABLE",
"USER_CUSTOM_ATTRIBUTES",
"EXTERNAL_EVENTS"
]
},
"description": "Indicates the built-in entity type to which this schema applies."
},
"enabled": {
"type": "boolean",
"description": "The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists."
},
"createdBy": {
"type": "object",
"description": "Created By"
},
"dateCreated": {
"type": "string",
"description": "The date and time this schema version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"jsonSchema": {
"type": "object",
"description": "A JSON Schema document."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"jsonSchema",
"version"
]
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"surveyOptOut": {
"type": "boolean",
"description": "Survey Opt Out"
},
"title": {
"type": "string",
"description": "The title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"twitterId": {
"type": "object",
"description": "User information for a twitter account. Either id OR screenName (or both) must be present",
"properties": {
"id": {
"type": "string",
"description": "twitter user.id_str. Max: 255 characters"
},
"name": {
"type": "string",
"description": "twitter user.name. Max: 255 characters"
},
"screenName": {
"type": "string",
"description": "twitter user.screen_name. Max: 255 characters. Must match pattern: ^@?[A-Za-z0-9_]+$"
},
"verified": {
"type": "boolean",
"description": "whether this data has been verified using the twitter API"
},
"profileUrl": {
"type": "string",
"description": "url of user's twitter profile"
}
}
},
"type": {
"type": "string",
"description": "The type of contact",
"enum": [
"Ephemeral",
"Identified",
"Curated"
]
},
"whatsAppId": {
"type": "object",
"description": "User information for a WhatsApp account",
"properties": {
"phoneNumber": {
"type": "object",
"description": "Phone Number"
},
"displayName": {
"type": "string",
"description": "The displayName of this person's account in WhatsApp. Max: 100 characters."
}
},
"required": [
"phoneNumber"
]
},
"workEmail": {
"type": "string",
"description": "The work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"workPhone": {
"type": "object",
"description": "Work Phone",
"properties": {
"display": {
"type": "string",
"description": "The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field. Max: 512 characters."
},
"extension": {
"type": "integer",
"description": "An optional extension for the provided phone number."
},
"acceptsSMS": {
"type": "boolean",
"description": "Whether this phone number can accept SMS messages."
},
"normalizationCountryCode": {
"type": "string",
"description": "The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America)."
},
"userInput": {
"type": "string",
"description": "The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system."
},
"e164": {
"type": "string",
"description": "The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."
},
"countryCode": {
"type": "string",
"description": "The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164. Max: 4 characters."
}
}
}
},
"required": [
"PCID",
"contactId"
]
}
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 | — | Created By |
division | object | No | — | The division value |
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 | object[] | 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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact Id"
},
"noteId": {
"type": "string",
"description": "Note Id"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createdBy": {
"type": "object",
"description": "Created By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"entityId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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.",
"enum": [
"contact",
"organization"
]
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"SALESFORCE"
],
"description": "The platform that was the source of the data. Example: a CRM like SALESFORCE."
},
"url": {
"type": "string",
"description": "An URL that links to the source record that contributed data to the associated entity."
}
}
},
"description": "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": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"noteText": {
"type": "string",
"description": "Between 1 and 32,000 characters."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"contactId",
"noteId",
"createdBy"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"conversationId": {
"type": "string",
"description": "Conversation ID"
},
"communicationId": {
"type": "string",
"description": "Communication ID"
},
"externalContactId": {
"type": "string",
"description": "An external contact ID. If not supplied, implies the conversation should be disassociated with any external contact."
},
"mediaType": {
"type": "string",
"description": "Media type",
"enum": [
"CALL",
"CALLBACK",
"CHAT",
"COBROWSE",
"EMAIL",
"MESSAGE",
"INTERNAL_MESSAGE",
"SCREEN_MONITORING",
"SOCIAL_EXPRESSION",
"VIDEO",
"SCREENSHARE"
]
}
},
"required": [
"PCID",
"conversationId",
"communicationId",
"mediaType"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"contactId": {
"type": "string",
"description": "ExternalContact ID"
},
"address": {
"type": "object",
"description": "address"
},
"appleOpaqueIds": {
"type": "array",
"description": "User information for an Apple account. Max: 10 ids"
},
"canonicalContact": {
"type": "object",
"description": "canonicalContact"
},
"cellPhone": {
"type": "object",
"description": "cellPhone"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by schemaId and schemaVersion."
},
"division": {
"type": "object",
"description": "division"
},
"externalDataSources": {
"type": "array",
"description": "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": {
"type": "array",
"description": "A list of external identifiers that identify this contact in an external system. Max: 10 ids"
},
"externalOrganization": {
"type": "object",
"description": "externalOrganization"
},
"externalSystemUrl": {
"type": "string",
"description": "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": {
"type": "object",
"description": "User information for a Facebook user interacting with a page or app"
},
"firstName": {
"type": "string",
"description": "The first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"homePhone": {
"type": "object",
"description": "homePhone"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"identifiers": {
"type": "array",
"description": "Identifiers claimed by this contact"
},
"instagramId": {
"type": "object",
"description": "User information for an Instagram account"
},
"lastName": {
"type": "string",
"description": "The last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"lineId": {
"type": "object",
"description": "User information for a Line account"
},
"mergedFrom": {
"type": "array",
"description": "The input contacts from the merge operation."
},
"mergedTo": {
"type": "object",
"description": "mergedTo"
},
"mergeOperation": {
"type": "object",
"description": "mergeOperation"
},
"mergeSet": {
"type": "array",
"description": "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": {
"type": "string",
"description": "The middle name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"otherEmail": {
"type": "string",
"description": "The other email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"otherPhone": {
"type": "object",
"description": "otherPhone"
},
"personalEmail": {
"type": "string",
"description": "The personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"salutation": {
"type": "string",
"description": "The salutation of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"schema": {
"type": "object",
"description": "schema"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"surveyOptOut": {
"type": "boolean",
"description": "surveyOptOut"
},
"title": {
"type": "string",
"description": "The title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"twitterId": {
"type": "object",
"description": "User information for a twitter account. Either id OR screenName (or both) must be present"
},
"type": {
"type": "string",
"description": "The type of contact",
"enum": [
"Ephemeral",
"Identified",
"Curated"
]
},
"whatsAppId": {
"type": "object",
"description": "User information for a WhatsApp account"
},
"workEmail": {
"type": "string",
"description": "The work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format"
},
"workPhone": {
"type": "object",
"description": "workPhone"
}
},
"required": [
"PCID",
"contactId"
]
}
genesys_contacts_put_externalsource
Update an External Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalSourceId | string | Yes | — | External Source ID |
active | boolean | No | — | The active value |
id | string | No | — | The globally unique identifier for the object. |
linkConfiguration | object | No | — | Link Configuration |
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalSourceId": {
"type": "string",
"description": "External Source ID"
},
"active": {
"type": "boolean",
"description": "The active value"
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"linkConfiguration": {
"type": "object",
"description": "Link Configuration",
"properties": {
"uriTemplate": {
"type": "string",
"description": "Should be a valid URL (including the http/https protocol, port, and path [if any]). Leading and trailing whitespace stripped. Max 400 characters."
}
},
"required": [
"uriTemplate"
]
},
"name": {
"type": "string",
"description": "The name of the external source. Must be unique. Max: 200 characters. Leading and trailing whitespace stripped."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"externalSourceId",
"name"
]
}
genesys_contacts_put_organization
Update an external organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
externalOrganizationId | string | Yes | — | External Organization ID |
address | object | No | — | The address value |
companyType | string | No | — | Company Type |
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 | — | The division value |
employeeCount | integer | No | — | Employee Count |
externalDataSources | object[] | 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 | object[] | 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 | — | Fax Number |
id | string | No | — | The globally unique identifier for the object. |
identifiers | object[] | No | — | Identifiers claimed by this external org |
industry | string | No | — | The industry value |
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 | — | Phone Number |
revenue | integer | No | — | The revenue value |
schema | object | No | — | The schema value |
selfUri | string | No | — | The URI for this object |
tags | string[] | No | — | The tags value |
tickers | object[] | No | — | The tickers value |
trustor | object | No | — | The trustor value |
twitterId | object | No | — | User information for a twitter account. Either id OR screenName (or both) must be present |
websites | string[] | No | — | The websites value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization ID"
},
"address": {
"type": "object",
"description": "The address value",
"properties": {
"address1": {
"type": "string",
"description": "Max: 200 characters. Leading and trailing whitespace stripped."
},
"address2": {
"type": "string",
"description": "Max: 200 characters. Leading and trailing whitespace stripped."
},
"city": {
"type": "string",
"description": "Max: 100 characters. Leading and trailing whitespace stripped."
},
"state": {
"type": "string",
"description": "Max: 50 characters. Leading and trailing whitespace stripped."
},
"postalCode": {
"type": "string",
"description": "Max: 25 characters. Leading and trailing whitespace stripped."
},
"countryCode": {
"type": "string",
"description": "Max: 25 characters. Leading and trailing whitespace stripped."
}
}
},
"companyType": {
"type": "string",
"description": "Company Type"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by schemaId and schemaVersion."
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"employeeCount": {
"type": "integer",
"description": "Employee Count"
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"SALESFORCE"
],
"description": "The platform that was the source of the data. Example: a CRM like SALESFORCE."
},
"url": {
"type": "string",
"description": "An URL that links to the source record that contributed data to the associated entity."
}
}
},
"description": "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": {
"type": "array",
"items": {
"type": "object",
"properties": {
"externalSource": {
"type": "object",
"description": "External Source"
},
"value": {
"type": "string",
"description": "The string value of the identifier. Max: 255 characters. Leading and trailing whitespace stripped."
}
},
"required": [
"externalSource",
"value"
]
},
"description": "A list of external identifiers that identify this External Organization in an external system. Max 10 items."
},
"externalSystemUrl": {
"type": "string",
"description": "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": {
"type": "object",
"description": "Fax Number",
"properties": {
"display": {
"type": "string",
"description": "The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field. Max: 512 characters."
},
"extension": {
"type": "integer",
"description": "An optional extension for the provided phone number."
},
"acceptsSMS": {
"type": "boolean",
"description": "Whether this phone number can accept SMS messages."
},
"normalizationCountryCode": {
"type": "string",
"description": "The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America)."
},
"userInput": {
"type": "string",
"description": "The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system."
},
"e164": {
"type": "string",
"description": "The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."
},
"countryCode": {
"type": "string",
"description": "The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164. Max: 4 characters."
}
}
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"identifiers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"division": {
"type": "object",
"description": "The division value"
},
"type": {
"type": "string",
"enum": [
"ExternalId"
],
"description": "The type of this identifier"
},
"value": {
"type": "string",
"description": "The string value of the identifier. Will vary in syntax by type. Max: 255 characters."
},
"dateCreated": {
"type": "string",
"format": "date-time",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"externalSource": {
"type": "object",
"description": "External Source"
}
},
"required": [
"type",
"value"
]
},
"description": "Identifiers claimed by this external org"
},
"industry": {
"type": "string",
"description": "The industry value"
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"name": {
"type": "string",
"description": "The name of the company. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"phoneNumber": {
"type": "object",
"description": "Phone Number",
"properties": {
"display": {
"type": "string",
"description": "The displayed form of the phone number string. Users should input the phone number in this field, but it will be altered by the API on write. If the phone number can be read as E164, the value will be replaced with international formatted-version of the number. If the number cannot be read as E164, the value will be preserved as-is. In both cases, the provided input string will be copied to the userInput field. Max: 512 characters."
},
"extension": {
"type": "integer",
"description": "An optional extension for the provided phone number."
},
"acceptsSMS": {
"type": "boolean",
"description": "Whether this phone number can accept SMS messages."
},
"normalizationCountryCode": {
"type": "string",
"description": "The country code that will be used for E164 conversion of a provided phone number. If the country code is omitted from the provided phone number, the country code provided in this field will be used during the E164 conversion attempt. If this field is left empty, the default country code for any provided phone number that does not explicitly include a country code is assumed to be +1 (North America)."
},
"userInput": {
"type": "string",
"description": "The user-inputted phone number string that was provided to the display field on write. This field is not user-writeable and will always be set by the system."
},
"e164": {
"type": "string",
"description": "The E164-formatted form of the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164."
},
"countryCode": {
"type": "string",
"description": "The detected country code from the provided phone number. This field is not user-writeable and will only be set when the provided phone number could be read as E164. Max: 4 characters."
}
}
},
"revenue": {
"type": "integer",
"description": "The revenue value"
},
"schema": {
"type": "object",
"description": "The schema value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the schema. Only required if a schema is used for custom fields during external entity creation or updates."
},
"name": {
"type": "string",
"description": "The name value"
},
"version": {
"type": "integer",
"description": "The schema's version, a positive integer. Required for updates."
},
"appliesTo": {
"type": "array",
"items": {
"type": "string",
"enum": [
"CONTACT",
"CONVERSATION",
"EXTERNAL_ORGANIZATION",
"OPEN_ACTION",
"WORKITEM",
"DECISION_TABLE",
"USER_CUSTOM_ATTRIBUTES",
"EXTERNAL_EVENTS"
]
},
"description": "Indicates the built-in entity type to which this schema applies."
},
"enabled": {
"type": "boolean",
"description": "The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists."
},
"createdBy": {
"type": "object",
"description": "Created By"
},
"dateCreated": {
"type": "string",
"description": "The date and time this schema version was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"jsonSchema": {
"type": "object",
"description": "A JSON Schema document."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"jsonSchema",
"version"
]
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"tickers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "The ticker symbol for this organization. Example: ININ, AAPL, MSFT, etc."
},
"exchange": {
"type": "string",
"description": "The exchange for this ticker symbol. Examples: NYSE, FTSE, NASDAQ, etc."
}
},
"required": [
"exchange",
"symbol"
]
},
"description": "The tickers value"
},
"trustor": {
"type": "object",
"description": "The trustor value",
"properties": {
"id": {
"type": "string",
"description": "Organization Id for this trust."
},
"enabled": {
"type": "boolean",
"description": "If disabled no trustee user will have access, even if they were previously added."
},
"dateCreated": {
"type": "string",
"description": "Date Trust was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createdBy": {
"type": "object",
"description": "Created By"
},
"organization": {
"type": "object",
"description": "The organization value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"enabled"
]
},
"twitterId": {
"type": "object",
"description": "User information for a twitter account. Either id OR screenName (or both) must be present",
"properties": {
"id": {
"type": "string",
"description": "twitter user.id_str. Max: 255 characters"
},
"name": {
"type": "string",
"description": "twitter user.name. Max: 255 characters"
},
"screenName": {
"type": "string",
"description": "twitter user.screen_name. Max: 255 characters. Must match pattern: ^@?[A-Za-z0-9_]+$"
},
"verified": {
"type": "boolean",
"description": "whether this data has been verified using the twitter API"
},
"profileUrl": {
"type": "string",
"description": "url of user's twitter profile"
}
}
},
"websites": {
"type": "array",
"items": {
"type": "string"
},
"description": "The websites value"
}
},
"required": [
"PCID",
"externalOrganizationId",
"name"
]
}
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 | — | Created By |
division | object | No | — | The division value |
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 | object[] | 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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization Id"
},
"noteId": {
"type": "string",
"description": "Note Id"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createdBy": {
"type": "object",
"description": "Created By",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"entityId": {
"type": "string",
"description": "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": {
"type": "string",
"description": "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.",
"enum": [
"contact",
"organization"
]
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"SALESFORCE"
],
"description": "The platform that was the source of the data. Example: a CRM like SALESFORCE."
},
"url": {
"type": "string",
"description": "An URL that links to the source record that contributed data to the associated entity."
}
}
},
"description": "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": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"noteText": {
"type": "string",
"description": "Between 1 and 32,000 characters."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"PCID",
"externalOrganizationId",
"noteId",
"createdBy"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"externalOrganizationId": {
"type": "string",
"description": "External Organization ID"
},
"trustorId": {
"type": "string",
"description": "Trustor ID"
}
},
"required": [
"PCID",
"externalOrganizationId",
"trustorId"
]
}
genesys_contacts_put_relationship
Update a relationship Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
relationshipId | string | Yes | — | Relationship Id |
division | object | No | — | The division value |
externalDataSources | object[] | 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 | — | External Organization |
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 | — | The user value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"relationshipId": {
"type": "string",
"description": "Relationship Id"
},
"division": {
"type": "object",
"description": "The division value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
}
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"SALESFORCE"
],
"description": "The platform that was the source of the data. Example: a CRM like SALESFORCE."
},
"url": {
"type": "string",
"description": "An URL that links to the source record that contributed data to the associated entity."
}
}
},
"description": "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": {
"type": "object",
"description": "External Organization",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name of the company. Max: 1000 characters. Leading and trailing whitespace stripped."
},
"division": {
"type": "object",
"description": "The division value"
},
"companyType": {
"type": "string",
"description": "Company Type"
},
"industry": {
"type": "string",
"description": "The industry value"
},
"address": {
"type": "object",
"description": "The address value"
},
"phoneNumber": {
"type": "object",
"description": "Phone Number"
},
"faxNumber": {
"type": "object",
"description": "Fax Number"
},
"employeeCount": {
"type": "integer",
"description": "Employee Count"
},
"revenue": {
"type": "integer",
"description": "The revenue value"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The tags value"
},
"websites": {
"type": "array",
"items": {
"type": "string"
},
"description": "The websites value"
},
"tickers": {
"type": "array",
"items": {
"type": "object"
},
"description": "The tickers value"
},
"twitterId": {
"type": "object",
"description": "User information for a twitter account. Either id OR screenName (or both) must be present"
},
"externalSystemUrl": {
"type": "string",
"description": "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."
},
"modifyDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"createDate": {
"type": "string",
"description": "Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"trustor": {
"type": "object",
"description": "The trustor value"
},
"schema": {
"type": "object",
"description": "The schema value"
},
"customFields": {
"type": "object",
"description": "Custom fields defined in the schema referenced by schemaId and schemaVersion."
},
"identifiers": {
"type": "array",
"items": {
"type": "object"
},
"description": "Identifiers claimed by this external org"
},
"externalIds": {
"type": "array",
"items": {
"type": "object"
},
"description": "A list of external identifiers that identify this External Organization in an external system. Max 10 items."
},
"externalDataSources": {
"type": "array",
"items": {
"type": "object"
},
"description": "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."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"name"
]
},
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"relationship": {
"type": "string",
"description": "The relationship or role of the user to this external organization.Examples: Account Manager, Sales Engineer, Implementation Consultant. Between 1 and 100 characters."
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
},
"user": {
"type": "object",
"description": "The user value",
"properties": {
"id": {
"type": "string",
"description": "The globally unique identifier for the object."
},
"name": {
"type": "string",
"description": "The name value"
},
"division": {
"type": "object",
"description": "The division value"
},
"chat": {
"type": "object",
"description": "The chat value"
},
"department": {
"type": "string",
"description": "The department value"
},
"email": {
"type": "string",
"description": "The email value"
},
"primaryContactInfo": {
"type": "array",
"items": {
"type": "object"
},
"description": "Auto populated from addresses."
},
"addresses": {
"type": "array",
"items": {
"type": "object"
},
"description": "Email addresses and phone numbers for this user"
},
"state": {
"type": "string",
"description": "The current state for this user.",
"enum": [
"active",
"inactive",
"deleted"
]
},
"title": {
"type": "string",
"description": "The title value"
},
"username": {
"type": "string",
"description": "The username value"
},
"manager": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/User"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"version": {
"type": "integer",
"description": "Required when updating a user, this value should be the current version of the user. The current version can be obtained with a GET on the user before doing a PATCH."
},
"certifications": {
"type": "array",
"items": {
"type": "string"
},
"description": "The certifications value"
},
"biography": {
"type": "object",
"description": "The biography value"
},
"employerInfo": {
"type": "object",
"description": "Employer Info"
},
"preferredName": {
"type": "string",
"description": "Preferred full name of the agent"
},
"routingStatus": {
"type": "object",
"description": "Routing Status"
},
"presence": {
"type": "object",
"description": "The presence value"
},
"integrationPresence": {
"type": "object",
"description": "Integration Presence"
},
"conversationSummary": {
"type": "object",
"description": "Conversation Summary"
},
"outOfOffice": {
"type": "object",
"description": "Out Of Office"
},
"geolocation": {
"type": "object",
"description": "The geolocation value"
},
"station": {
"type": "object",
"description": "The station value"
},
"authorization": {
"type": "object",
"description": "The authorization value"
},
"profileSkills": {
"type": "array",
"items": {
"type": "string"
},
"description": "Profile skills possessed by the user"
},
"locations": {
"type": "array",
"items": {
"type": "object"
},
"description": "The user placement at each site location."
},
"groups": {
"type": "array",
"items": {
"type": "object"
},
"description": "The groups the user is a member of"
},
"team": {
"type": "object",
"description": "The team value"
},
"workPlanBidRanks": {
"type": "object",
"description": "Work Plan Bid Ranks"
},
"skills": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) skills possessed by the user"
},
"languages": {
"type": "array",
"items": {
"type": "object"
},
"description": "Routing (ACD) languages possessed by the user"
},
"acdAutoAnswer": {
"type": "boolean",
"description": "acd auto answer"
},
"languagePreference": {
"type": "string",
"description": "preferred language by the user"
},
"lastTokenIssued": {
"type": "object",
"description": "Last Token Issued"
},
"dateLastLogin": {
"type": "string",
"description": "The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"dateWelcomeSent": {
"type": "string",
"description": "The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z"
},
"selfUri": {
"type": "string",
"description": "The URI for this object"
}
},
"required": [
"version"
]
}
},
"required": [
"PCID",
"relationshipId",
"externalOrganization",
"relationship",
"user"
]
}