Parse clipboard text to create a person - cobra CRM Cloud

Request

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

text

string

required

>= 1 characters

Example

{
    "text": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.cobra.de/v1/crm/people/parse-clipboard' \
--header 'X-Integration-Name: API Documentation' \
--header 'X-Integration-Provider: cobra GmbH' \
--header 'X-Cobra-TenantId: 12e39e53-ece1-4d8d-8958-e782de1dbef0' \
--header 'Content-Type: application/json' \
--data-raw '{
    "text": "string"
}'

Responses

🟢200OK

application/json

OK

Body

Represents a DTO for creating a person.

salutation

string | null

optional

The salutation of the person.

title

string | null

optional

The title of the person.

<= 200 characters

firstname

string | null

optional

The first name of the person.

<= 200 characters

lastname

string | null

optional

The last name of the person.

<= 200 characters

birthday

object (PeopleBirthdayDto)

optional

birthday

null

optional

The Birthday of the person.

The birthday may be a maximum of up to 130 years in the past or is today.

Example:

"0001-01-01"

considerBirthYear

boolean

optional

The flag to consider the birth year.

If the year of birth is not considered, the value must be 1584.

importantDates

array[object (PeopleImportantDate) {2}] | null

optional

The list of important dates.

text

string | null

optional

The text associated with the important date.

date

string <date-time> | null

optional

The date value of the important date.

socialMedias

array[object (PeopleSocialMedia) {2}] | null

optional

The List of social media accounts.

type

string | null

optional

The type of the social media profile.

link

string | null

optional

The link to the social media profile.

orgaTags

array[object (CobraTagForEmbeddedDto) {2}] | null

optional

The List of orga tags.

id

string | null

optional

Gets or sets the identifier for the entity.

Example:

123456789012345678901234

text

string | null

optional

Gets or sets the Text.

<= 200 characters

Example:

SomeTag

personalities

array[object (EmbeddedPersonality) {3}] | null

optional

The List of personalities.

id

string | null

optional

Id of the personality object.

category

string | null

optional

Category of the personality object.

text

string | null

optional

Text of the personality object.

customerNumber

string | null

optional

Represents the customer number.

<= 200 characters

employeeStatus

string | null

optional

The employee status of the person.

employeeNumber

string | null

optional

The employee number of the person.

lifecycle

object (PeopleLifecycleForInput)

optional

Input Object for lifecycle information

lifecycleId

string | null

optional

The lifecycle ID.

The other fields are automatically filled with values from the database.

Example

{
    "salutation": "string",
    "title": "string",
    "firstname": "string",
    "lastname": "string",
    "birthday": {
        "birthday": "\"0001-01-01\"",
        "considerBirthYear": true
    },
    "importantDates": [
        {
            "text": "string",
            "date": "2019-08-24T14:15:22Z"
        }
    ],
    "socialMedias": [
        {
            "type": "string",
            "link": "string"
        }
    ],
    "orgaTags": [
        {
            "id": "123456789012345678901234",
            "text": "SomeTag"
        }
    ],
    "personalities": [
        {
            "id": "string",
            "category": "string",
            "text": "string"
        }
    ],
    "customerNumber": "string",
    "employeeStatus": "string",
    "employeeNumber": "string",
    "lifecycle": {
        "lifecycleId": "string"
    }
}

🟠400Bad Request