cobra CRM Cloud - API Docs
StartWebsitecobra Knowledge Portal
StartWebsitecobra Knowledge Portal
  1. cobra CRM
  2. People360
  • Welcome to our Developer Portal
  • Hybrid REST / GraphQL API
  • GraphQL API Endpoints
  • Versioning
  • Translated Responses
  • Tenant Context
  • Authentication
  • Pagination, Sorting, Filtering in GraphQL
  • Date/Time Format And Time Zones
  • Usage Policy
  • Access
    • Get a user by id
    • Update an existing user
    • Delete a user
    • Create a new user
    • Deactivate an existing user
    • Activate an existing user
    • Reset the password for an existing user
    • Delete multiple users by id
    • Get available roles for a tenant
  • Auth
    • Get the OAuth2 configuration URL and the client ID.
    • Logs in to cobra with the login data and returns a bearer token if successful.
    • This is an implementation of the Introspect endpoint as defined in RFC 7662
  • cobra CRM
    • People360
      • Business Cards
        • Update an existing address in a business card of a person
        • Delete an address from a specific business card of a person by its address ID
        • Create a new address in a person's existing business card
        • Update an existing business card of a specific person by the business card ID
        • Retrieve the details of an existing business card from a specific person by the people ID and the business card ID
        • Delete a business card form a specific person by the business card ID
        • Retrieve the details of all existing business cards from a specific person by the people ID
        • Create a new business card for an existing person
        • Retrieve the details of an existing business card from a specific person only by the business card ID
        • Delete multiple business cards from a person by their IDs
        • Retrieve an existing person's business card as a vCard (.vcf)
      • Relations
        • Retrieve all relations of a given specific person by relation category
        • Relate two people with each other
        • Update a specific relation of a person
        • Remove a relation between two people
        • Creates one or more existing relations to multiple people
        • Update one or more existing relations of a person
        • Remove multiple relations of one or more people
      • Settings
        • Update the settings for People360 such as postal address validation etc
      • Management
        • Create one or more new entries for people properties
        • Delete multiple entries for people properties from a list by their IDs
        • Delete an entry for people property from a list by its ID
        • Create one or more personality tags
        • Delete multiple personality tags from the list by their IDs
        • Delete a personality tag from the list by its ID
        • Create one or more new orga tags
        • Delete multiple orga tags from the list by their IDs
        • Delete an orga tag from the list by its ID
        • Create one or more new address types
        • Delete multiple address types from the list by their IDs
        • Delete an address type from the list by its ID
        • Create one or more life cycles
        • Delete multiple life cycles from the list by their IDs
        • Delete a life cycle from the list by its ID
        • Create one or more new manager roles that can be assumed by responsible people
        • Delete multiple manager roles from the list by their IDs
        • Delete a manager role from the list by its ID
        • Create one or more new address types
        • Delete multiple address types from the list by their IDs
        • Delete an address type from the list by its ID
      • Batch
        • Start a new process to validate addresses
        • Cancel an ongoing process that validates addresses
        • A data set with information about the process
      • PeopleMerge
        • If 2 people have been merged, this end point must be called at the end.
      • Retrieve people filtered by email or employee status or both
        GET
      • Retrieve a list of people
        GET
      • Create a new person
        POST
      • Retrieve the details of an existing person by its ID
        GET
      • Update an existing person by its ID
        PUT
      • Delete a person by its ID
        DELETE
      • Retrieve a quicklook of an existing person by its ID
        GET
      • Update one or more existing people
        PUT
      • Create one or more people
        POST
      • Delete multiple people by their IDs
        DELETE
      • Update the note on a person by its ID
        PUT
      • Update the list of orga tags on a person by its ID (the list will be overwrite)
        PUT
      • Update the list of personality tags on a person by its ID (the list will be overwrite)
        PUT
      • Update the lifecycle on a person by its ID
        PUT
      • Retrieve all type of profile images for a person by its ID
        GET
      • Upload a replacement profile image for a person by its ID
        POST
      • Delete the profile image of a person by its ID
        DELETE
    • Touchpoints
      • Documents
        • Upload a file to an existing touchpoint
        • Delete a file from a touchpoint by its ID
      • Settings
        • Configure which of the predefined touchpoint types and channels should be activated for use
      • Management
        • Create one or more new tags
        • Delete multiple tags from the list by their IDs
        • Delete a tag from the list by its ID
      • Ai
        • Use AI to generate an email text based on the last touchpoints
        • Uses AI to generate a recommendation of the next steps based on the last touchpoints
      • Retrieve the details of an existing touchpoint by its ID
      • Create a new touchpoint
      • Update an existing touchpoint by its ID
      • Delete a touchpoint by its ID
      • Delete multiple touchpoints by their IDs
      • Perform an input validation without changing the data set or creating a touchpoint in the database (calculated fields are returned)
      • Add one or more tags to selected touchpoints
      • Remove one or more tags from selected touchpoints by their IDs
      • Delete a person involved from the touchpoint by its ID
      • Update the priority for multiple touchpoints by their IDs
      • Update the priority for a touchpoint by its ID
      • Add the current mood to a touchpoint by its ID
      • Move touchpoints from one person to another
    • Companies
      • Relations
        • Relate two companies with each other
        • Update a specific relation of a company
        • Remove a relation between two companies
        • Update one or more existing relations of a company
        • Remove multiple relations of one or more companies
        • Change the direction of the relation between two companies
      • Documents
        • Upload a file to an existing company
        • Delete a file from a company by its ID
      • Settings
        • Update the settings for Companies such as postal address validation etc.
      • Management
        • Create one or more new tags
        • Delete multiple tags from the list by their IDs
        • Delete a tag from the list by its ID
        • Create one or more entries for number of employees
        • Delete multiple entries for number of employees from the list by their IDs
        • Delete an entry for number of employees from the list by its IDs
        • Create one or more entries for number of customers
        • Delete multiple entries for number of customers from the list by their IDs
        • Delete an entry for number of customers from the list by its IDs
        • Create one or more legal forms
        • Delete multiple legal forms from the list by their IDs
        • Delete a legal form from the list by its IDs
        • Create one or more reference number types
        • Delete multiple reference number types from the list by their IDs
        • Delete a reference number type from the list by its ID
        • Create one or more industry sectors
        • Delete multiple industry sectors from the list by their IDs
        • Delete an industry sector from the list by its ID
        • Create one or more relation types
        • Delete multiple relation types from the list by their IDs
        • Updates a relation Type
        • Delete a relation type from the list by its ID
        • Create one or more life cycles
        • Delete multiple life cycles from the list by their IDs
        • Delete a life cycle from the list by its ID
      • Batch
        • A data set with information about the process
        • Cancel an ongoing process that validates addresses
        • Start a new process to validate addresses
      • Bank Accounts
        • Upload a file for the direct debit mandate to a company bank account
        • Delete a file for the direct debit authorization from a company bank account
      • Logos
        • Upload a replacement logo for a company by its ID
        • Delete the logo from a company by its ID
        • Upload a logo for a company by its ID using the clearbit api and delete the old logo
      • Create a new address for an exisiting company
      • Update an existing address of a specific company by its ID This endpoint should be only used by the frontend
      • Delete an address from a specific company by its ID
      • Retrieve the details of an existing company by its ID
      • Update an existing company by its ID
      • Delete a company by its ID
      • Retrieve the details of a company by its domain
      • Create a new company
      • Update the note on a company by its ID
      • Update the list of tags on a company by its ID (the list will be overwrite)
      • Update the lifecycle on a company by its ID
      • Delete multiple companies by their IDs
      • Add one or more tags to selected companies
      • Remove one or more tags from selected companies by their IDs
      • Add a new phone number to an exisitng company
      • Update an existing phone number of a specific company by its ID
      • Delete a phone number form a specific company by its ID
      • Perform an input validation without changing the data set or creating a company in the database (calculated fields are returned)
      • Add a new e-mail address to an existing company
      • Update an existing e-mail address of a specific company by its ID
      • Delete an e-mail address form a specific company by its ID
  • cobra Event
    • Settings
      • Booking form field sets
        • Gets a field set for booking forms by its ID
        • Updates an existing field set for booking forms
        • Deletes an existing field set for booking forms
        • Creates a new field set for booking forms
        • Validates a field set for booking forms
        • Replaces all references to existing booking form field set by another set.
      • Cancellation conditions
        • Gets a cancellation condition by its ID
        • Updates an existing cancellation condition
        • Deletes an existing cancellation condition
        • Creates a new cancellation condition
        • Validates a cancellation condition
        • Replaces all references to existing cancellation condition by another condition.
      • Contact person templates (copy list)
        • Gets a contact person template by its ID
        • Updates an existing contact person template
        • Deletes an existing contact person template
        • Creates a new contact person template
        • Deletes a list of contact person templates
        • Validates a contact person template
      • Contributor roles (tenant list)
        • Gets a contributor role by its ID
        • Updates an existing contributor role
        • Deletes an existing contributor role
        • Creates a new contributor role
        • Deletes a list of contributor roles
        • Validates a contributor role
        • Replaces all references to existing contributor role by another contributor role.
      • Event categories (tenant list)
        • Gets an event category by its ID
        • Updates an existing event category
        • Deletes an existing event category
        • Creates a new event category
        • Deletes a list of event categories
        • Validates an event category
        • Replaces all references to existing event category by another event category.
      • Online meeting platforms (vendor list)
        • Gets a online meeting platform by its ID
      • Orga tags (adhoc list)
        • Gets an orga tag by its ID
        • Updates an existing orga tag
        • Deletes an existing orga tag
        • Creates a new orga tag
        • Deletes a list of orga tags
        • Validates an orga tag
        • Replaces all references to existing orga tag by another orga tag.
      • Tax rates (vendor list)
        • Gets a tax rate by its ID
      • Portal tags (tenant list)
        • Gets a portal tag by its ID
        • Updates an existing portal tag
        • Deletes an existing portal tag
        • Creates a new portal tag
        • Deletes a list of portal tags
        • Validates a portal tag
        • Replaces all references to existing portal tag by another portal tag.
      • Gets the event settings for the current tenant
      • Updates the event settings for the current tenant
      • Validates the event settings
    • Event files
      • Uploads the provided file for the event
      • Deletes the file with the specified url of an event
      • Deletes all files of an event
    • Event images
      • Uploads an image of a certain type for the event
      • Deletes the image with the specified url of an event
      • Deletes all images of an event
      • Updates the alternative text of an image
    • Contact person template images
      • Uploads an image for the contact person template.
      • Deletes the contact person template image.
      • Deletes a list of contact person template images.
    • Bookings
      • Creates a new booking (public)
      • Gets a booking by its ID
      • Gets the confirmation infos for a successful booking (public)
      • Deletes an existing booking
      • Deletes a list of bookings
      • Calculates the current cancellation rules that apply when cancelling a booking including all tickets
      • Cancels a booking and all belonging tickets
      • Cancels a booking and all belonging tickets
      • Calculates the current cancellation rules that apply when cancelling a booking including all tickets
      • Sets the booker information for a booking
      • Sends an invoice mail to the booker
      • Sets the invoice number of an external booking
      • Change the status of a payment
      • Collects the booking history statistics for an event
      • Collects the booking history actions for an event
    • Invitations
      • Gets details of an invitation (public)
      • Gets an invitation by its ID
      • Gets details of an invitation (public)
      • Deletes an existing invitation
      • Reject an Invitation. If a ticket was already bought using this invitation, the ticket is cancelled.
      • Deletes a list of invitations
      • Creates a new invitation for an event
      • Validates an invitation
      • Send an invitation e-mail to a list of persons to invite
      • Send an filtered invitation e-mail to a list of persons to invite
      • Send an invitation free e-mail to a list of persons to invite
      • Send an filtered invitation free e-mail to a list of persons to invite
      • Sets information data for the invited person
      • Imports invitations from a file
      • Generates a preview for a file import
      • Exports invitations for an event
      • Change the status of a list of participants
    • Event tickets
      • Gets an event ticket by its ID
      • Add custom integration data to an event ticket
      • Get an event ticket summary
      • Change the status of a list of participants
      • Resend event tickets to a list of participants
      • Send free mails to a list of participants
      • Send free mails to filtered participants
      • Validates an event ticket and checks it in
      • Sets participant information data
      • Exports event tickets
    • Website images
      • Uploads an image of a certain type for the website
      • Deletes the image with the specified url of a website
      • Deletes all images of a website
      • Updates the alternative text of an image
    • Websites
      • Gets a website by its ID
      • Gets an event by its ID (public)
      • Updates an existing website
      • Gets the field set for booking forms that is used by an event (public)
      • Deletes an existing website
      • Gets a portal config by its url (public)
      • Creates a new website
      • Deletes a list of websites
      • Validates a website
      • Validates a website
      • Replaces all references to existing event portal by another event portal: all events using the original portal will migrate to the replacement portal.
      • Enables or disables the publication of a website
      • Validates the publication of a website
    • Gets an event by its ID
    • Updates an existing event
    • Deletes an existing event
    • Creates a new event
    • Deletes a list of events
    • Validates an event
    • Get event as iCal format
    • Duplicates an event
    • Updates the note of an event
    • Updates the publication of an event
    • Validates the publication of an event
  • Tickets
    • Get a ticket by id
    • Update an existing ticket
    • Delete a ticket
    • Create a new ticket
    • Change ticket state (New, In Progress, Done)
  • Integrations
    • Webhooks
      • Get a list of all webhook subscriptions
      • Create a new webhook subscription
      • Get a webhook subscription by ID
      • Delete a webhook subscription
      • Change a webhook subscription
      • Lists all Webhook events which can be subscribed
    • EAP
      • Connectors
        • Get all available folders of a mailbox
        • Get all available categories of a mailbox
        • Get all available user with short and display name of cobra CRM
      • RuleActions
        • Get all actions of a rule
        • Create a new action for a rule
        • Delete an action by id
        • Delete all actions for the rule
      • RuleFilters
        • Get all filters of a rule which are used to filter emails before applying actions
        • Create a new filter for a rule
        • Delete all filters of a rule
      • Rules
        • Get all rules for the current user
        • Create a new rule for the current user
        • Get a rule by id
        • Modify an existing rule
        • Delete a rule by id
      • Runs
        • Run a specific rule for automated email processing
  • TenantInfo
    • Returns general information such as the TenantId and contact details of the client currently logged in.
    • This can be used to read out the client's currently set tariff, including all available modules and their functions contained in the tariff.
    • Returns general information about the tenants subscription.
  1. cobra CRM
  2. People360

