Genesys Cloud

App · 20 actions

Manage external contacts and organizations; read users, groups, routing queues and divisions.

Actions

ActionWhat it does
Create contactCreate contact in Genesys Cloud.
Create external organizationCreate external organization in Genesys Cloud.
Delete contactDelete contact in Genesys Cloud.
Delete external organizationDelete external organization in Genesys Cloud.
Get contactGet contact in Genesys Cloud.
Get divisionGet division in Genesys Cloud.
Get external organizationGet external organization in Genesys Cloud.
Get groupGet group in Genesys Cloud.
Get organizationGet organization in Genesys Cloud.
Get queueGet queue in Genesys Cloud.
Get userGet user in Genesys Cloud.
List contactsList contacts in Genesys Cloud.
List divisionsList divisions in Genesys Cloud.
List groupsList groups in Genesys Cloud.
List organizationsList organizations in Genesys Cloud.
List presence definitionsList presence definitions in Genesys Cloud.
List queuesList queues in Genesys Cloud.
List usersList users in Genesys Cloud.
Update contactUpdate contact in Genesys Cloud.
Update external organizationUpdate external organization in Genesys Cloud.

Create contact

Create contact in Genesys Cloud.

Inputs

First namefirst_nametext
The first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
Last namelast_nametext
The last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
Titletitletext
The title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
Work phonework_phoneobject
Work phone.
Cell phonecell_phoneobject
Cell phone.
Work emailwork_emailtext
The work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
Personal emailpersonal_emailtext
The personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
Addressaddressobject
Address.
External organizationexternal_organizationobject
External organization.
External system urlexternal_system_urltext
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.
Schemaschemaobject
The schema defining custom fields for this contact
Custom fieldscustom_fieldsobject
Custom fields defined in the schema referenced by schemaId and schemaVersion.

Outputs

dataobject
Genesys Cloud response data.
Example output
{
  "data": {
    "address": {
      "address1": "example",
      "address2": "example",
      "city": "example",
      "countryCode": "example",
      "postalCode": "example",
      "state": "example"
    },
    "appleOpaqueIds": [],
    "canonicalContact": {
      "id": "example",
      "selfUri": "example"
    },
    "cellPhone": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "createDate": "example",
    "customFields": {},
    "division": {
      "id": "example",
      "name": "example",
      "selfUri": "example"
    },
    "externalDataSources": [],
    "externalIds": [],
    "externalOrganization": {
      "address": {
        "address1": "example",
        "address2": "example",
        "city": "example",
        "countryCode": "example",
        "postalCode": "example",
        "state": "example"
      },
      "companyType": "example",
      "createDate": "example",
      "customFields": {},
      "division": {
        "id": "example",
        "name": "example",
        "selfUri": "example"
      },
      "employeeCount": 1,
      "externalDataSources": [],
      "externalIds": [],
      "externalSystemUrl": "example",
      "faxNumber": {
        "acceptsSMS": false,
        "countryCode": "example",
        "display": "example",
        "e164": "example",
        "extension": 1,
        "normalizationCountryCode": "example",
        "userInput": "example"
      },
      "id": "example",
      "identifiers": [],
      "industry": "example",
      "modifyDate": "example",
      "name": "example",
      "phoneNumber": {
        "acceptsSMS": false,
        "countryCode": "example",
        "display": "example",
        "e164": "example",
        "extension": 1,
        "normalizationCountryCode": "example",
        "userInput": "example"
      },
      "revenue": 1,
      "schema": {
        "appliesTo": [],
        "createdBy": {
          "id": "example",
          "name": "example",
          "selfUri": "example"
        },
        "dateCreated": "example",
        "enabled": false,
        "id": "example",
        "jsonSchema": {
          "$schema": "example",
          "additionalProperties": {},
          "description": "example",
          "id": "example",
          "properties": {},
          "required": [],
          "title": "example",
          "type": "example"
        },
        "name": "example",
        "selfUri": "example",
        "version": 1
      },
      "selfUri": "example",
      "tags": [],
      "tickers": [],
      "trustor": {
        "authorization": {
          "permissions": []
        },
        "createdBy": {
          "acdAutoAnswer": false,
          "addresses": [],
          "authorization": {
            "permissionPolicies": [],
            "permissions": [],
            "roles": [],
            "unusedRoles": []
          },
          "biography": {
            "biography": "example",
            "education": [],
            "hobbies": [],
            "interests": [],
            "spouse": "example"
          },
          "certifications": [],
          "chat": {
            "jabberId": "example"
          },
          "conversationSummary": {
            "call": {
              "contactCenter": {},
              "enterprise": {}
            },
            "callback": {
              "contactCenter": {},
              "enterprise": {}
            },
            "chat": {
              "contactCenter": {},
              "enterprise": {}
            },
            "email": {
              "contactCenter": {},
              "enterprise": {}
            },
            "message": {
              "contactCenter": {},
              "enterprise": {}
            },
            "socialExpression": {
              "contactCenter": {},
              "enterprise": {}
            },
            "userId": "example",
            "video": {
              "contactCenter": {},
              "enterprise": {}
            }
          },
          "dateLastLogin": "example",
          "dateWelcomeSent": "example",
          "department": "example",
          "division": {
            "id": "example",
            "name": "example",
            "selfUri": "example"
          },
          "email": "example",
          "employerInfo": {
            "dateHire": "example",
            "employeeId": "example",
            "employeeType": "example",
            "officialName": "example"
          },
          "geolocation": {
            "city": "example",
            "country": "example",
            "id": "example",
            "latitude": 1.0,
            "locations": [],
            "longitude": 1.0,
            "name": "example",
            "primary": false,
            "region": "example",
            "selfUri": "example",
            "type": "example"
          },
          "groups": [],
          "id": "example",
          "images": [],
          "integrationPresence": {
            "futurePresenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "id": "example",
            "message": "example",
            "modifiedDate": "example",
            "name": "example",
            "presenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "primary": false,
            "selfUri": "example",
            "source": "example",
            "sourceId": "example"
          },
          "languagePreference": "example",
          "languages": [],
          "lastTokenIssued": {
            "dateIssued": "example"
          },
          "locations": [],
          "manager": {
            "acdAutoAnswer": false,
            "addresses": [],
            "authorization": {
              "permissionPolicies": [],
              "permissions": [],
              "roles": [],
              "unusedRoles": []
            },
            "biography": {
              "biography": "example",
              "education": [],
              "hobbies": [],
              "interests": [],
              "spouse": "example"
            },
            "certifications": [],
            "chat": {
              "jabberId": "example"
            },
            "conversationSummary": {
              "call": {},
              "callback": {},
              "chat": {},
              "email": {},
              "message": {},
              "socialExpression": {},
              "userId": "example",
              "video": {}
            },
            "dateLastLogin": "example",
            "dateWelcomeSent": "example",
            "department": "example",
            "division": {
              "id": "example",
              "name": "example",
              "selfUri": "example"
            },
            "email": "example",
            "employerInfo": {
              "dateHire": "example",
              "employeeId": "example",
              "employeeType": "example",
              "officialName": "example"
            },
            "geolocation": {
              "city": "example",
              "country": "example",
              "id": "example",
              "latitude": 1.0,
              "locations": [],
              "longitude": 1.0,
              "name": "example",
              "primary": false,
              "region": "example",
              "selfUri": "example",
              "type": "example"
            },
            "groups": [],
            "id": "example",
            "images": [],
            "integrationPresence": {
              "futurePresenceDefinition": {},
              "id": "example",
              "message": "example",
              "modifiedDate": "example",
              "name": "example",
              "presenceDefinition": {},
              "primary": false,
              "selfUri": "example",
              "source": "example",
              "sourceId": "example"
            },
            "languagePreference": "example",
            "languages": [],
            "lastTokenIssued": {
              "dateIssued": "example"
            },
            "locations": [],
            "manager": {},
            "name": "example",
            "outOfOffice": {
              "active": false,
              "endDate": "example",
              "id": "example",
              "indefinite": false,
              "name": "example",
              "selfUri": "example",
              "startDate": "example",
              "user": {}
            },
            "preferredName": "example",
            "presence": {
              "futurePresenceDefinition": {},
              "id": "example",
              "message": "example",
              "modifiedDate": "example",
              "name": "example",
              "presenceDefinition": {},
              "primary": false,
              "selfUri": "example",
              "source": "example",
              "sourceId": "example"
            },
            "primaryContactInfo": [],
            "profileSkills": [],
            "routingStatus": {
              "startTime": "example",
              "status": "OFF_QUEUE",
              "userId": "example"
            },
            "selfUri": "example",
            "skills": [],
            "state": "active",
            "station": {
              "associatedStation": {},
              "defaultStation": {},
              "effectiveStation": {},
              "lastAssociatedStation": {}
            },
            "team": {
              "dateCreated": "example",
              "dateModified": "example",
              "description": "example",
              "division": {},
              "id": "example",
              "memberCount": 1,
              "name": "example",
              "selfUri": "example"
            },
            "title": "example",
            "username": "example",
            "version": 1,
            "workPlanBidRanks": {
              "biddingTieBreaker": "example",
              "id": "example",
              "selfUri": "example",
              "workPlanBiddingPerformance": 1
            }
          },
          "name": "example",
          "organization": {
            "defaultCountryCode": "example",
            "defaultLanguage": "example",
            "defaultSiteId": "example",
            "domain": "example",
            "features": {},
            "id": "example",
            "name": "example",
            "productPlatform": "GenesysCloud",
            "selfUri": "example",
            "state": "active",
            "supportURI": "example",
            "thirdPartyOrgName": "example",
            "thirdPartyURI": "example",
            "version": 1,
            "voicemailEnabled": false
          },
          "outOfOffice": {
            "active": false,
            "endDate": "example",
            "id": "example",
            "indefinite": false,
            "name": "example",
            "selfUri": "example",
            "startDate": "example",
            "user": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            }
          },
          "preferredName": "example",
          "presence": {
            "futurePresenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "id": "example",
            "message": "example",
            "modifiedDate": "example",
            "name": "example",
            "presenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "primary": false,
            "selfUri": "example",
            "source": "example",
            "sourceId": "example"
          },
          "primaryContactInfo": [],
          "profileSkills": [],
          "routingStatus": {
            "startTime": "example",
            "status": "OFF_QUEUE",
            "userId": "example"
          },
          "skills": [],
          "state": "active",
          "station": {
            "associatedStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "defaultStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "effectiveStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "lastAssociatedStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            }
          },
          "team": {
            "dateCreated": "example",
            "dateModified": "example",
            "description": "example",
            "division": {
              "id": "example",
              "name": "example",
              "selfUri": "example"
            },
            "id": "example",
            "memberCount": 1,
            "name": "example",
            "selfUri": "example"
          },
          "title": "example",
          "username": "example",
          "version": 1,
          "workPlanBidRanks": {
            "biddingTieBreaker": "example",
            "id": "example",
            "selfUri": "example",
            "workPlanBiddingPerformance": 1
          }
        },
        "dateCreated": "example",
        "enabled": false,
        "id": "example",
        "organization": {
          "defaultCountryCode": "example",
          "defaultLanguage": "example",
          "defaultSiteId": "example",
          "domain": "example",
          "features": {},
          "id": "example",
          "name": "example",
          "productPlatform": "GenesysCloud",
          "selfUri": "example",
          "state": "active",
          "supportURI": "example",
          "thirdPartyOrgName": "example",
          "thirdPartyURI": "example",
          "version": 1,
          "voicemailEnabled": false
        },
        "selfUri": "example"
      },
      "twitterId": {
        "id": "example",
        "name": "example",
        "profileUrl": "example",
        "screenName": "example",
        "verified": false
      },
      "websites": []
    },
    "externalSystemUrl": "example",
    "facebookId": {
      "displayName": "example",
      "ids": []
    },
    "firstName": "example",
    "homePhone": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "id": "example",
    "identifiers": [],
    "instagramId": {
      "displayName": "example",
      "handle": "example",
      "ids": []
    },
    "lastName": "example",
    "lineId": {
      "displayName": "example",
      "ids": []
    },
    "mergeOperation": {
      "resultingContact": {
        "id": "example",
        "selfUri": "example"
      },
      "sourceContact": {
        "id": "example",
        "selfUri": "example"
      },
      "targetContact": {
        "id": "example",
        "selfUri": "example"
      }
    },
    "mergeSet": [],
    "mergedFrom": [],
    "mergedTo": {
      "id": "example",
      "selfUri": "example"
    },
    "middleName": "example",
    "modifyDate": "example",
    "otherEmail": "example",
    "otherPhone": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "personalEmail": "example",
    "salutation": "example",
    "schema": {
      "appliesTo": [],
      "createdBy": {
        "id": "example",
        "name": "example",
        "selfUri": "example"
      },
      "dateCreated": "example",
      "enabled": false,
      "id": "example",
      "jsonSchema": {
        "$schema": "example",
        "additionalProperties": {},
        "description": "example",
        "id": "example",
        "properties": {},
        "required": [],
        "title": "example",
        "type": "example"
      },
      "name": "example",
      "selfUri": "example",
      "version": 1
    },
    "selfUri": "example",
    "surveyOptOut": false,
    "title": "example",
    "twitterId": {
      "id": "example",
      "name": "example",
      "profileUrl": "example",
      "screenName": "example",
      "verified": false
    },
    "type": "Ephemeral",
    "whatsAppId": {
      "displayName": "example",
      "phoneNumber": {
        "acceptsSMS": false,
        "countryCode": "example",
        "display": "example",
        "e164": "example",
        "extension": 1,
        "normalizationCountryCode": "example",
        "userInput": "example"
      },
      "username": "example",
      "whatsAppBusinessScopedIds": []
    },
    "workEmail": "example",
    "workPhone": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    }
  }
}

