List of Operations

Purpose: Entry point of the API Reference.

Contents of the API Reference

As explained in the Migration page, all the service resources are now part of GMS and all the information related to contact information stays in UCS. As a result, the CS API is divided between UCS and GMS.

Operations

Services API Reference

This icon identifies all the queries related to data managed on the GMS side.

• Maintenance Operations
  • GET /maintenance/services/stream
  • POST /maintenance/services/files
  • POST /maintenance/purge
• Service Operations
  • POST /services/start
  • POST /customers/${customer id}/services/${service id}
  • POST /services/${service id}/end
  • GET /services/${service id}
  • DELETE /services/${service id}
  • GET /services/anonymous/${contact key}/active
  • GET /services/anonymous/${contact key}/completed
  • GET /services/anonymous/${contact key}
  • GET /customers/${customer id}/services/active
  • GET /customers/${customer id}/services/completed
  • GET /customers/${customer id}/services
  • PUT /services/${service id}/extensions/${ext name}/by/unique
  • PUT /services/${service id}/extensions/${ext name}/delete/by/unique
• State Operations
  • POST /services/${service id}/states/${state id}/end
  • POST /services/${service id}/states/transition
  • GET /services/${service id}/states
  • GET /services/${service id}/states/${state id}
  • POST /services/${service id}/states/start

• Task Operations
  • POST /services/${service id}/tasks/${task id}/end
  • GET /services/${service id}/tasks
  • GET /services/${service id}/tasks/${task id}
  • POST /services/${service id}/tasks/start
  • PUT /services/${service id}/tasks/${task id}/extensions/${extension name}

• Service Resources
  • End Event List
  • Extension
  • Start Event List
  • State Transition Event
  • Service
  • State
  • Task

Important

Because the extensions are now handled as JSON data, all the queries related to service, state, and task extensions are now deprecated.

Customer Profile API Reference

This icon identifies all the queries related to data managed on the UCS side. These queries cover interactions, identification and profile management.

• Profile Operations
  • POST /profiles
  • GET /profiles
  • POST /profiles/${customer id}/extensions
  • GET /profiles/${customer id}
  • PUT /profiles/${customer id}
    • PUT /profiles/${customer id}/extensions/${ext name}/by/unique
    • PUT /profiles/${customer id}/extensions/${ext name}/delete/by/unique
    • PUT profiles/${customer_id}/merge/${src_id}/

• Schema and Identification Key Operations
  • GET /metadata/profiles/
  • POST /metadata/profiles/extensions
  • GET /metadata/profiles/extensions
  • GET /metadata/identification-keys
  • POST /metadata/identification-keys
  • GET ${content-type} /metadata
  • DELETE /metadata/profiles/extensions/${extension-name}
  • DELETE /metadata/identification-keys/${id_key-name}

• Interaction Operations
  • GET /customers/${customer id}/interactions
  • GET /services/${service id}/interactions
  • GET /interactions/${interaction id}