Create a new person

POST
https://api.cobra.de/v1/crm/people
Last modified:2024-12-09 08:45:57

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
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
required
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 
required
The text associated with the important date.
>= 1 characters<= 200 characters
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
text
string  | null 
optional
<= 200 characters
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 
required
The lifecycle ID.
The other fields are automatically filled with values from the database.
Match pattern:
^([A-F]|[a-f]|[0-9]){24}$
Example

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.cobra.de/v1/crm/people' \
--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 ''

Responses

🟢201Created
application/json
Body
data
object (People) 
optional
Represents a DTO for a person.
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
id
string  | null 
optional
The ID of the person.
salutation
string  | null 
optional
The salutation of the person.
title
string  | null 
optional
The title of the person.
firstname
string  | null 
optional
The first name of the person.
lastname
string  | null 
optional
The last name of the person.
birthday
object (PeopleBirthdayDto) 
optional
importantDates
array[object (PeopleImportantDate) {2}]  | null 
optional
The List of important dates.
socialMedias
array[object (PeopleSocialMedia) {2}]  | null 
optional
The List of social media informations.
orgaTags
array[object (CobraTagForEmbeddedDto) {2}]  | null 
optional
The List of orga tags.
personalities
array[object (EmbeddedPersonality) {3}]  | null 
optional
The List of personalities.
customerNumber
string  | null 
optional
The customer number.
note
object (PeopleNote) 
optional
Transfer Object for representing a note associated with a person
cards
array[object (BusinessCard) {17}]  | null 
optional
The List of business cards.
relations
array[object (Relation) {2}]  | null 
optional
The List of relations.
userMail
string  | null 
optional
The email address of the user from user management.
Otherwise, the email address will be stored in a business card.
employeeStatus
string  | null 
optional
The employee status of the person.
userId
string <uuid> | null 
optional
User ID of the person, which is from user management.
lifecycle
object (PeopleLifecycleForOutput) 
optional
Output Object for lifecycle information
lifecycleHistories
array[object (PeopleLifecycleForOutput) {4}]  | null 
optional
The List of lifecycle histories associated with the people object.
profileImage
string  | null 
optional
The profile image of the person.
employeeNumber
string  | null 
optional
initials
string  | null 
read-onlyoptional
The initials of the person, generated from the first and last name.
detailImagePath
string  | null 
read-onlyoptional
The path to the detailed profile image of the person.
name
string  | null 
read-onlyoptional
Combination field: "Lastname, Firstname"
message
string  | null 
optional
metaData
object (ResponseMetaData) 
optional
totalResults
integer <int32>
optional
responseTimeStamp
string <date-time>
optional
statusCode
integer <int32>
optional
Example
{
  "data": {
    "createdBy": "string",
    "modifiedBy": "string",
    "dateCreated": "2019-08-24T14:15:22Z",
    "dateModified": "2019-08-24T14:15:22Z",
    "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
    "modifiedByUserId": "17fb13b8-2d9d-45c1-bbdd-46882998f972",
    "id": "string",
    "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": "string",
        "text": "string"
      }
    ],
    "personalities": [
      {
        "id": "string",
        "category": "string",
        "text": "string"
      }
    ],
    "customerNumber": "string",
    "note": {
      "note": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateModified": "2019-08-24T14:15:22Z",
      "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",
      "modifiedByUserId": "17fb13b8-2d9d-45c1-bbdd-46882998f972"
    },
    "cards": [
      {
        "isPrivate": true,
        "alternativeSalutation": "string",
        "alternativeTitle": "string",
        "alternativeFirstname": "string",
        "alternativeLastname": "string",
        "business": "string",
        "validFrom": "2019-08-24T14:15:22Z",
        "validTo": "2019-08-24T14:15:22Z",
        "phones": [
          {
            "isFavorite": true,
            "type": "string",
            "number": "string"
          }
        ],
        "emails": [
          {
            "type": {
              "id": "string",
              "text": "string"
            },
            "isFavorite": true,
            "mail": "string"
          }
        ],
        "businessPositions": [
          {
            "department": "string",
            "position": "string",
            "isFavorite": true
          }
        ],
        "addresses": [
          {
            "id": "string",
            "isFavorite": true,
            "type": "string",
            "addressTypes": [
              {
                "id": "string",
                "text": "string"
              }
            ],
            "country": "string",
            "countryCode": "string",
            "street": "string",
            "streetAdditional": "string",
            "zip": "string",
            "city": "string",
            "postboxNumber": "string",
            "federalState": "string",
            "coordinates": {
              "longitude": 0,
              "latitude": 0
            },
            "cityDistrict": "string",
            "cityAddition": "string",
            "validationInfo": {
              "status": "string",
              "deviation": 0,
              "lastValidationDate": "2019-08-24T14:15:22Z",
              "message": "string"
            }
          }
        ],
        "isFavorite": true,
        "isActive": true,
        "markAsFavorite": true,
        "useAlternativeName": true,
        "id": "string"
      }
    ],
    "relations": [
      {
        "type": {
          "typeIdentifier": "string",
          "isFavorite": true
        },
        "id": "string"
      }
    ],
    "userMail": "string",
    "employeeStatus": "string",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "lifecycle": {
      "lifecycleId": "string",
      "text": "string",
      "color": "string",
      "dateChanged": "2019-08-24T14:15:22Z"
    },
    "lifecycleHistories": [
      {
        "lifecycleId": "string",
        "text": "string",
        "color": "string",
        "dateChanged": "2019-08-24T14:15:22Z"
      }
    ],
    "profileImage": "string",
    "employeeNumber": "string",
    "initials": "string",
    "detailImagePath": "string",
    "name": "string"
  },
  "message": "string",
  "metaData": {
    "totalResults": 0,
    "responseTimeStamp": "2019-08-24T14:15:22Z"
  },
  "statusCode": 0
}
🟠400Bad Request
Modified at 2024-12-09 08:45:57
Previous
Retrieve a list of people
Next
Retrieve the details of an existing person by its ID
Built with