Create external organization

Create external organization in Genesys Cloud.

Inputs

NamenametextRequired
The name of the company. Max: 1000 characters. Leading and trailing whitespace stripped.
Addressaddressobject
Address.
External system urlexternal_system_urltext
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.
Schemaschemaobject
The schema defining custom fields for this contact
Custom fieldscustom_fieldsobject
Custom fields defined in the schema referenced by schemaId and schemaVersion.

Outputs

dataobject
Genesys Cloud response data.
Example output
{
  "data": {
    "address": {
      "address1": "example",
      "address2": "example",
      "city": "example",
      "countryCode": "example",
      "postalCode": "example",
      "state": "example"
    },
    "companyType": "example",
    "createDate": "example",
    "customFields": {},
    "division": {
      "id": "example",
      "name": "example",
      "selfUri": "example"
    },
    "employeeCount": 1,
    "externalDataSources": [],
    "externalIds": [],
    "externalSystemUrl": "example",
    "faxNumber": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "id": "example",
    "identifiers": [],
    "industry": "example",
    "modifyDate": "example",
    "name": "example",
    "phoneNumber": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "revenue": 1,
    "schema": {
      "appliesTo": [],
      "createdBy": {
        "id": "example",
        "name": "example",
        "selfUri": "example"
      },
      "dateCreated": "example",
      "enabled": false,
      "id": "example",
      "jsonSchema": {
        "$schema": "example",
        "additionalProperties": {},
        "description": "example",
        "id": "example",
        "properties": {},
        "required": [],
        "title": "example",
        "type": "example"
      },
      "name": "example",
      "selfUri": "example",
      "version": 1
    },
    "selfUri": "example",
    "tags": [],
    "tickers": [],
    "trustor": {
      "authorization": {
        "permissions": []
      },
      "createdBy": {
        "acdAutoAnswer": false,
        "addresses": [],
        "authorization": {
          "permissionPolicies": [],
          "permissions": [],
          "roles": [],
          "unusedRoles": []
        },
        "biography": {
          "biography": "example",
          "education": [],
          "hobbies": [],
          "interests": [],
          "spouse": "example"
        },
        "certifications": [],
        "chat": {
          "jabberId": "example"
        },
        "conversationSummary": {
          "call": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "callback": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "chat": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "email": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "message": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "socialExpression": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "userId": "example",
          "video": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          }
        },
        "dateLastLogin": "example",
        "dateWelcomeSent": "example",
        "department": "example",
        "division": {
          "id": "example",
          "name": "example",
          "selfUri": "example"
        },
        "email": "example",
        "employerInfo": {
          "dateHire": "example",
          "employeeId": "example",
          "employeeType": "example",
          "officialName": "example"
        },
        "geolocation": {
          "city": "example",
          "country": "example",
          "id": "example",
          "latitude": 1.0,
          "locations": [],
          "longitude": 1.0,
          "name": "example",
          "primary": false,
          "region": "example",
          "selfUri": "example",
          "type": "example"
        },
        "groups": [],
        "id": "example",
        "images": [],
        "integrationPresence": {
          "futurePresenceDefinition": {
            "id": "example",
            "selfUri": "example",
            "systemPresence": "example"
          },
          "id": "example",
          "message": "example",
          "modifiedDate": "example",
          "name": "example",
          "presenceDefinition": {
            "id": "example",
            "selfUri": "example",
            "systemPresence": "example"
          },
          "primary": false,
          "selfUri": "example",
          "source": "example",
          "sourceId": "example"
        },
        "languagePreference": "example",
        "languages": [],
        "lastTokenIssued": {
          "dateIssued": "example"
        },
        "locations": [],
        "manager": {
          "acdAutoAnswer": false,
          "addresses": [],
          "authorization": {
            "permissionPolicies": [],
            "permissions": [],
            "roles": [],
            "unusedRoles": []
          },
          "biography": {
            "biography": "example",
            "education": [],
            "hobbies": [],
            "interests": [],
            "spouse": "example"
          },
          "certifications": [],
          "chat": {
            "jabberId": "example"
          },
          "conversationSummary": {
            "call": {
              "contactCenter": {},
              "enterprise": {}
            },
            "callback": {
              "contactCenter": {},
              "enterprise": {}
            },
            "chat": {
              "contactCenter": {},
              "enterprise": {}
            },
            "email": {
              "contactCenter": {},
              "enterprise": {}
            },
            "message": {
              "contactCenter": {},
              "enterprise": {}
            },
            "socialExpression": {
              "contactCenter": {},
              "enterprise": {}
            },
            "userId": "example",
            "video": {
              "contactCenter": {},
              "enterprise": {}
            }
          },
          "dateLastLogin": "example",
          "dateWelcomeSent": "example",
          "department": "example",
          "division": {
            "id": "example",
            "name": "example",
            "selfUri": "example"
          },
          "email": "example",
          "employerInfo": {
            "dateHire": "example",
            "employeeId": "example",
            "employeeType": "example",
            "officialName": "example"
          },
          "geolocation": {
            "city": "example",
            "country": "example",
            "id": "example",
            "latitude": 1.0,
            "locations": [],
            "longitude": 1.0,
            "name": "example",
            "primary": false,
            "region": "example",
            "selfUri": "example",
            "type": "example"
          },
          "groups": [],
          "id": "example",
          "images": [],
          "integrationPresence": {
            "futurePresenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "id": "example",
            "message": "example",
            "modifiedDate": "example",
            "name": "example",
            "presenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "primary": false,
            "selfUri": "example",
            "source": "example",
            "sourceId": "example"
          },
          "languagePreference": "example",
          "languages": [],
          "lastTokenIssued": {
            "dateIssued": "example"
          },
          "locations": [],
          "manager": {},
          "name": "example",
          "outOfOffice": {
            "active": false,
            "endDate": "example",
            "id": "example",
            "indefinite": false,
            "name": "example",
            "selfUri": "example",
            "startDate": "example",
            "user": {}
          },
          "preferredName": "example",
          "presence": {
            "futurePresenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "id": "example",
            "message": "example",
            "modifiedDate": "example",
            "name": "example",
            "presenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "primary": false,
            "selfUri": "example",
            "source": "example",
            "sourceId": "example"
          },
          "primaryContactInfo": [],
          "profileSkills": [],
          "routingStatus": {
            "startTime": "example",
            "status": "OFF_QUEUE",
            "userId": "example"
          },
          "selfUri": "example",
          "skills": [],
          "state": "active",
          "station": {
            "associatedStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "defaultStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "effectiveStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "lastAssociatedStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            }
          },
          "team": {
            "dateCreated": "example",
            "dateModified": "example",
            "description": "example",
            "division": {
              "id": "example",
              "name": "example",
              "selfUri": "example"
            },
            "id": "example",
            "memberCount": 1,
            "name": "example",
            "selfUri": "example"
          },
          "title": "example",
          "username": "example",
          "version": 1,
          "workPlanBidRanks": {
            "biddingTieBreaker": "example",
            "id": "example",
            "selfUri": "example",
            "workPlanBiddingPerformance": 1
          }
        },
        "name": "example",
        "organization": {
          "defaultCountryCode": "example",
          "defaultLanguage": "example",
          "defaultSiteId": "example",
          "domain": "example",
          "features": {},
          "id": "example",
          "name": "example",
          "productPlatform": "GenesysCloud",
          "selfUri": "example",
          "state": "active",
          "supportURI": "example",
          "thirdPartyOrgName": "example",
          "thirdPartyURI": "example",
          "version": 1,
          "voicemailEnabled": false
        },
        "outOfOffice": {
          "active": false,
          "endDate": "example",
          "id": "example",
          "indefinite": false,
          "name": "example",
          "selfUri": "example",
          "startDate": "example",
          "user": {
            "acdAutoAnswer": false,
            "addresses": [],
            "authorization": {
              "permissionPolicies": [],
              "permissions": [],
              "roles": [],
              "unusedRoles": []
            },
            "biography": {
              "biography": "example",
              "education": [],
              "hobbies": [],
              "interests": [],
              "spouse": "example"
            },
            "certifications": [],
            "chat": {
              "jabberId": "example"
            },
            "conversationSummary": {
              "call": {},
              "callback": {},
              "chat": {},
              "email": {},
              "message": {},
              "socialExpression": {},
              "userId": "example",
              "video": {}
            },
            "dateLastLogin": "example",
            "dateWelcomeSent": "example",
            "department": "example",
            "division": {
              "id": "example",
              "name": "example",
              "selfUri": "example"
            },
            "email": "example",
            "employerInfo": {
              "dateHire": "example",
              "employeeId": "example",
              "employeeType": "example",
              "officialName": "example"
            },
            "geolocation": {
              "city": "example",
              "country": "example",
              "id": "example",
              "latitude": 1.0,
              "locations": [],
              "longitude": 1.0,
              "name": "example",
              "primary": false,
              "region": "example",
              "selfUri": "example",
              "type": "example"
            },
            "groups": [],
            "id": "example",
            "images": [],
            "integrationPresence": {
              "futurePresenceDefinition": {},
              "id": "example",
              "message": "example",
              "modifiedDate": "example",
              "name": "example",
              "presenceDefinition": {},
              "primary": false,
              "selfUri": "example",
              "source": "example",
              "sourceId": "example"
            },
            "languagePreference": "example",
            "languages": [],
            "lastTokenIssued": {
              "dateIssued": "example"
            },
            "locations": [],
            "manager": {},
            "name": "example",
            "outOfOffice": {},
            "preferredName": "example",
            "presence": {
              "futurePresenceDefinition": {},
              "id": "example",
              "message": "example",
              "modifiedDate": "example",
              "name": "example",
              "presenceDefinition": {},
              "primary": false,
              "selfUri": "example",
              "source": "example",
              "sourceId": "example"
            },
            "primaryContactInfo": [],
            "profileSkills": [],
            "routingStatus": {
              "startTime": "example",
              "status": "OFF_QUEUE",
              "userId": "example"
            },
            "selfUri": "example",
            "skills": [],
            "state": "active",
            "station": {
              "associatedStation": {},
              "defaultStation": {},
              "effectiveStation": {},
              "lastAssociatedStation": {}
            },
            "team": {
              "dateCreated": "example",
              "dateModified": "example",
              "description": "example",
              "division": {},
              "id": "example",
              "memberCount": 1,
              "name": "example",
              "selfUri": "example"
            },
            "title": "example",
            "username": "example",
            "version": 1,
            "workPlanBidRanks": {
              "biddingTieBreaker": "example",
              "id": "example",
              "selfUri": "example",
              "workPlanBiddingPerformance": 1
            }
          }
        },
        "preferredName": "example",
        "presence": {
          "futurePresenceDefinition": {
            "id": "example",
            "selfUri": "example",
            "systemPresence": "example"
          },
          "id": "example",
          "message": "example",
          "modifiedDate": "example",
          "name": "example",
          "presenceDefinition": {
            "id": "example",
            "selfUri": "example",
            "systemPresence": "example"
          },
          "primary": false,
          "selfUri": "example",
          "source": "example",
          "sourceId": "example"
        },
        "primaryContactInfo": [],
        "profileSkills": [],
        "routingStatus": {
          "startTime": "example",
          "status": "OFF_QUEUE",
          "userId": "example"
        },
        "skills": [],
        "state": "active",
        "station": {
          "associatedStation": {
            "associatedDate": "example",
            "associatedUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "defaultUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "id": "example",
            "name": "example",
            "providerInfo": {},
            "type": "example",
            "webRtcCallAppearances": 1
          },
          "defaultStation": {
            "associatedDate": "example",
            "associatedUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "defaultUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "id": "example",
            "name": "example",
            "providerInfo": {},
            "type": "example",
            "webRtcCallAppearances": 1
          },
          "effectiveStation": {
            "associatedDate": "example",
            "associatedUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "defaultUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "id": "example",
            "name": "example",
            "providerInfo": {},
            "type": "example",
            "webRtcCallAppearances": 1
          },
          "lastAssociatedStation": {
            "associatedDate": "example",
            "associatedUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "defaultUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "id": "example",
            "name": "example",
            "providerInfo": {},
            "type": "example",
            "webRtcCallAppearances": 1
          }
        },
        "team": {
          "dateCreated": "example",
          "dateModified": "example",
          "description": "example",
          "division": {
            "id": "example",
            "name": "example",
            "selfUri": "example"
          },
          "id": "example",
          "memberCount": 1,
          "name": "example",
          "selfUri": "example"
        },
        "title": "example",
        "username": "example",
        "version": 1,
        "workPlanBidRanks": {
          "biddingTieBreaker": "example",
          "id": "example",
          "selfUri": "example",
          "workPlanBiddingPerformance": 1
        }
      },
      "dateCreated": "example",
      "enabled": false,
      "id": "example",
      "organization": {
        "defaultCountryCode": "example",
        "defaultLanguage": "example",
        "defaultSiteId": "example",
        "domain": "example",
        "features": {},
        "id": "example",
        "name": "example",
        "productPlatform": "GenesysCloud",
        "selfUri": "example",
        "state": "active",
        "supportURI": "example",
        "thirdPartyOrgName": "example",
        "thirdPartyURI": "example",
        "version": 1,
        "voicemailEnabled": false
      },
      "selfUri": "example"
    },
    "twitterId": {
      "id": "example",
      "name": "example",
      "profileUrl": "example",
      "screenName": "example",
      "verified": false
    },
    "websites": []
  }
}

