cobra CRM Cloud - API Docs
Update an existing touchpoint by its ID
PUT/touchpoints/{id}Last modified: 24 days ago
Request
Path Params
id
string
optional
Header Params
X-Integration-Name
string
required
Integration name
Example:
API Documentation
X-Integration-Provider
string
required
Integration provider
Example:
cobra GmbH
X-Cobra-TenantId
string
required
Tenant ID
Example:
12e39e53-ece1-4d8d-8958-e782de1dbef0
X-Integration-Contact
string
optional
Integration contact
Example:
info@cobra.de
Accept-Language
string
optional
Example:
de
Body Params application/json
topic
string
required
>= 1 characters<= 200 characters
details
string | null
optional
<= 100000 characters
source
string | null
optional
<= 200 characters
sourceUrl
string | null
optional
touchDate
string <date-time>
required
touchTime
string <date-time> | null
optional
currentMood
integer <int32>
optional
>= -2<= 2
peopleInvolved
array[object (PeopleInvolvedDto) {8}]
required
>= 1 items
peopleId
string | null
optional
firstname
string | null
optional
lastname
string | null
optional
businessCardId
string | null
optional
iconUrl
string | null
optional
highlighted
boolean
optional
participantRole
string | null
optional
integrationInitiator
object (IntegrationInitiatorDto)
required
channel
object (AbstractChannelDto)
optional
priority
string | null
optional
isOutgoing
boolean
optional
orgaTags
array[object (CobraTagForEmbeddedDto) {2}] | null
required
id
string | null
optional
text
string | null
optional
<= 200 characters
objectLinks
array[object (ObjectLinkForCreateDto) {2}] | null
required
relationIds
$ref(#/definitions/1878512)[] | null
optional
identifier
string | null
optional
note
string | null
optional
<= 10000 characters
Example
Not configured
Request samples
Responses
returns if the touchpoint was successfully edited, updated.(200)
returns if the request violates a validation rule.(400)
returns if you do not have the required permissions.(403)
returns if no touchpoint could be found with this Id.(404)
returns if the touchpoint was successfully edited, updated.
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
data
object (TouchpointDto)
optional
id
string | null
optional
createdBy
string | null
optional
modifiedBy
string | null
optional
dateCreated
string <date-time> | null
optional
dateModified
string <date-time> | null
optional
createdByUserId
string <uuid> | null
optional
modifiedByUserId
string <uuid> | null
optional
topic
string | null
optional
details
string | null
optional
source
string | null
optional
sourceUrl
string | null
optional
touchNote
object (TouchpointNoteDto)
optional
objectLinksDefinitions
array[object (ObjectLinksDto) {3}] | null
optional
files
array[object (TouchpointFileDto) {11}] | null
optional
touchDate
string <date-time> | null
optional
touchTime
string <date-time> | null
optional
currentMood
integer <int32>
optional
peopleInvolved
array[object (PeopleInvolvedDto) {8}] | null
optional
channel
object (AbstractChannelDto)
optional
priority
string | null
optional
isOutgoing
boolean
optional
orgaTags
array[object (CobraTagForEmbeddedDto) {2}] | null
optional
message
string | null
optional
metaData
object (ResponseMetaData)
optional
totalResults
integer <int32>
optional
responseTimeStamp
string <date-time>
optional
statusCode
integer <int32>
optional
Example
Not configured
Last modified: 24 days ago