PUT (update)

Updates the status or tags of an existing social contact.

You can also add, edit, or remove tags using the update command.

URL:

https://<ServerIP>:<Port>/ccp-webapp/ccp/socialcontact/<objectId>

HTTPS method:

PUT

Parameters:

See Social Contact API Parameters.

Example XML request payload: 

<SocialContact>
    <status>reserved</status>
    <statusReason>unknown</statusReason>
    <statusTimestamp>1531136406619</statusTimestamp>
    <tags>
        <tag>changed_1</tag>
        <tag>changed_2</tag>
    </tags>
</SocialContact>
Note
If the social contact is associated with a feed that supports reply templates, then the replyTemplateRefURL and replyTemplateURL fields are included. These fields can not be changed by the social contact API. The fields draftResponse and draftAction are saved only with a social contact update that transitions to state draft. If the social contact transitions to the handled state, then the draftResponse and draftAction are cleared.
Updates to following fields are restricted (updates can only be made by the system):

  • isInvited: this field is set to true if the chat contact was created as a result of a chat invitation. This field is set by the system when the chat contact is created. It is set to false by default for all other social contacts.

  • shortURLIds: is a list of short URL Ids which were generated for this social contact. This list is updated when a short URL is created for a social contact.

You can set the QUEUED status from the API. However, currently it is only set internally by Customer Collaboration Platform. Customer Collaboration Platform sets the social contact status to QUEUED when a social contact is to be or has been routed to some external entity.

Example XML response: 


<SocialContact>
	<refURL>https://[ServerIP]:[Port]/ccp-webapp/ccp/socialcontact/
  22E00F5310000129460A1EB40A568DDE</refURL>
	<status>reserved</status>
	<statusTimestamp>1276190792688</statusTimestamp>
	<tags>
		<tag>cool</tag>
		<tag>fresh</tag>
	</tags>
	<statusUserId>admin</statusUserId>
</SocialContact>