Delete contact

Delete contact in Genesys Cloud.

Inputs

Contactcontact_idtextRequired
ExternalContact ID

Outputs

dataobject
Genesys Cloud response data.
Example output
{
  "data": {}
}

Delete external organization

Delete external organization in Genesys Cloud.

Inputs

External organizationexternal_organization_idtextRequired
External Organization ID

Outputs

dataobject
Genesys Cloud response data.
Example output
{
  "data": {}
}

Get contact

Get contact in Genesys Cloud.

Inputs

Contactcontact_idtextRequired
ExternalContact ID

Outputs

dataobject
Genesys Cloud response data.
Example output
{
  "data": {
    "address": {
      "address1": "example",
      "address2": "example",
      "city": "example",
      "countryCode": "example",
      "postalCode": "example",
      "state": "example"
    },
    "appleOpaqueIds": [],
    "canonicalContact": {
      "id": "example",
      "selfUri": "example"
    },
    "cellPhone": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "createDate": "example",
    "customFields": {},
    "division": {
      "id": "example",
      "name": "example",
      "selfUri": "example"
    },
    "externalDataSources": [],
    "externalIds": [],
    "externalOrganization": {
      "address": {
        "address1": "example",
        "address2": "example",
        "city": "example",
        "countryCode": "example",
        "postalCode": "example",
        "state": "example"
      },
      "companyType": "example",
      "createDate": "example",
      "customFields": {},
      "division": {
        "id": "example",
        "name": "example",
        "selfUri": "example"
      },
      "employeeCount": 1,
      "externalDataSources": [],
      "externalIds": [],
      "externalSystemUrl": "example",
      "faxNumber": {
        "acceptsSMS": false,
        "countryCode": "example",
        "display": "example",
        "e164": "example",
        "extension": 1,
        "normalizationCountryCode": "example",
        "userInput": "example"
      },
      "id": "example",
      "identifiers": [],
      "industry": "example",
      "modifyDate": "example",
      "name": "example",
      "phoneNumber": {
        "acceptsSMS": false,
        "countryCode": "example",
        "display": "example",
        "e164": "example",
        "extension": 1,
        "normalizationCountryCode": "example",
        "userInput": "example"
      },
      "revenue": 1,
      "schema": {
        "appliesTo": [],
        "createdBy": {
          "id": "example",
          "name": "example",
          "selfUri": "example"
        },
        "dateCreated": "example",
        "enabled": false,
        "id": "example",
        "jsonSchema": {
          "$schema": "example",
          "additionalProperties": {},
          "description": "example",
          "id": "example",
          "properties": {},
          "required": [],
          "title": "example",
          "type": "example"
        },
        "name": "example",
        "selfUri": "example",
        "version": 1
      },
      "selfUri": "example",
      "tags": [],
      "tickers": [],
      "trustor": {
        "authorization": {
          "permissions": []
        },
        "createdBy": {
          "acdAutoAnswer": false,
          "addresses": [],
          "authorization": {
            "permissionPolicies": [],
            "permissions": [],
            "roles": [],
            "unusedRoles": []
          },
          "biography": {
            "biography": "example",
            "education": [],
            "hobbies": [],
            "interests": [],
            "spouse": "example"
          },
          "certifications": [],
          "chat": {
            "jabberId": "example"
          },
          "conversationSummary": {
            "call": {
              "contactCenter": {},
              "enterprise": {}
            },
            "callback": {
              "contactCenter": {},
              "enterprise": {}
            },
            "chat": {
              "contactCenter": {},
              "enterprise": {}
            },
            "email": {
              "contactCenter": {},
              "enterprise": {}
            },
            "message": {
              "contactCenter": {},
              "enterprise": {}
            },
            "socialExpression": {
              "contactCenter": {},
              "enterprise": {}
            },
            "userId": "example",
            "video": {
              "contactCenter": {},
              "enterprise": {}
            }
          },
          "dateLastLogin": "example",
          "dateWelcomeSent": "example",
          "department": "example",
          "division": {
            "id": "example",
            "name": "example",
            "selfUri": "example"
          },
          "email": "example",
          "employerInfo": {
            "dateHire": "example",
            "employeeId": "example",
            "employeeType": "example",
            "officialName": "example"
          },
          "geolocation": {
            "city": "example",
            "country": "example",
            "id": "example",
            "latitude": 1.0,
            "locations": [],
            "longitude": 1.0,
            "name": "example",
            "primary": false,
            "region": "example",
            "selfUri": "example",
            "type": "example"
          },
          "groups": [],
          "id": "example",
          "images": [],
          "integrationPresence": {
            "futurePresenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "id": "example",
            "message": "example",
            "modifiedDate": "example",
            "name": "example",
            "presenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "primary": false,
            "selfUri": "example",
            "source": "example",
            "sourceId": "example"
          },
          "languagePreference": "example",
          "languages": [],
          "lastTokenIssued": {
            "dateIssued": "example"
          },
          "locations": [],
          "manager": {
            "acdAutoAnswer": false,
            "addresses": [],
            "authorization": {
              "permissionPolicies": [],
              "permissions": [],
              "roles": [],
              "unusedRoles": []
            },
            "biography": {
              "biography": "example",
              "education": [],
              "hobbies": [],
              "interests": [],
              "spouse": "example"
            },
            "certifications": [],
            "chat": {
              "jabberId": "example"
            },
            "conversationSummary": {
              "call": {},
              "callback": {},
              "chat": {},
              "email": {},
              "message": {},
              "socialExpression": {},
              "userId": "example",
              "video": {}
            },
            "dateLastLogin": "example",
            "dateWelcomeSent": "example",
            "department": "example",
            "division": {
              "id": "example",
              "name": "example",
              "selfUri": "example"
            },
            "email": "example",
            "employerInfo": {
              "dateHire": "example",
              "employeeId": "example",
              "employeeType": "example",
              "officialName": "example"
            },
            "geolocation": {
              "city": "example",
              "country": "example",
              "id": "example",
              "latitude": 1.0,
              "locations": [],
              "longitude": 1.0,
              "name": "example",
              "primary": false,
              "region": "example",
              "selfUri": "example",
              "type": "example"
            },
            "groups": [],
            "id": "example",
            "images": [],
            "integrationPresence": {
              "futurePresenceDefinition": {},
              "id": "example",
              "message": "example",
              "modifiedDate": "example",
              "name": "example",
              "presenceDefinition": {},
              "primary": false,
              "selfUri": "example",
              "source": "example",
              "sourceId": "example"
            },
            "languagePreference": "example",
            "languages": [],
            "lastTokenIssued": {
              "dateIssued": "example"
            },
            "locations": [],
            "manager": {},
            "name": "example",
            "outOfOffice": {
              "active": false,
              "endDate": "example",
              "id": "example",
              "indefinite": false,
              "name": "example",
              "selfUri": "example",
              "startDate": "example",
              "user": {}
            },
            "preferredName": "example",
            "presence": {
              "futurePresenceDefinition": {},
              "id": "example",
              "message": "example",
              "modifiedDate": "example",
              "name": "example",
              "presenceDefinition": {},
              "primary": false,
              "selfUri": "example",
              "source": "example",
              "sourceId": "example"
            },
            "primaryContactInfo": [],
            "profileSkills": [],
            "routingStatus": {
              "startTime": "example",
              "status": "OFF_QUEUE",
              "userId": "example"
            },
            "selfUri": "example",
            "skills": [],
            "state": "active",
            "station": {
              "associatedStation": {},
              "defaultStation": {},
              "effectiveStation": {},
              "lastAssociatedStation": {}
            },
            "team": {
              "dateCreated": "example",
              "dateModified": "example",
              "description": "example",
              "division": {},
              "id": "example",
              "memberCount": 1,
              "name": "example",
              "selfUri": "example"
            },
            "title": "example",
            "username": "example",
            "version": 1,
            "workPlanBidRanks": {
              "biddingTieBreaker": "example",
              "id": "example",
              "selfUri": "example",
              "workPlanBiddingPerformance": 1
            }
          },
          "name": "example",
          "organization": {
            "defaultCountryCode": "example",
            "defaultLanguage": "example",
            "defaultSiteId": "example",
            "domain": "example",
            "features": {},
            "id": "example",
            "name": "example",
            "productPlatform": "GenesysCloud",
            "selfUri": "example",
            "state": "active",
            "supportURI": "example",
            "thirdPartyOrgName": "example",
            "thirdPartyURI": "example",
            "version": 1,
            "voicemailEnabled": false
          },
          "outOfOffice": {
            "active": false,
            "endDate": "example",
            "id": "example",
            "indefinite": false,
            "name": "example",
            "selfUri": "example",
            "startDate": "example",
            "user": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            }
          },
          "preferredName": "example",
          "presence": {
            "futurePresenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "id": "example",
            "message": "example",
            "modifiedDate": "example",
            "name": "example",
            "presenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "primary": false,
            "selfUri": "example",
            "source": "example",
            "sourceId": "example"
          },
          "primaryContactInfo": [],
          "profileSkills": [],
          "routingStatus": {
            "startTime": "example",
            "status": "OFF_QUEUE",
            "userId": "example"
          },
          "skills": [],
          "state": "active",
          "station": {
            "associatedStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "defaultStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "effectiveStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "lastAssociatedStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            }
          },
          "team": {
            "dateCreated": "example",
            "dateModified": "example",
            "description": "example",
            "division": {
              "id": "example",
              "name": "example",
              "selfUri": "example"
            },
            "id": "example",
            "memberCount": 1,
            "name": "example",
            "selfUri": "example"
          },
          "title": "example",
          "username": "example",
          "version": 1,
          "workPlanBidRanks": {
            "biddingTieBreaker": "example",
            "id": "example",
            "selfUri": "example",
            "workPlanBiddingPerformance": 1
          }
        },
        "dateCreated": "example",
        "enabled": false,
        "id": "example",
        "organization": {
          "defaultCountryCode": "example",
          "defaultLanguage": "example",
          "defaultSiteId": "example",
          "domain": "example",
          "features": {},
          "id": "example",
          "name": "example",
          "productPlatform": "GenesysCloud",
          "selfUri": "example",
          "state": "active",
          "supportURI": "example",
          "thirdPartyOrgName": "example",
          "thirdPartyURI": "example",
          "version": 1,
          "voicemailEnabled": false
        },
        "selfUri": "example"
      },
      "twitterId": {
        "id": "example",
        "name": "example",
        "profileUrl": "example",
        "screenName": "example",
        "verified": false
      },
      "websites": []
    },
    "externalSystemUrl": "example",
    "facebookId": {
      "displayName": "example",
      "ids": []
    },
    "firstName": "example",
    "homePhone": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "id": "example",
    "identifiers": [],
    "instagramId": {
      "displayName": "example",
      "handle": "example",
      "ids": []
    },
    "lastName": "example",
    "lineId": {
      "displayName": "example",
      "ids": []
    },
    "mergeOperation": {
      "resultingContact": {
        "id": "example",
        "selfUri": "example"
      },
      "sourceContact": {
        "id": "example",
        "selfUri": "example"
      },
      "targetContact": {
        "id": "example",
        "selfUri": "example"
      }
    },
    "mergeSet": [],
    "mergedFrom": [],
    "mergedTo": {
      "id": "example",
      "selfUri": "example"
    },
    "middleName": "example",
    "modifyDate": "example",
    "otherEmail": "example",
    "otherPhone": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "personalEmail": "example",
    "salutation": "example",
    "schema": {
      "appliesTo": [],
      "createdBy": {
        "id": "example",
        "name": "example",
        "selfUri": "example"
      },
      "dateCreated": "example",
      "enabled": false,
      "id": "example",
      "jsonSchema": {
        "$schema": "example",
        "additionalProperties": {},
        "description": "example",
        "id": "example",
        "properties": {},
        "required": [],
        "title": "example",
        "type": "example"
      },
      "name": "example",
      "selfUri": "example",
      "version": 1
    },
    "selfUri": "example",
    "surveyOptOut": false,
    "title": "example",
    "twitterId": {
      "id": "example",
      "name": "example",
      "profileUrl": "example",
      "screenName": "example",
      "verified": false
    },
    "type": "Ephemeral",
    "whatsAppId": {
      "displayName": "example",
      "phoneNumber": {
        "acceptsSMS": false,
        "countryCode": "example",
        "display": "example",
        "e164": "example",
        "extension": 1,
        "normalizationCountryCode": "example",
        "userInput": "example"
      },
      "username": "example",
      "whatsAppBusinessScopedIds": []
    },
    "workEmail": "example",
    "workPhone": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    }
  }
}

