Jump to: navigation, search

mergeProfiles

Purpose

Merges two profiles together, transferring all data from one to the other (attributes and extensions).

URL

  • PUT /profiles/{customer_id}/merge/{source_id}

Request

URL Parameters

Key ValueType Value Description Mandatory Unique Default
customer_id String The customer ID where the data is to be merged (destination). true true
source_id String The customer ID of the source customer data to be merged (source). This ID will be deleted once the merge is complete. true true

HTTP Headers

Key ValueType Value Description Mandatory Unique Default
X-Genesys-TenantId Integer Integer value of tenant id false true
X-Genesys-Segment String Segment value (not to be provided by customer) false true


Body

Key ValueType Value Description Mandatory Unique Default
agent_id String ID of the agent performing the merge operation. 0 for no Agent ID false true 0
force_merge Boolean Force the merge in case of extension conflicts. Do not fail and use the source value for the merged contact. false true false
reason String Reason why this merge is performed false true
description String false true

Sample

PUT /profiles/00001b8BBKDX000D/merge/00001b8BBKDX000H
{ }

Responses

Success

ReturnCode ReturnString Description
204 OK Request successful

Error

FaultCode FaultString Description
400 Bad Request General error which can be one of the following reasons:
  • Missing required parameter.
  • Parameter value of unexpected type.
  • Invalid object syntax.
  • Missing required attribute
401 Not Authorized Credentials are missing or incorrect, or the given user is not allowed to execute a given service (such as an administrative service method that changes the profile schema).
403 Forbidden The operation is forbidden and the reason is specified in the error message. This error is returned in the following cases:
  • Attempt to add customer profiles prior to the definition of a profile schema.
404 Not Found The specified URI is invalid, or the requested resource (such as a customer, service, state, task, extension, or identification key) does not exist.
405 Method Not Allowed Returned when an unsupported operation is requested. For instance, if a resource supports only PUT and GET operations, a POST request on this resource returns this error.
415 Unsupported Media Type In the header of your request, Content-Type is not set to a valid value. Most operations of Context Services support only "application/json".

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.