Get division

Get division in Genesys Cloud.

Inputs

Divisiondivision_idtextRequired
Division ID

Outputs

dataobject
Genesys Cloud response data.
Example output
{
  "data": {
    "description": "example",
    "homeDivision": false,
    "id": "example",
    "name": "example",
    "objectCounts": {},
    "selfUri": "example"
  }
}

Get external organization

Get external organization in Genesys Cloud.

Inputs

External organizationexternal_organization_idtextRequired
External Organization ID

Outputs

dataobject
Genesys Cloud response data.
Example output
{
  "data": {
    "address": {
      "address1": "example",
      "address2": "example",
      "city": "example",
      "countryCode": "example",
      "postalCode": "example",
      "state": "example"
    },
    "companyType": "example",
    "createDate": "example",
    "customFields": {},
    "division": {
      "id": "example",
      "name": "example",
      "selfUri": "example"
    },
    "employeeCount": 1,
    "externalDataSources": [],
    "externalIds": [],
    "externalSystemUrl": "example",
    "faxNumber": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "id": "example",
    "identifiers": [],
    "industry": "example",
    "modifyDate": "example",
    "name": "example",
    "phoneNumber": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "revenue": 1,
    "schema": {
      "appliesTo": [],
      "createdBy": {
        "id": "example",
        "name": "example",
        "selfUri": "example"
      },
      "dateCreated": "example",
      "enabled": false,
      "id": "example",
      "jsonSchema": {
        "$schema": "example",
        "additionalProperties": {},
        "description": "example",
        "id": "example",
        "properties": {},
        "required": [],
        "title": "example",
        "type": "example"
      },
      "name": "example",
      "selfUri": "example",
      "version": 1
    },
    "selfUri": "example",
    "tags": [],
    "tickers": [],
    "trustor": {
      "authorization": {
        "permissions": []
      },
      "createdBy": {
        "acdAutoAnswer": false,
        "addresses": [],
        "authorization": {
          "permissionPolicies": [],
          "permissions": [],
          "roles": [],
          "unusedRoles": []
        },
        "biography": {
          "biography": "example",
          "education": [],
          "hobbies": [],
          "interests": [],
          "spouse": "example"
        },
        "certifications": [],
        "chat": {
          "jabberId": "example"
        },
        "conversationSummary": {
          "call": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "callback": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "chat": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "email": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "message": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "socialExpression": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "userId": "example",
          "video": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          }
        },
        "dateLastLogin": "example",
        "dateWelcomeSent": "example",
        "department": "example",
        "division": {
          "id": "example",
          "name": "example",
          "selfUri": "example"
        },
        "email": "example",
        "employerInfo": {
          "dateHire": "example",
          "employeeId": "example",
          "employeeType": "example",
          "officialName": "example"
        },
        "geolocation": {
          "city": "example",
          "country": "example",
          "id": "example",
          "latitude": 1.0,
          "locations": [],
          "longitude": 1.0,
          "name": "example",
          "primary": false,
          "region": "example",
          "selfUri": "example",
          "type": "example"
        },
        "groups": [],
        "id": "example",
        "images": [],
        "integrationPresence": {
          "futurePresenceDefinition": {
            "id": "example",
            "selfUri": "example",
            "systemPresence": "example"
          },
          "id": "example",
          "message": "example",
          "modifiedDate": "example",
          "name": "example",
          "presenceDefinition": {
            "id": "example",
            "selfUri": "example",
            "systemPresence": "example"
          },
          "primary": false,
          "selfUri": "example",
          "source": "example",
          "sourceId": "example"
        },
        "languagePreference": "example",
        "languages": [],
        "lastTokenIssued": {
          "dateIssued": "example"
        },
        "locations": [],
        "manager": {
          "acdAutoAnswer": false,
          "addresses": [],
          "authorization": {
            "permissionPolicies": [],
            "permissions": [],
            "roles": [],
            "unusedRoles": []
          },
          "biography": {
            "biography": "example",
            "education": [],
            "hobbies": [],
            "interests": [],
            "spouse": "example"
          },
          "certifications": [],
          "chat": {
            "jabberId": "example"
          },
          "conversationSummary": {
            "call": {
              "contactCenter": {},
              "enterprise": {}
            },
            "callback": {
              "contactCenter": {},
              "enterprise": {}
            },
            "chat": {
              "contactCenter": {},
              "enterprise": {}
            },
            "email": {
              "contactCenter": {},
              "enterprise": {}
            },
            "message": {
              "contactCenter": {},
              "enterprise": {}
            },
            "socialExpression": {
              "contactCenter": {},
              "enterprise": {}
            },
            "userId": "example",
            "video": {
              "contactCenter": {},
              "enterprise": {}
            }
          },
          "dateLastLogin": "example",
          "dateWelcomeSent": "example",
          "department": "example",
          "division": {
            "id": "example",
            "name": "example",
            "selfUri": "example"
          },
          "email": "example",
          "employerInfo": {
            "dateHire": "example",
            "employeeId": "example",
            "employeeType": "example",
            "officialName": "example"
          },
          "geolocation": {
            "city": "example",
            "country": "example",
            "id": "example",
            "latitude": 1.0,
            "locations": [],
            "longitude": 1.0,
            "name": "example",
            "primary": false,
            "region": "example",
            "selfUri": "example",
            "type": "example"
          },
          "groups": [],
          "id": "example",
          "images": [],
          "integrationPresence": {
            "futurePresenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "id": "example",
            "message": "example",
            "modifiedDate": "example",
            "name": "example",
            "presenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "primary": false,
            "selfUri": "example",
            "source": "example",
            "sourceId": "example"
          },
          "languagePreference": "example",
          "languages": [],
          "lastTokenIssued": {
            "dateIssued": "example"
          },
          "locations": [],
          "manager": {},
          "name": "example",
          "outOfOffice": {
            "active": false,
            "endDate": "example",
            "id": "example",
            "indefinite": false,
            "name": "example",
            "selfUri": "example",
            "startDate": "example",
            "user": {}
          },
          "preferredName": "example",
          "presence": {
            "futurePresenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "id": "example",
            "message": "example",
            "modifiedDate": "example",
            "name": "example",
            "presenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "primary": false,
            "selfUri": "example",
            "source": "example",
            "sourceId": "example"
          },
          "primaryContactInfo": [],
          "profileSkills": [],
          "routingStatus": {
            "startTime": "example",
            "status": "OFF_QUEUE",
            "userId": "example"
          },
          "selfUri": "example",
          "skills": [],
          "state": "active",
          "station": {
            "associatedStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "defaultStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "effectiveStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "lastAssociatedStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            }
          },
          "team": {
            "dateCreated": "example",
            "dateModified": "example",
            "description": "example",
            "division": {
              "id": "example",
              "name": "example",
              "selfUri": "example"
            },
            "id": "example",
            "memberCount": 1,
            "name": "example",
            "selfUri": "example"
          },
          "title": "example",
          "username": "example",
          "version": 1,
          "workPlanBidRanks": {
            "biddingTieBreaker": "example",
            "id": "example",
            "selfUri": "example",
            "workPlanBiddingPerformance": 1
          }
        },
        "name": "example",
        "organization": {
          "defaultCountryCode": "example",
          "defaultLanguage": "example",
          "defaultSiteId": "example",
          "domain": "example",
          "features": {},
          "id": "example",
          "name": "example",
          "productPlatform": "GenesysCloud",
          "selfUri": "example",
          "state": "active",
          "supportURI": "example",
          "thirdPartyOrgName": "example",
          "thirdPartyURI": "example",
          "version": 1,
          "voicemailEnabled": false
        },
        "outOfOffice": {
          "active": false,
          "endDate": "example",
          "id": "example",
          "indefinite": false,
          "name": "example",
          "selfUri": "example",
          "startDate": "example",
          "user": {
            "acdAutoAnswer": false,
            "addresses": [],
            "authorization": {
              "permissionPolicies": [],
              "permissions": [],
              "roles": [],
              "unusedRoles": []
            },
            "biography": {
              "biography": "example",
              "education": [],
              "hobbies": [],
              "interests": [],
              "spouse": "example"
            },
            "certifications": [],
            "chat": {
              "jabberId": "example"
            },
            "conversationSummary": {
              "call": {},
              "callback": {},
              "chat": {},
              "email": {},
              "message": {},
              "socialExpression": {},
              "userId": "example",
              "video": {}
            },
            "dateLastLogin": "example",
            "dateWelcomeSent": "example",
            "department": "example",
            "division": {
              "id": "example",
              "name": "example",
              "selfUri": "example"
            },
            "email": "example",
            "employerInfo": {
              "dateHire": "example",
              "employeeId": "example",
              "employeeType": "example",
              "officialName": "example"
            },
            "geolocation": {
              "city": "example",
              "country": "example",
              "id": "example",
              "latitude": 1.0,
              "locations": [],
              "longitude": 1.0,
              "name": "example",
              "primary": false,
              "region": "example",
              "selfUri": "example",
              "type": "example"
            },
            "groups": [],
            "id": "example",
            "images": [],
            "integrationPresence": {
              "futurePresenceDefinition": {},
              "id": "example",
              "message": "example",
              "modifiedDate": "example",
              "name": "example",
              "presenceDefinition": {},
              "primary": false,
              "selfUri": "example",
              "source": "example",
              "sourceId": "example"
            },
            "languagePreference": "example",
            "languages": [],
            "lastTokenIssued": {
              "dateIssued": "example"
            },
            "locations": [],
            "manager": {},
            "name": "example",
            "outOfOffice": {},
            "preferredName": "example",
            "presence": {
              "futurePresenceDefinition": {},
              "id": "example",
              "message": "example",
              "modifiedDate": "example",
              "name": "example",
              "presenceDefinition": {},
              "primary": false,
              "selfUri": "example",
              "source": "example",
              "sourceId": "example"
            },
            "primaryContactInfo": [],
            "profileSkills": [],
            "routingStatus": {
              "startTime": "example",
              "status": "OFF_QUEUE",
              "userId": "example"
            },
            "selfUri": "example",
            "skills": [],
            "state": "active",
            "station": {
              "associatedStation": {},
              "defaultStation": {},
              "effectiveStation": {},
              "lastAssociatedStation": {}
            },
            "team": {
              "dateCreated": "example",
              "dateModified": "example",
              "description": "example",
              "division": {},
              "id": "example",
              "memberCount": 1,
              "name": "example",
              "selfUri": "example"
            },
            "title": "example",
            "username": "example",
            "version": 1,
            "workPlanBidRanks": {
              "biddingTieBreaker": "example",
              "id": "example",
              "selfUri": "example",
              "workPlanBiddingPerformance": 1
            }
          }
        },
        "preferredName": "example",
        "presence": {
          "futurePresenceDefinition": {
            "id": "example",
            "selfUri": "example",
            "systemPresence": "example"
          },
          "id": "example",
          "message": "example",
          "modifiedDate": "example",
          "name": "example",
          "presenceDefinition": {
            "id": "example",
            "selfUri": "example",
            "systemPresence": "example"
          },
          "primary": false,
          "selfUri": "example",
          "source": "example",
          "sourceId": "example"
        },
        "primaryContactInfo": [],
        "profileSkills": [],
        "routingStatus": {
          "startTime": "example",
          "status": "OFF_QUEUE",
          "userId": "example"
        },
        "skills": [],
        "state": "active",
        "station": {
          "associatedStation": {
            "associatedDate": "example",
            "associatedUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "defaultUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "id": "example",
            "name": "example",
            "providerInfo": {},
            "type": "example",
            "webRtcCallAppearances": 1
          },
          "defaultStation": {
            "associatedDate": "example",
            "associatedUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "defaultUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "id": "example",
            "name": "example",
            "providerInfo": {},
            "type": "example",
            "webRtcCallAppearances": 1
          },
          "effectiveStation": {
            "associatedDate": "example",
            "associatedUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "defaultUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "id": "example",
            "name": "example",
            "providerInfo": {},
            "type": "example",
            "webRtcCallAppearances": 1
          },
          "lastAssociatedStation": {
            "associatedDate": "example",
            "associatedUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "defaultUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "id": "example",
            "name": "example",
            "providerInfo": {},
            "type": "example",
            "webRtcCallAppearances": 1
          }
        },
        "team": {
          "dateCreated": "example",
          "dateModified": "example",
          "description": "example",
          "division": {
            "id": "example",
            "name": "example",
            "selfUri": "example"
          },
          "id": "example",
          "memberCount": 1,
          "name": "example",
          "selfUri": "example"
        },
        "title": "example",
        "username": "example",
        "version": 1,
        "workPlanBidRanks": {
          "biddingTieBreaker": "example",
          "id": "example",
          "selfUri": "example",
          "workPlanBiddingPerformance": 1
        }
      },
      "dateCreated": "example",
      "enabled": false,
      "id": "example",
      "organization": {
        "defaultCountryCode": "example",
        "defaultLanguage": "example",
        "defaultSiteId": "example",
        "domain": "example",
        "features": {},
        "id": "example",
        "name": "example",
        "productPlatform": "GenesysCloud",
        "selfUri": "example",
        "state": "active",
        "supportURI": "example",
        "thirdPartyOrgName": "example",
        "thirdPartyURI": "example",
        "version": 1,
        "voicemailEnabled": false
      },
      "selfUri": "example"
    },
    "twitterId": {
      "id": "example",
      "name": "example",
      "profileUrl": "example",
      "screenName": "example",
      "verified": false
    },
    "websites": []
  }
}

Get group

Get group in Genesys Cloud.

Inputs

Groupgroup_idtextRequired
Group ID

Outputs

dataobject
Genesys Cloud response data.
Example output
{
  "data": {
    "addresses": [],
    "callsEnabled": false,
    "dateModified": "example",
    "description": "example",
    "email": "example",
    "id": "example",
    "images": [],
    "includeOwners": false,
    "memberCount": 1,
    "name": "example",
    "owners": [],
    "rolesEnabled": false,
    "rulesVisible": false,
    "selfUri": "example",
    "state": "active",
    "type": "official",
    "version": 1,
    "visibility": "public"
  }
}

Get organization

Get organization in Genesys Cloud.

Inputs

None.

Outputs

dataobject
Genesys Cloud response data.
Example output
{
  "data": {
    "defaultCountryCode": "example",
    "defaultLanguage": "example",
    "defaultSiteId": "example",
    "domain": "example",
    "features": {},
    "id": "example",
    "name": "example",
    "productPlatform": "GenesysCloud",
    "selfUri": "example",
    "state": "active",
    "supportURI": "example",
    "thirdPartyOrgName": "example",
    "thirdPartyURI": "example",
    "version": 1,
    "voicemailEnabled": false
  }
}

Get queue

Get queue in Genesys Cloud.

Inputs

Queuequeue_idtextRequired
Queue ID

Outputs

dataobject
Genesys Cloud response data.
Example output
{
  "data": {
    "acwSettings": {
      "timeoutMs": 1,
      "wrapupPrompt": "MANDATORY"
    },
    "agentOwnedRouting": {
      "enableAgentOwnedCallbacks": false,
      "maxOwnedCallbackDelayHours": 1,
      "maxOwnedCallbackHours": 1
    },
    "autoAnswerOnly": false,
    "bullseye": {
      "rings": []
    },
    "callingPartyName": "example",
    "callingPartyNumber": "example",
    "cannedResponseLibraries": {
      "libraryIds": [],
      "mode": "All"
    },
    "conditionalGroupActivation": {
      "pilotRule": {
        "conditionExpression": "example",
        "conditions": []
      },
      "rules": []
    },
    "conditionalGroupRouting": {
      "rules": []
    },
    "createdBy": "example",
    "dateCreated": "example",
    "dateModified": "example",
    "defaultMediaLanguage": "example",
    "defaultScripts": {},
    "description": "example",
    "directRouting": {
      "agentWaitSeconds": 1,
      "backupQueueId": "example",
      "callMediaSettings": {
        "useAgentAddressOutbound": false
      },
      "emailMediaSettings": {
        "useAgentAddressOutbound": false
      },
      "messageMediaSettings": {
        "useAgentAddressOutbound": false
      },
      "waitForAgent": false
    },
    "division": {
      "id": "example",
      "name": "example",
      "selfUri": "example"
    },
    "emailInQueueFlow": {
      "id": "example",
      "name": "example",
      "selfUri": "example"
    },
    "enableAudioMonitoring": false,
    "enableManualAssignment": false,
    "enableTranscription": false,
    "id": "example",
    "joinedMemberCount": 1,
    "lastAgentRoutingMode": "Disabled",
    "mediaSettings": {
      "call": {
        "alertingTimeoutSeconds": 1,
        "autoAnswerAlertToneSeconds": 1.0,
        "enableAutoAnswer": false,
        "manualAnswerAlertToneSeconds": 1.0,
        "serviceLevel": {
          "durationMs": 1,
          "percentage": 1.0
        }
      },
      "callback": {
        "alertingTimeoutSeconds": 1,
        "answeringMachineFlow": {
          "id": "example",
          "name": "example",
          "selfUri": "example"
        },
        "answeringMachineReactionType": "HangUp",
        "autoAnswerAlertToneSeconds": 1.0,
        "autoDialDelaySeconds": 1,
        "autoEndDelaySeconds": 1,
        "edgeGroup": {
          "id": "example",
          "name": "example",
          "selfUri": "example"
        },
        "enableAutoAnswer": false,
        "enableAutoDialAndEnd": false,
        "liveVoiceFlow": {
          "id": "example",
          "name": "example",
          "selfUri": "example"
        },
        "liveVoiceReactionType": "HangUp",
        "manualAnswerAlertToneSeconds": 1.0,
        "maxRetryCount": 1,
        "mode": "AgentFirst",
        "pacingModifier": 1.0,
        "retryDelaySeconds": 1,
        "serviceLevel": {
          "durationMs": 1,
          "percentage": 1.0
        },
        "site": {
          "id": "example",
          "name": "example",
          "selfUri": "example"
        }
      },
      "chat": {
        "alertingTimeoutSeconds": 1,
        "autoAnswerAlertToneSeconds": 1.0,
        "enableAutoAnswer": false,
        "manualAnswerAlertToneSeconds": 1.0,
        "serviceLevel": {
          "durationMs": 1,
          "percentage": 1.0
        }
      },
      "email": {
        "alertingTimeoutSeconds": 1,
        "allOutboundEmailAddresses": [],
        "autoAnswerAlertToneSeconds": 1.0,
        "enableAutoAnswer": false,
        "manualAnswerAlertToneSeconds": 1.0,
        "serviceLevel": {
          "durationMs": 1,
          "percentage": 1.0
        }
      },
      "message": {
        "alertingTimeoutSeconds": 1,
        "autoAnswerAlertToneSeconds": 1.0,
        "enableAutoAnswer": false,
        "enableInactivityTimeout": false,
        "inactivityTimeoutSettings": {
          "actionType": "DISCONNECT",
          "flowId": {
            "id": "example",
            "name": "example",
            "selfUri": "example"
          },
          "timeoutSeconds": 1
        },
        "manualAnswerAlertToneSeconds": 1.0,
        "serviceLevel": {
          "durationMs": 1,
          "percentage": 1.0
        },
        "subTypeSettings": {}
      }
    },
    "memberCount": 1,
    "memberGroups": [],
    "messageInQueueFlow": {
      "id": "example",
      "name": "example",
      "selfUri": "example"
    },
    "modifiedBy": "example",
    "name": "example",
    "onHoldPrompt": {
      "id": "example",
      "name": "example",
      "selfUri": "example"
    },
    "outboundEmailAddress": {
      "domain": {
        "id": "example",
        "name": "example",
        "selfUri": "example"
      },
      "route": {
        "allowMultipleActions": false,
        "autoBcc": [],
        "flow": {
          "id": "example",
          "name": "example",
          "selfUri": "example"
        },
        "fromEmail": "example",
        "fromName": "example",
        "historyInclusion": "Include",
        "id": "example",
        "language": {
          "id": "example",
          "name": "example",
          "selfUri": "example"
        },
        "mailboxFolders": [],
        "name": "example",
        "pattern": "example",
        "priority": 1,
        "queue": {
          "id": "example",
          "name": "example",
          "selfUri": "example"
        },
        "replyEmailAddress": {},
        "selfUri": "example",
        "signature": {
          "alwaysIncluded": false,
          "cannedResponseId": "example",
          "enabled": false,
          "inclusionType": "Draft"
        },
        "skills": [],
        "spamFlow": {
          "id": "example",
          "name": "example",
          "selfUri": "example"
        },
        "status": "Pending"
      }
    },
    "outboundMessagingAddresses": {
      "openMessagingRecipient": {
        "id": "example",
        "name": "example",
        "selfUri": "example"
      },
      "smsAddress": {
        "id": "example",
        "name": "example",
        "selfUri": "example"
      },
      "whatsAppRecipient": {
        "id": "example",
        "name": "example",
        "selfUri": "example"
      }
    },
    "peerId": "example",
    "queueFlow": {
      "id": "example",
      "name": "example",
      "selfUri": "example"
    },
    "routingRules": [],
    "scoringMethod": "TimestampAndPriority",
    "selfUri": "example",
    "skillEvaluationMethod": "NONE",
    "suppressInQueueCallRecording": false,
    "userMemberCount": 1,
    "whisperPrompt": {
      "id": "example",
      "name": "example",
      "selfUri": "example"
    }
  }
}

Get user

Get user in Genesys Cloud.

Inputs

Employeeemployee_idtextRequired
User ID

Outputs

dataobject
Genesys Cloud response data.
Example output
{
  "data": {
    "acdAutoAnswer": false,
    "addresses": [],
    "authorization": {
      "permissionPolicies": [],
      "permissions": [],
      "roles": [],
      "unusedRoles": []
    },
    "biography": {
      "biography": "example",
      "education": [],
      "hobbies": [],
      "interests": [],
      "spouse": "example"
    },
    "certifications": [],
    "chat": {
      "jabberId": "example"
    },
    "conversationSummary": {
      "call": {
        "contactCenter": {
          "active": 1,
          "acw": 1
        },
        "enterprise": {
          "active": 1,
          "acw": 1
        }
      },
      "callback": {
        "contactCenter": {
          "active": 1,
          "acw": 1
        },
        "enterprise": {
          "active": 1,
          "acw": 1
        }
      },
      "chat": {
        "contactCenter": {
          "active": 1,
          "acw": 1
        },
        "enterprise": {
          "active": 1,
          "acw": 1
        }
      },
      "email": {
        "contactCenter": {
          "active": 1,
          "acw": 1
        },
        "enterprise": {
          "active": 1,
          "acw": 1
        }
      },
      "message": {
        "contactCenter": {
          "active": 1,
          "acw": 1
        },
        "enterprise": {
          "active": 1,
          "acw": 1
        }
      },
      "socialExpression": {
        "contactCenter": {
          "active": 1,
          "acw": 1
        },
        "enterprise": {
          "active": 1,
          "acw": 1
        }
      },
      "userId": "example",
      "video": {
        "contactCenter": {
          "active": 1,
          "acw": 1
        },
        "enterprise": {
          "active": 1,
          "acw": 1
        }
      }
    },
    "dateLastLogin": "example",
    "dateWelcomeSent": "example",
    "department": "example",
    "division": {
      "id": "example",
      "name": "example",
      "selfUri": "example"
    },
    "email": "example",
    "employerInfo": {
      "dateHire": "example",
      "employeeId": "example",
      "employeeType": "example",
      "officialName": "example"
    },
    "geolocation": {
      "city": "example",
      "country": "example",
      "id": "example",
      "latitude": 1.0,
      "locations": [],
      "longitude": 1.0,
      "name": "example",
      "primary": false,
      "region": "example",
      "selfUri": "example",
      "type": "example"
    },
    "groups": [],
    "id": "example",
    "images": [],
    "integrationPresence": {
      "futurePresenceDefinition": {
        "id": "example",
        "selfUri": "example",
        "systemPresence": "example"
      },
      "id": "example",
      "message": "example",
      "modifiedDate": "example",
      "name": "example",
      "presenceDefinition": {
        "id": "example",
        "selfUri": "example",
        "systemPresence": "example"
      },
      "primary": false,
      "selfUri": "example",
      "source": "example",
      "sourceId": "example"
    },
    "languagePreference": "example",
    "languages": [],
    "lastTokenIssued": {
      "dateIssued": "example"
    },
    "locations": [],
    "manager": {},
    "name": "example",
    "outOfOffice": {
      "active": false,
      "endDate": "example",
      "id": "example",
      "indefinite": false,
      "name": "example",
      "selfUri": "example",
      "startDate": "example",
      "user": {}
    },
    "preferredName": "example",
    "presence": {
      "futurePresenceDefinition": {
        "id": "example",
        "selfUri": "example",
        "systemPresence": "example"
      },
      "id": "example",
      "message": "example",
      "modifiedDate": "example",
      "name": "example",
      "presenceDefinition": {
        "id": "example",
        "selfUri": "example",
        "systemPresence": "example"
      },
      "primary": false,
      "selfUri": "example",
      "source": "example",
      "sourceId": "example"
    },
    "primaryContactInfo": [],
    "profileSkills": [],
    "routingStatus": {
      "startTime": "example",
      "status": "OFF_QUEUE",
      "userId": "example"
    },
    "selfUri": "example",
    "skills": [],
    "state": "active",
    "station": {
      "associatedStation": {
        "associatedDate": "example",
        "associatedUser": {},
        "defaultUser": {},
        "id": "example",
        "name": "example",
        "providerInfo": {},
        "type": "example",
        "webRtcCallAppearances": 1
      },
      "defaultStation": {
        "associatedDate": "example",
        "associatedUser": {},
        "defaultUser": {},
        "id": "example",
        "name": "example",
        "providerInfo": {},
        "type": "example",
        "webRtcCallAppearances": 1
      },
      "effectiveStation": {
        "associatedDate": "example",
        "associatedUser": {},
        "defaultUser": {},
        "id": "example",
        "name": "example",
        "providerInfo": {},
        "type": "example",
        "webRtcCallAppearances": 1
      },
      "lastAssociatedStation": {
        "associatedDate": "example",
        "associatedUser": {},
        "defaultUser": {},
        "id": "example",
        "name": "example",
        "providerInfo": {},
        "type": "example",
        "webRtcCallAppearances": 1
      }
    },
    "team": {
      "dateCreated": "example",
      "dateModified": "example",
      "description": "example",
      "division": {
        "id": "example",
        "name": "example",
        "selfUri": "example"
      },
      "id": "example",
      "memberCount": 1,
      "name": "example",
      "selfUri": "example"
    },
    "title": "example",
    "username": "example",
    "version": 1,
    "workPlanBidRanks": {
      "biddingTieBreaker": "example",
      "id": "example",
      "selfUri": "example",
      "workPlanBiddingPerformance": 1
    }
  }
}

List contacts

List contacts in Genesys Cloud.

Inputs

Page sizepage_sizenumber
Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)Default: 20.
Page numberpage_numbernumber
Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)Default: 1.
Qqtext
User supplied search keywords (no special syntax is currently supported)
Sort ordersort_ordertext
The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. "firstName:asc", "title:desc"

Outputs

dataobject
Genesys Cloud response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "entities": [],
    "firstUri": "example",
    "lastUri": "example",
    "nextUri": "example",
    "pageCount": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "partialResults": false,
    "previousUri": "example",
    "selfUri": "example",
    "total": 1
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List divisions

List divisions in Genesys Cloud.

Inputs

Page sizepage_sizenumber
The total page size requestedDefault: 25.
Page numberpage_numbernumber
The page number requestedDefault: 1.
Namenametext
Search term to filter by division name

Outputs

dataobject
Genesys Cloud response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "entities": [],
    "firstUri": "example",
    "lastUri": "example",
    "nextUri": "example",
    "pageCount": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "previousUri": "example",
    "selfUri": "example",
    "total": 1
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List groups

List groups in Genesys Cloud.

Inputs

Page sizepage_sizenumber
Page sizeDefault: 25.
Page numberpage_numbernumber
Page numberDefault: 1.
Sort ordersort_ordertext
Ascending or descending sort orderOne of: ascending, descending. Default: ascending.

Outputs

dataobject
Genesys Cloud response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "entities": [],
    "firstUri": "example",
    "lastUri": "example",
    "nextUri": "example",
    "pageCount": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "previousUri": "example",
    "selfUri": "example",
    "total": 1
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List organizations

List organizations in Genesys Cloud.

Inputs

Page sizepage_sizenumber
Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)Default: 20.
Page numberpage_numbernumber
Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000)Default: 1.
Qqtext
Search query
Sort ordersort_ordertext
The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. "companyType:asc", "industry:desc"

Outputs

dataobject
Genesys Cloud response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "entities": [],
    "firstUri": "example",
    "lastUri": "example",
    "nextUri": "example",
    "pageCount": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "partialResults": false,
    "previousUri": "example",
    "selfUri": "example",
    "total": 1
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List presence definitions

List presence definitions in Genesys Cloud.

Inputs

Page numberpage_numbernumber
Page numberDefault: 1.
Page sizepage_sizenumber
Page sizeDefault: 25.

Outputs

dataobject
Genesys Cloud response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "entities": [],
    "firstUri": "example",
    "lastUri": "example",
    "nextUri": "example",
    "pageCount": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "previousUri": "example",
    "selfUri": "example",
    "total": 1
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List queues

List queues in Genesys Cloud.

Inputs

Page numberpage_numbernumber
Page numberDefault: 1.
Page sizepage_sizenumber
Page sizeDefault: 25.
Sort ordersort_ordertext
Note: results are sorted by name.One of: asc, desc. Default: asc.
Namenametext
Include only queues with the given name (leading and trailing asterisks allowed)

Outputs

dataobject
Genesys Cloud response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "entities": [],
    "firstUri": "example",
    "lastUri": "example",
    "nextUri": "example",
    "pageCount": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "previousUri": "example",
    "selfUri": "example",
    "total": 1
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

List users

List users in Genesys Cloud.

Inputs

Page sizepage_sizenumber
Page sizeDefault: 25.
Page numberpage_numbernumber
Page numberDefault: 1.
Sort ordersort_ordertext
Ascending or descending sort orderOne of: ascending, descending. Default: ascending.

Outputs

dataobject
Genesys Cloud response data.
has_moretrue/false
Whether another page is available.
next_cursortext
Pass this value to the next page input.
recordslist
The records on this page.
Example output
{
  "data": {
    "entities": [],
    "firstUri": "example",
    "lastUri": "example",
    "nextUri": "example",
    "pageCount": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "previousUri": "example",
    "selfUri": "example",
    "total": 1
  },
  "has_more": false,
  "next_cursor": null,
  "records": []
}

Update contact

Update contact in Genesys Cloud.

Inputs

Contactcontact_idtextRequired
ExternalContact ID
First namefirst_nametext
The first name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
Last namelast_nametext
The last name of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
Titletitletext
The title of the contact. Max: 1000 characters. Leading and trailing whitespace stripped.
Work phonework_phoneobject
Work phone.
Cell phonecell_phoneobject
Cell phone.
Work emailwork_emailtext
The work email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
Personal emailpersonal_emailtext
The personal email of the contact. Max: 256 characters. Leading and trailing whitespace stripped. Valid email format
Addressaddressobject
Address.
External organizationexternal_organizationobject
External organization.
External system urlexternal_system_urltext
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.
Schemaschemaobject
The schema defining custom fields for this contact
Custom fieldscustom_fieldsobject
Custom fields defined in the schema referenced by schemaId and schemaVersion.

Outputs

dataobject
Genesys Cloud response data.
Example output
{
  "data": {
    "address": {
      "address1": "example",
      "address2": "example",
      "city": "example",
      "countryCode": "example",
      "postalCode": "example",
      "state": "example"
    },
    "appleOpaqueIds": [],
    "canonicalContact": {
      "id": "example",
      "selfUri": "example"
    },
    "cellPhone": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "createDate": "example",
    "customFields": {},
    "division": {
      "id": "example",
      "name": "example",
      "selfUri": "example"
    },
    "externalDataSources": [],
    "externalIds": [],
    "externalOrganization": {
      "address": {
        "address1": "example",
        "address2": "example",
        "city": "example",
        "countryCode": "example",
        "postalCode": "example",
        "state": "example"
      },
      "companyType": "example",
      "createDate": "example",
      "customFields": {},
      "division": {
        "id": "example",
        "name": "example",
        "selfUri": "example"
      },
      "employeeCount": 1,
      "externalDataSources": [],
      "externalIds": [],
      "externalSystemUrl": "example",
      "faxNumber": {
        "acceptsSMS": false,
        "countryCode": "example",
        "display": "example",
        "e164": "example",
        "extension": 1,
        "normalizationCountryCode": "example",
        "userInput": "example"
      },
      "id": "example",
      "identifiers": [],
      "industry": "example",
      "modifyDate": "example",
      "name": "example",
      "phoneNumber": {
        "acceptsSMS": false,
        "countryCode": "example",
        "display": "example",
        "e164": "example",
        "extension": 1,
        "normalizationCountryCode": "example",
        "userInput": "example"
      },
      "revenue": 1,
      "schema": {
        "appliesTo": [],
        "createdBy": {
          "id": "example",
          "name": "example",
          "selfUri": "example"
        },
        "dateCreated": "example",
        "enabled": false,
        "id": "example",
        "jsonSchema": {
          "$schema": "example",
          "additionalProperties": {},
          "description": "example",
          "id": "example",
          "properties": {},
          "required": [],
          "title": "example",
          "type": "example"
        },
        "name": "example",
        "selfUri": "example",
        "version": 1
      },
      "selfUri": "example",
      "tags": [],
      "tickers": [],
      "trustor": {
        "authorization": {
          "permissions": []
        },
        "createdBy": {
          "acdAutoAnswer": false,
          "addresses": [],
          "authorization": {
            "permissionPolicies": [],
            "permissions": [],
            "roles": [],
            "unusedRoles": []
          },
          "biography": {
            "biography": "example",
            "education": [],
            "hobbies": [],
            "interests": [],
            "spouse": "example"
          },
          "certifications": [],
          "chat": {
            "jabberId": "example"
          },
          "conversationSummary": {
            "call": {
              "contactCenter": {},
              "enterprise": {}
            },
            "callback": {
              "contactCenter": {},
              "enterprise": {}
            },
            "chat": {
              "contactCenter": {},
              "enterprise": {}
            },
            "email": {
              "contactCenter": {},
              "enterprise": {}
            },
            "message": {
              "contactCenter": {},
              "enterprise": {}
            },
            "socialExpression": {
              "contactCenter": {},
              "enterprise": {}
            },
            "userId": "example",
            "video": {
              "contactCenter": {},
              "enterprise": {}
            }
          },
          "dateLastLogin": "example",
          "dateWelcomeSent": "example",
          "department": "example",
          "division": {
            "id": "example",
            "name": "example",
            "selfUri": "example"
          },
          "email": "example",
          "employerInfo": {
            "dateHire": "example",
            "employeeId": "example",
            "employeeType": "example",
            "officialName": "example"
          },
          "geolocation": {
            "city": "example",
            "country": "example",
            "id": "example",
            "latitude": 1.0,
            "locations": [],
            "longitude": 1.0,
            "name": "example",
            "primary": false,
            "region": "example",
            "selfUri": "example",
            "type": "example"
          },
          "groups": [],
          "id": "example",
          "images": [],
          "integrationPresence": {
            "futurePresenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "id": "example",
            "message": "example",
            "modifiedDate": "example",
            "name": "example",
            "presenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "primary": false,
            "selfUri": "example",
            "source": "example",
            "sourceId": "example"
          },
          "languagePreference": "example",
          "languages": [],
          "lastTokenIssued": {
            "dateIssued": "example"
          },
          "locations": [],
          "manager": {
            "acdAutoAnswer": false,
            "addresses": [],
            "authorization": {
              "permissionPolicies": [],
              "permissions": [],
              "roles": [],
              "unusedRoles": []
            },
            "biography": {
              "biography": "example",
              "education": [],
              "hobbies": [],
              "interests": [],
              "spouse": "example"
            },
            "certifications": [],
            "chat": {
              "jabberId": "example"
            },
            "conversationSummary": {
              "call": {},
              "callback": {},
              "chat": {},
              "email": {},
              "message": {},
              "socialExpression": {},
              "userId": "example",
              "video": {}
            },
            "dateLastLogin": "example",
            "dateWelcomeSent": "example",
            "department": "example",
            "division": {
              "id": "example",
              "name": "example",
              "selfUri": "example"
            },
            "email": "example",
            "employerInfo": {
              "dateHire": "example",
              "employeeId": "example",
              "employeeType": "example",
              "officialName": "example"
            },
            "geolocation": {
              "city": "example",
              "country": "example",
              "id": "example",
              "latitude": 1.0,
              "locations": [],
              "longitude": 1.0,
              "name": "example",
              "primary": false,
              "region": "example",
              "selfUri": "example",
              "type": "example"
            },
            "groups": [],
            "id": "example",
            "images": [],
            "integrationPresence": {
              "futurePresenceDefinition": {},
              "id": "example",
              "message": "example",
              "modifiedDate": "example",
              "name": "example",
              "presenceDefinition": {},
              "primary": false,
              "selfUri": "example",
              "source": "example",
              "sourceId": "example"
            },
            "languagePreference": "example",
            "languages": [],
            "lastTokenIssued": {
              "dateIssued": "example"
            },
            "locations": [],
            "manager": {},
            "name": "example",
            "outOfOffice": {
              "active": false,
              "endDate": "example",
              "id": "example",
              "indefinite": false,
              "name": "example",
              "selfUri": "example",
              "startDate": "example",
              "user": {}
            },
            "preferredName": "example",
            "presence": {
              "futurePresenceDefinition": {},
              "id": "example",
              "message": "example",
              "modifiedDate": "example",
              "name": "example",
              "presenceDefinition": {},
              "primary": false,
              "selfUri": "example",
              "source": "example",
              "sourceId": "example"
            },
            "primaryContactInfo": [],
            "profileSkills": [],
            "routingStatus": {
              "startTime": "example",
              "status": "OFF_QUEUE",
              "userId": "example"
            },
            "selfUri": "example",
            "skills": [],
            "state": "active",
            "station": {
              "associatedStation": {},
              "defaultStation": {},
              "effectiveStation": {},
              "lastAssociatedStation": {}
            },
            "team": {
              "dateCreated": "example",
              "dateModified": "example",
              "description": "example",
              "division": {},
              "id": "example",
              "memberCount": 1,
              "name": "example",
              "selfUri": "example"
            },
            "title": "example",
            "username": "example",
            "version": 1,
            "workPlanBidRanks": {
              "biddingTieBreaker": "example",
              "id": "example",
              "selfUri": "example",
              "workPlanBiddingPerformance": 1
            }
          },
          "name": "example",
          "organization": {
            "defaultCountryCode": "example",
            "defaultLanguage": "example",
            "defaultSiteId": "example",
            "domain": "example",
            "features": {},
            "id": "example",
            "name": "example",
            "productPlatform": "GenesysCloud",
            "selfUri": "example",
            "state": "active",
            "supportURI": "example",
            "thirdPartyOrgName": "example",
            "thirdPartyURI": "example",
            "version": 1,
            "voicemailEnabled": false
          },
          "outOfOffice": {
            "active": false,
            "endDate": "example",
            "id": "example",
            "indefinite": false,
            "name": "example",
            "selfUri": "example",
            "startDate": "example",
            "user": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            }
          },
          "preferredName": "example",
          "presence": {
            "futurePresenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "id": "example",
            "message": "example",
            "modifiedDate": "example",
            "name": "example",
            "presenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "primary": false,
            "selfUri": "example",
            "source": "example",
            "sourceId": "example"
          },
          "primaryContactInfo": [],
          "profileSkills": [],
          "routingStatus": {
            "startTime": "example",
            "status": "OFF_QUEUE",
            "userId": "example"
          },
          "skills": [],
          "state": "active",
          "station": {
            "associatedStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "defaultStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "effectiveStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "lastAssociatedStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            }
          },
          "team": {
            "dateCreated": "example",
            "dateModified": "example",
            "description": "example",
            "division": {
              "id": "example",
              "name": "example",
              "selfUri": "example"
            },
            "id": "example",
            "memberCount": 1,
            "name": "example",
            "selfUri": "example"
          },
          "title": "example",
          "username": "example",
          "version": 1,
          "workPlanBidRanks": {
            "biddingTieBreaker": "example",
            "id": "example",
            "selfUri": "example",
            "workPlanBiddingPerformance": 1
          }
        },
        "dateCreated": "example",
        "enabled": false,
        "id": "example",
        "organization": {
          "defaultCountryCode": "example",
          "defaultLanguage": "example",
          "defaultSiteId": "example",
          "domain": "example",
          "features": {},
          "id": "example",
          "name": "example",
          "productPlatform": "GenesysCloud",
          "selfUri": "example",
          "state": "active",
          "supportURI": "example",
          "thirdPartyOrgName": "example",
          "thirdPartyURI": "example",
          "version": 1,
          "voicemailEnabled": false
        },
        "selfUri": "example"
      },
      "twitterId": {
        "id": "example",
        "name": "example",
        "profileUrl": "example",
        "screenName": "example",
        "verified": false
      },
      "websites": []
    },
    "externalSystemUrl": "example",
    "facebookId": {
      "displayName": "example",
      "ids": []
    },
    "firstName": "example",
    "homePhone": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "id": "example",
    "identifiers": [],
    "instagramId": {
      "displayName": "example",
      "handle": "example",
      "ids": []
    },
    "lastName": "example",
    "lineId": {
      "displayName": "example",
      "ids": []
    },
    "mergeOperation": {
      "resultingContact": {
        "id": "example",
        "selfUri": "example"
      },
      "sourceContact": {
        "id": "example",
        "selfUri": "example"
      },
      "targetContact": {
        "id": "example",
        "selfUri": "example"
      }
    },
    "mergeSet": [],
    "mergedFrom": [],
    "mergedTo": {
      "id": "example",
      "selfUri": "example"
    },
    "middleName": "example",
    "modifyDate": "example",
    "otherEmail": "example",
    "otherPhone": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "personalEmail": "example",
    "salutation": "example",
    "schema": {
      "appliesTo": [],
      "createdBy": {
        "id": "example",
        "name": "example",
        "selfUri": "example"
      },
      "dateCreated": "example",
      "enabled": false,
      "id": "example",
      "jsonSchema": {
        "$schema": "example",
        "additionalProperties": {},
        "description": "example",
        "id": "example",
        "properties": {},
        "required": [],
        "title": "example",
        "type": "example"
      },
      "name": "example",
      "selfUri": "example",
      "version": 1
    },
    "selfUri": "example",
    "surveyOptOut": false,
    "title": "example",
    "twitterId": {
      "id": "example",
      "name": "example",
      "profileUrl": "example",
      "screenName": "example",
      "verified": false
    },
    "type": "Ephemeral",
    "whatsAppId": {
      "displayName": "example",
      "phoneNumber": {
        "acceptsSMS": false,
        "countryCode": "example",
        "display": "example",
        "e164": "example",
        "extension": 1,
        "normalizationCountryCode": "example",
        "userInput": "example"
      },
      "username": "example",
      "whatsAppBusinessScopedIds": []
    },
    "workEmail": "example",
    "workPhone": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    }
  }
}

Update external organization

Update external organization in Genesys Cloud.

Inputs

External organizationexternal_organization_idtextRequired
External Organization ID
Namenametext
The name of the company. Max: 1000 characters. Leading and trailing whitespace stripped.
Addressaddressobject
Address.
External system urlexternal_system_urltext
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.
Schemaschemaobject
The schema defining custom fields for this contact
Custom fieldscustom_fieldsobject
Custom fields defined in the schema referenced by schemaId and schemaVersion.

Outputs

dataobject
Genesys Cloud response data.
Example output
{
  "data": {
    "address": {
      "address1": "example",
      "address2": "example",
      "city": "example",
      "countryCode": "example",
      "postalCode": "example",
      "state": "example"
    },
    "companyType": "example",
    "createDate": "example",
    "customFields": {},
    "division": {
      "id": "example",
      "name": "example",
      "selfUri": "example"
    },
    "employeeCount": 1,
    "externalDataSources": [],
    "externalIds": [],
    "externalSystemUrl": "example",
    "faxNumber": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "id": "example",
    "identifiers": [],
    "industry": "example",
    "modifyDate": "example",
    "name": "example",
    "phoneNumber": {
      "acceptsSMS": false,
      "countryCode": "example",
      "display": "example",
      "e164": "example",
      "extension": 1,
      "normalizationCountryCode": "example",
      "userInput": "example"
    },
    "revenue": 1,
    "schema": {
      "appliesTo": [],
      "createdBy": {
        "id": "example",
        "name": "example",
        "selfUri": "example"
      },
      "dateCreated": "example",
      "enabled": false,
      "id": "example",
      "jsonSchema": {
        "$schema": "example",
        "additionalProperties": {},
        "description": "example",
        "id": "example",
        "properties": {},
        "required": [],
        "title": "example",
        "type": "example"
      },
      "name": "example",
      "selfUri": "example",
      "version": 1
    },
    "selfUri": "example",
    "tags": [],
    "tickers": [],
    "trustor": {
      "authorization": {
        "permissions": []
      },
      "createdBy": {
        "acdAutoAnswer": false,
        "addresses": [],
        "authorization": {
          "permissionPolicies": [],
          "permissions": [],
          "roles": [],
          "unusedRoles": []
        },
        "biography": {
          "biography": "example",
          "education": [],
          "hobbies": [],
          "interests": [],
          "spouse": "example"
        },
        "certifications": [],
        "chat": {
          "jabberId": "example"
        },
        "conversationSummary": {
          "call": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "callback": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "chat": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "email": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "message": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "socialExpression": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          },
          "userId": "example",
          "video": {
            "contactCenter": {
              "active": 1,
              "acw": 1
            },
            "enterprise": {
              "active": 1,
              "acw": 1
            }
          }
        },
        "dateLastLogin": "example",
        "dateWelcomeSent": "example",
        "department": "example",
        "division": {
          "id": "example",
          "name": "example",
          "selfUri": "example"
        },
        "email": "example",
        "employerInfo": {
          "dateHire": "example",
          "employeeId": "example",
          "employeeType": "example",
          "officialName": "example"
        },
        "geolocation": {
          "city": "example",
          "country": "example",
          "id": "example",
          "latitude": 1.0,
          "locations": [],
          "longitude": 1.0,
          "name": "example",
          "primary": false,
          "region": "example",
          "selfUri": "example",
          "type": "example"
        },
        "groups": [],
        "id": "example",
        "images": [],
        "integrationPresence": {
          "futurePresenceDefinition": {
            "id": "example",
            "selfUri": "example",
            "systemPresence": "example"
          },
          "id": "example",
          "message": "example",
          "modifiedDate": "example",
          "name": "example",
          "presenceDefinition": {
            "id": "example",
            "selfUri": "example",
            "systemPresence": "example"
          },
          "primary": false,
          "selfUri": "example",
          "source": "example",
          "sourceId": "example"
        },
        "languagePreference": "example",
        "languages": [],
        "lastTokenIssued": {
          "dateIssued": "example"
        },
        "locations": [],
        "manager": {
          "acdAutoAnswer": false,
          "addresses": [],
          "authorization": {
            "permissionPolicies": [],
            "permissions": [],
            "roles": [],
            "unusedRoles": []
          },
          "biography": {
            "biography": "example",
            "education": [],
            "hobbies": [],
            "interests": [],
            "spouse": "example"
          },
          "certifications": [],
          "chat": {
            "jabberId": "example"
          },
          "conversationSummary": {
            "call": {
              "contactCenter": {},
              "enterprise": {}
            },
            "callback": {
              "contactCenter": {},
              "enterprise": {}
            },
            "chat": {
              "contactCenter": {},
              "enterprise": {}
            },
            "email": {
              "contactCenter": {},
              "enterprise": {}
            },
            "message": {
              "contactCenter": {},
              "enterprise": {}
            },
            "socialExpression": {
              "contactCenter": {},
              "enterprise": {}
            },
            "userId": "example",
            "video": {
              "contactCenter": {},
              "enterprise": {}
            }
          },
          "dateLastLogin": "example",
          "dateWelcomeSent": "example",
          "department": "example",
          "division": {
            "id": "example",
            "name": "example",
            "selfUri": "example"
          },
          "email": "example",
          "employerInfo": {
            "dateHire": "example",
            "employeeId": "example",
            "employeeType": "example",
            "officialName": "example"
          },
          "geolocation": {
            "city": "example",
            "country": "example",
            "id": "example",
            "latitude": 1.0,
            "locations": [],
            "longitude": 1.0,
            "name": "example",
            "primary": false,
            "region": "example",
            "selfUri": "example",
            "type": "example"
          },
          "groups": [],
          "id": "example",
          "images": [],
          "integrationPresence": {
            "futurePresenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "id": "example",
            "message": "example",
            "modifiedDate": "example",
            "name": "example",
            "presenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "primary": false,
            "selfUri": "example",
            "source": "example",
            "sourceId": "example"
          },
          "languagePreference": "example",
          "languages": [],
          "lastTokenIssued": {
            "dateIssued": "example"
          },
          "locations": [],
          "manager": {},
          "name": "example",
          "outOfOffice": {
            "active": false,
            "endDate": "example",
            "id": "example",
            "indefinite": false,
            "name": "example",
            "selfUri": "example",
            "startDate": "example",
            "user": {}
          },
          "preferredName": "example",
          "presence": {
            "futurePresenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "id": "example",
            "message": "example",
            "modifiedDate": "example",
            "name": "example",
            "presenceDefinition": {
              "id": "example",
              "selfUri": "example",
              "systemPresence": "example"
            },
            "primary": false,
            "selfUri": "example",
            "source": "example",
            "sourceId": "example"
          },
          "primaryContactInfo": [],
          "profileSkills": [],
          "routingStatus": {
            "startTime": "example",
            "status": "OFF_QUEUE",
            "userId": "example"
          },
          "selfUri": "example",
          "skills": [],
          "state": "active",
          "station": {
            "associatedStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "defaultStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "effectiveStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            },
            "lastAssociatedStation": {
              "associatedDate": "example",
              "associatedUser": {},
              "defaultUser": {},
              "id": "example",
              "name": "example",
              "providerInfo": {},
              "type": "example",
              "webRtcCallAppearances": 1
            }
          },
          "team": {
            "dateCreated": "example",
            "dateModified": "example",
            "description": "example",
            "division": {
              "id": "example",
              "name": "example",
              "selfUri": "example"
            },
            "id": "example",
            "memberCount": 1,
            "name": "example",
            "selfUri": "example"
          },
          "title": "example",
          "username": "example",
          "version": 1,
          "workPlanBidRanks": {
            "biddingTieBreaker": "example",
            "id": "example",
            "selfUri": "example",
            "workPlanBiddingPerformance": 1
          }
        },
        "name": "example",
        "organization": {
          "defaultCountryCode": "example",
          "defaultLanguage": "example",
          "defaultSiteId": "example",
          "domain": "example",
          "features": {},
          "id": "example",
          "name": "example",
          "productPlatform": "GenesysCloud",
          "selfUri": "example",
          "state": "active",
          "supportURI": "example",
          "thirdPartyOrgName": "example",
          "thirdPartyURI": "example",
          "version": 1,
          "voicemailEnabled": false
        },
        "outOfOffice": {
          "active": false,
          "endDate": "example",
          "id": "example",
          "indefinite": false,
          "name": "example",
          "selfUri": "example",
          "startDate": "example",
          "user": {
            "acdAutoAnswer": false,
            "addresses": [],
            "authorization": {
              "permissionPolicies": [],
              "permissions": [],
              "roles": [],
              "unusedRoles": []
            },
            "biography": {
              "biography": "example",
              "education": [],
              "hobbies": [],
              "interests": [],
              "spouse": "example"
            },
            "certifications": [],
            "chat": {
              "jabberId": "example"
            },
            "conversationSummary": {
              "call": {},
              "callback": {},
              "chat": {},
              "email": {},
              "message": {},
              "socialExpression": {},
              "userId": "example",
              "video": {}
            },
            "dateLastLogin": "example",
            "dateWelcomeSent": "example",
            "department": "example",
            "division": {
              "id": "example",
              "name": "example",
              "selfUri": "example"
            },
            "email": "example",
            "employerInfo": {
              "dateHire": "example",
              "employeeId": "example",
              "employeeType": "example",
              "officialName": "example"
            },
            "geolocation": {
              "city": "example",
              "country": "example",
              "id": "example",
              "latitude": 1.0,
              "locations": [],
              "longitude": 1.0,
              "name": "example",
              "primary": false,
              "region": "example",
              "selfUri": "example",
              "type": "example"
            },
            "groups": [],
            "id": "example",
            "images": [],
            "integrationPresence": {
              "futurePresenceDefinition": {},
              "id": "example",
              "message": "example",
              "modifiedDate": "example",
              "name": "example",
              "presenceDefinition": {},
              "primary": false,
              "selfUri": "example",
              "source": "example",
              "sourceId": "example"
            },
            "languagePreference": "example",
            "languages": [],
            "lastTokenIssued": {
              "dateIssued": "example"
            },
            "locations": [],
            "manager": {},
            "name": "example",
            "outOfOffice": {},
            "preferredName": "example",
            "presence": {
              "futurePresenceDefinition": {},
              "id": "example",
              "message": "example",
              "modifiedDate": "example",
              "name": "example",
              "presenceDefinition": {},
              "primary": false,
              "selfUri": "example",
              "source": "example",
              "sourceId": "example"
            },
            "primaryContactInfo": [],
            "profileSkills": [],
            "routingStatus": {
              "startTime": "example",
              "status": "OFF_QUEUE",
              "userId": "example"
            },
            "selfUri": "example",
            "skills": [],
            "state": "active",
            "station": {
              "associatedStation": {},
              "defaultStation": {},
              "effectiveStation": {},
              "lastAssociatedStation": {}
            },
            "team": {
              "dateCreated": "example",
              "dateModified": "example",
              "description": "example",
              "division": {},
              "id": "example",
              "memberCount": 1,
              "name": "example",
              "selfUri": "example"
            },
            "title": "example",
            "username": "example",
            "version": 1,
            "workPlanBidRanks": {
              "biddingTieBreaker": "example",
              "id": "example",
              "selfUri": "example",
              "workPlanBiddingPerformance": 1
            }
          }
        },
        "preferredName": "example",
        "presence": {
          "futurePresenceDefinition": {
            "id": "example",
            "selfUri": "example",
            "systemPresence": "example"
          },
          "id": "example",
          "message": "example",
          "modifiedDate": "example",
          "name": "example",
          "presenceDefinition": {
            "id": "example",
            "selfUri": "example",
            "systemPresence": "example"
          },
          "primary": false,
          "selfUri": "example",
          "source": "example",
          "sourceId": "example"
        },
        "primaryContactInfo": [],
        "profileSkills": [],
        "routingStatus": {
          "startTime": "example",
          "status": "OFF_QUEUE",
          "userId": "example"
        },
        "skills": [],
        "state": "active",
        "station": {
          "associatedStation": {
            "associatedDate": "example",
            "associatedUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "defaultUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "id": "example",
            "name": "example",
            "providerInfo": {},
            "type": "example",
            "webRtcCallAppearances": 1
          },
          "defaultStation": {
            "associatedDate": "example",
            "associatedUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "defaultUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "id": "example",
            "name": "example",
            "providerInfo": {},
            "type": "example",
            "webRtcCallAppearances": 1
          },
          "effectiveStation": {
            "associatedDate": "example",
            "associatedUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "defaultUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "id": "example",
            "name": "example",
            "providerInfo": {},
            "type": "example",
            "webRtcCallAppearances": 1
          },
          "lastAssociatedStation": {
            "associatedDate": "example",
            "associatedUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "defaultUser": {
              "acdAutoAnswer": false,
              "addresses": [],
              "authorization": {},
              "biography": {},
              "certifications": [],
              "chat": {},
              "conversationSummary": {},
              "dateLastLogin": "example",
              "dateWelcomeSent": "example",
              "department": "example",
              "division": {},
              "email": "example",
              "employerInfo": {},
              "geolocation": {},
              "groups": [],
              "id": "example",
              "images": [],
              "integrationPresence": {},
              "languagePreference": "example",
              "languages": [],
              "lastTokenIssued": {},
              "locations": [],
              "manager": {},
              "name": "example",
              "outOfOffice": {},
              "preferredName": "example",
              "presence": {},
              "primaryContactInfo": [],
              "profileSkills": [],
              "routingStatus": {},
              "selfUri": "example",
              "skills": [],
              "state": "active",
              "station": {},
              "team": {},
              "title": "example",
              "username": "example",
              "version": 1,
              "workPlanBidRanks": {}
            },
            "id": "example",
            "name": "example",
            "providerInfo": {},
            "type": "example",
            "webRtcCallAppearances": 1
          }
        },
        "team": {
          "dateCreated": "example",
          "dateModified": "example",
          "description": "example",
          "division": {
            "id": "example",
            "name": "example",
            "selfUri": "example"
          },
          "id": "example",
          "memberCount": 1,
          "name": "example",
          "selfUri": "example"
        },
        "title": "example",
        "username": "example",
        "version": 1,
        "workPlanBidRanks": {
          "biddingTieBreaker": "example",
          "id": "example",
          "selfUri": "example",
          "workPlanBiddingPerformance": 1
        }
      },
      "dateCreated": "example",
      "enabled": false,
      "id": "example",
      "organization": {
        "defaultCountryCode": "example",
        "defaultLanguage": "example",
        "defaultSiteId": "example",
        "domain": "example",
        "features": {},
        "id": "example",
        "name": "example",
        "productPlatform": "GenesysCloud",
        "selfUri": "example",
        "state": "active",
        "supportURI": "example",
        "thirdPartyOrgName": "example",
        "thirdPartyURI": "example",
        "version": 1,
        "voicemailEnabled": false
      },
      "selfUri": "example"
    },
    "twitterId": {
      "id": "example",
      "name": "example",
      "profileUrl": "example",
      "screenName": "example",
      "verified": false
    },
    "websites": []
  }
}

On this page