cobra CRM Cloud - API Docs
StartWebsitecobra Knowledge Portal
StartWebsitecobra Knowledge Portal
  1. cobra Event
  • 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. If the address to be updated is the new favorite, the old favorite will lose its favorite status. If the previous favorite is updated and should no longer be a favorite, then there is no longer
        • Delete an address from a specific business card of a person by its address ID. If the favorite address is deleted and only one other address remains, this address becomes the new favorite. Otherwise, no new favorite is set
        • Create a new address in a person's existing business card. If the address to be created becomes the new favorite, the old favorite will lose its status as a favorite
        • Update an existing business card of a specific person by the business card ID. If the person does not yet have a favorite business card and the business card to be updated does not explicitly have a favorite status, then the last updated business card (
        • 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. If the person does not yet have a favorite business card and the business card to be created does not explicitly have a favorite status, then the latest business card (this) is declared as the new favor
        • 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
        • Connects a persons business card with a company. The business card must not be private.
        • Retrieve an existing person's business card as a vCard (.vcf)
        • Validates a business card before it is created or updated.
      • 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
        • Validates a relation before it is created or updated.
      • 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
        • Create one or more new company relation types
        • Delete multiple company relation types from the list by their IDs
        • Delete an company relation 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
      • Retrieve a list of people
      • Create a new person
      • Retrieve the details of an existing person by its ID
      • Update an existing person by its ID
      • Delete a person by its ID
      • Retrieve a quicklook of an existing person by its ID
      • Update one or more existing people
      • Create one or more people
      • Delete multiple people by their IDs
      • Update the note on a person by its ID
      • Update the list of orga tags on a person by its ID (the list will be overwrite)
      • Update the list of personality tags on a person by its ID (the list will be overwrite)
      • Update the lifecycle on a person by its ID
      • Validates a person.
      • Retrieve all type of profile images for a person by its ID
      • Upload a replacement profile image for a person by its ID
      • Delete the profile image of a person by its ID
    • 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
        • Create one or more new email address types
        • Delete multiple email address types from the list by their IDs
        • Delete an email address type 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
      • PeopleRelations
        • Create a new managed by person relation between a person and a company.
        • Creates new managed by person relations between persons and a company.
        • Updates managed by person relations between persons and a company
        • Deletes managed by person relations.
        • Updates a managed by person relation between a person and a company.
        • Deletes a managed by person relation.
      • Create a new address for an existing company If the entry to be created is marked as a favorite, the previous favorite loses its status. If no address has been marked as a favorite, an attempt is made to automatically determine the favorite based on the
      • Update an existing address of a specific company by its ID If the entry to be updated is marked as a favorite, the previous favorite loses its status. If no address has been marked as a favorite, an attempt is made to automatically determine the favorit
      • Delete an address from a specific company by its ID If the entry to be deleted is marked as a favorite, a new favorite ist determined. If no address has been marked as a favorite, an attempt is made to automatically determine the favorite based on the a
      • Perform an input validation without changing the dataset or creating a company address in the database (calculated fields are returned).
      • 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 new phone numbers to an existing company. If the entry to be created is marked as a favorite, the previous favorite loses its status. If no phone has been marked as a favorite, an attempt is made to automatically determine the favorite based on the
      • Update an existing phone number of a specific company by its ID
      • Update existing phone numbers of a specific company by its ID. If the entry to be updated is marked as a favorite, the previous favorite loses its status. If no phone has been marked as a favorite, an attempt is made to automatically determine the favor
      • Delete a phone number form a specific company by its ID. If the entry to be deleted is marked as a favorite, a new favorite is determined. If no phone has been marked as a favorite, an attempt is made to automatically determine the favorite based on the
      • Perform an input validation without changing the data set or creating a company in the database (calculated fields are returned)
      • Update an existing e-mail address of a specific company by its ID
      • Perform an input validation without changing the data set or creating a company phone in the database
      • Add new e-mail addresses to an existing company. If the entry to be created is marked as a favorite, the previous favorite loses its status. If no mail has been marked as a favorite, an attempt is made to automatically determine the favorite based on th
      • Update existing e-mail addresses of a specific company by its ID. If the entry to be updated is marked as a favorite, the previous favorite loses its status. If no e-mail has been marked as a favorite, the first available element is selected
      • Delete an e-mail address form a specific company by its ID. If the entry to be deleted is marked as a favorite, a new favorite is determined. If no e-mail has been marked as a favorite, the first available element is selected
  • 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
      • Looks for data inconsistency in a booking and executes reparations.
    • 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
      GET
    • Updates an existing event
      PUT
    • Deletes an existing event
      DELETE
    • Creates a new event
      POST
    • Deletes a list of events
      DELETE
    • Validates an event
      POST
    • Get event as iCal format
      GET
    • Duplicates an event
      POST
    • Updates the note of an event
      PUT
    • Updates the publication of an event
      PUT
    • Validates the publication of an event
      POST
  • cobra Form
    • FatClient integration
      • Gets the fat client integration configuration for a form
      • Updates the fat client integration configuration for a form
      • Validates the fat client integration configuration
    • Images
      • Uploads the header image for a form
      • Deletes the header image for a form
    • Responses
      • Gets a form response by its id
      • Submits a response (public)
      • Deletes an existing form response
      • Validates a response (public)
      • Deletes multiple existing form responses
      • Exports form responses as csv stream
      • Add custom integration data to a form response
    • Settings
      • Images
        • Uploads the light color logo image for the form settings
        • Deletes the light color logo image for the form settings
        • Uploads the dark color logo image for the form settings
        • Deletes the dark color logo image for the form settings
      • Gets the form settings
      • Updates the form settings
      • Validates form settings
    • Gets a form by its id
    • Gets a form by its url (public)
    • Patches fields for a form
    • Updates an existing form
    • Deletes an existing form
    • Creates a new form
    • Deletes a list of forms
    • Validates a form
    • Duplicates a form
    • Enables or disables the publication of a form
    • Creates a form with the magical power of AI
    • Modifies a form with the magical power of AI
  • 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 Event

Validates an event

POST
https://api.cobra.de/v1/events/validation
Last modified:2025-05-14 11:30:34

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
name
string  | null 
optional
<= 100 characters
series
string  | null 
optional
eventNumber
string  | null 
optional
category
object (EventCategoryEmbedded) 
optional
id
string  | null 
optional
ID of the event category
name
string  | null 
optional
<= 100 characters
colorCode
string  | null 
optional
description
string  | null 
optional
orgaTags
array[object (CobraTagForEmbeddedDto) {2}]  | null 
optional
id
string  | null 
optional
Gets or sets the identifier for the entity.
Example:
123456789012345678901234
text
string  | null 
optional
Gets or sets the Text.
Example:
SomeTag
portalTags
array[object (CobraTagForEmbeddedDto) {2}]  | null 
optional
id
string  | null 
optional
Gets or sets the identifier for the entity.
Example:
123456789012345678901234
text
string  | null 
optional
Gets or sets the Text.
Example:
SomeTag
contributors
array[object (Contributor) {4}]  | null 
optional
firstName
string  | null 
optional
<= 100 characters
lastName
string  | null 
optional
<= 100 characters
email
string  | null 
optional
role
object (ContributorRoleEmbedded) 
optional
contributor role when used embedded in a contributor
shortInfo
string  | null 
optional
description
string  | null 
optional
note
object (EventNoteForCreate) 
optional
note
string  | null 
optional
eventReminderSettings
object (EventReminderSettingsForCreate) 
optional
fiveDays
boolean  | null 
optional
oneDay
boolean  | null 
optional
twoHours
boolean  | null 
optional
eventPaymentMethodSettings
object (EventPaymentMethodSettingsForCreate) 
optional
paymentMethod
integer <int32>
optional
sendTicketOnInvoice
boolean  | null 
optional
email
string  | null 
optional
registrationSettings
object (RegistrationConfigForCreate) 
optional
registrationPlatform
enum<integer> <int32>
optional
Allowed values:
012345
externalRegistrationLink
string  | null 
optional
registrationForm
enum<integer> <int32>
optional
Allowed values:
01234
minAttendees
integer <int32> | null 
optional
maxAttendees
integer <int32> | null 
optional
ticketCategories
array[object (TicketCategoryForCreate) {6}]  | null 
optional
registrationDeadline
string <date-time> | null 
optional
currency
string  | null 
optional
cancellationOptions
object (CancellationConditionEmbedded) 
optional
Cancellation conditions when embedded in another object
selfCancelEnabled
boolean  | null 
optional
Are bookers allowed to cancel their own bookings? If false or unset, only cobra registered users can cancel a booking
Example:
false
customFieldSets
array[string] | null 
optional
List of of additional field collections to add to the booking form.
For now: only 1 set possible
enableQrCodes
boolean  | null 
optional
Are QR codes enabled for this event as access control?
displayNetPrice
boolean  | null 
optional
Should the net price of tickets be displayable?
taxRate
object (TaxRateForEmbeded) 
optional
id
string  | null 
optional
Gets or sets the identifier for the entity.
Example:
123456789012345678901234
createdBy
string  | null 
optional
Gets or sets the name of the user who created the entity, if available.
Example:
Username
modifiedBy
string  | null 
optional
Gets or sets the name of the user who last modified the entity, if available.
Example:
Username
dateCreated
string <date-time> | null 
optional
Gets or sets the date and time when the entity was created, if available.
Example:
2024-02-19T08:57:43.041Z
dateModified
string <date-time> | null 
optional
Gets or sets the date and time when the entity was last modified, if available.
Example:
2024-02-19T08:57:43.041Z
createdByUserId
string <uuid> | null 
optional
Gets or sets the ID of the user who created the entity, if available.
Example:
c0316f28-4d2d-4c79-b5fc-bd25f2bca40c
modifiedByUserId
string <uuid> | null 
optional
Gets or sets the ID of the user who last modified the entity, if available.
Example:
c0316f28-4d2d-4c79-b5fc-bd25f2bca40c
name
string  | null 
optional
<= 100 characters
countryCode
string  | null 
optional
percent
number <double> | null 
optional
taxRateId
string  | null 
optional
Id of the counterpart in the payment service (StripeId).
address
object (EventLocationForCreate) 
optional
name
string  | null 
optional
address
string  | null 
optional
addressAdditional
string  | null 
optional
zipCode
string  | null 
optional
city
string  | null 
optional
countryCode
string  | null 
optional
The country code of the address, based on ISO 3166-1 Alpha-2 standard (two digits, Uppercase).
geocoordinates
string  | null 
optional
onlineDetails
object (OnlineMeeting) 
optional
platform
object (OnlineMeetingPlatformForDetailed) 
optional
link
string  | null 
optional
accessCode
string  | null 
optional
calendar
object (EventCalendar) 
optional
startDateTime
string <date-time> | null 
optional
endDateTime
string <date-time> | null 
optional
timeZoneId
string  | null 
optional
Timezone ID in IANA-format. [Required]
isIndividualTimes
boolean  | null 
optional
displayAppointmentList
boolean  | null 
optional
Bool that determines if the appointment list should be displayed in mail, the booking page and the detail page.
appointments
array[object (Appointment) {5}]  | null 
optional
publicationSettings
object (PublicationConfigForCreate) 
optional
startDateTime
string <date-time> | null 
optional
endDateTime
string <date-time> | null 
optional
isActivated
boolean  | null 
optional
isPublic
boolean  | null 
optional
portals
array[object (EventPortalForCreate) {1}]  | null 
optional
imageCollection
object (EventImageCollectionForCreate) 
optional
DTO for the creation of an new EventImageCollection
hasMobileAlternative
boolean  | null 
optional
Defines if an alternative header image should be used for mobile.
contactPersonSettings
object (ContactPersonConfigForCreate) 
optional
showBanner
boolean  | null 
optional
contact
object (ContactPersonForCreate) 
optional
emailSettings
object (EmailConfig) 
optional
formOfAddress
enum<integer> <int32>
optional
Allowed values:
01
signature
string  | null 
optional
Example
{
  "name": "string",
  "series": "string",
  "eventNumber": "string",
  "category": {
    "id": "string",
    "name": "string",
    "colorCode": "string",
    "description": "string"
  },
  "orgaTags": [
    {
      "id": "123456789012345678901234",
      "text": "SomeTag"
    }
  ],
  "portalTags": [
    {
      "id": "123456789012345678901234",
      "text": "SomeTag"
    }
  ],
  "contributors": [
    {
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "role": {
        "id": "63a03a146d4676e52f0767c9",
        "name": "Moderator",
        "description": "string"
      }
    }
  ],
  "shortInfo": "string",
  "description": "string",
  "note": {
    "note": "string"
  },
  "eventReminderSettings": {
    "fiveDays": true,
    "oneDay": true,
    "twoHours": true
  },
  "eventPaymentMethodSettings": {
    "paymentMethod": 0,
    "sendTicketOnInvoice": true,
    "email": "string"
  },
  "registrationSettings": {
    "registrationPlatform": 0,
    "externalRegistrationLink": "string",
    "registrationForm": 0,
    "minAttendees": 0,
    "maxAttendees": 0,
    "ticketCategories": [
      {
        "ticketId": "string",
        "name": "string",
        "price": 0,
        "maxTickets": 0,
        "isOnSale": true,
        "description": "string"
      }
    ],
    "registrationDeadline": "2019-08-24T14:15:22Z",
    "currency": "string",
    "cancellationOptions": {
      "id": "63204ced0e05f277f3cc3ebf",
      "name": "Standard",
      "fixedFee": 15,
      "cancellationRules": [
        {
          "startDay": 0,
          "endDay": 0,
          "percent": 0
        }
      ]
    },
    "selfCancelEnabled": false,
    "customFieldSets": [
      "string"
    ],
    "enableQrCodes": true,
    "displayNetPrice": true
  },
  "taxRate": {
    "id": "123456789012345678901234",
    "createdBy": "Username",
    "modifiedBy": "Username",
    "dateCreated": "2024-02-19T08:57:43.041Z",
    "dateModified": "2024-02-19T08:57:43.041Z",
    "createdByUserId": "c0316f28-4d2d-4c79-b5fc-bd25f2bca40c",
    "modifiedByUserId": "c0316f28-4d2d-4c79-b5fc-bd25f2bca40c",
    "name": "string",
    "countryCode": "string",
    "percent": 0,
    "taxRateId": "string"
  },
  "address": {
    "name": "string",
    "address": "string",
    "addressAdditional": "string",
    "zipCode": "string",
    "city": "string",
    "countryCode": "string",
    "geocoordinates": "string"
  },
  "onlineDetails": {
    "platform": {
      "id": "string",
      "name": "string"
    },
    "link": "string",
    "accessCode": "string"
  },
  "calendar": {
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z",
    "timeZoneId": "string",
    "isIndividualTimes": true,
    "displayAppointmentList": true,
    "appointments": [
      {
        "date": "\"0001-01-01\"",
        "timeFrom": "\"PT00H00M00S\"",
        "timeTo": "\"PT00H00M00S\"",
        "isAllDay": true,
        "isFreeDay": true
      }
    ]
  },
  "publicationSettings": {
    "startDateTime": "2019-08-24T14:15:22Z",
    "endDateTime": "2019-08-24T14:15:22Z",
    "isActivated": true,
    "isPublic": true,
    "portals": [
      {
        "portalId": "string"
      }
    ]
  },
  "imageCollection": {
    "hasMobileAlternative": true
  },
  "contactPersonSettings": {
    "showBanner": true,
    "contact": {
      "usedTemplateId": "string",
      "name": "string",
      "position": "string",
      "phone": "string",
      "email": "string",
      "header": "string",
      "subHeader": "string",
      "shortInfo": "string"
    }
  },
  "emailSettings": {
    "formOfAddress": 0,
    "signature": "string"
  }
}

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/events/validation' \
--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 '{
    "name": "string",
    "series": "string",
    "eventNumber": "string",
    "category": {
        "id": "string",
        "name": "string",
        "colorCode": "string",
        "description": "string"
    },
    "orgaTags": [
        {
            "id": "123456789012345678901234",
            "text": "SomeTag"
        }
    ],
    "portalTags": [
        {
            "id": "123456789012345678901234",
            "text": "SomeTag"
        }
    ],
    "contributors": [
        {
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "role": {
                "id": "63a03a146d4676e52f0767c9",
                "name": "Moderator",
                "description": "string"
            }
        }
    ],
    "shortInfo": "string",
    "description": "string",
    "note": {
        "note": "string"
    },
    "eventReminderSettings": {
        "fiveDays": true,
        "oneDay": true,
        "twoHours": true
    },
    "eventPaymentMethodSettings": {
        "paymentMethod": 0,
        "sendTicketOnInvoice": true,
        "email": "string"
    },
    "registrationSettings": {
        "registrationPlatform": 0,
        "externalRegistrationLink": "string",
        "registrationForm": 0,
        "minAttendees": 0,
        "maxAttendees": 0,
        "ticketCategories": [
            {
                "ticketId": "string",
                "name": "string",
                "price": 0,
                "maxTickets": 0,
                "isOnSale": true,
                "description": "string"
            }
        ],
        "registrationDeadline": "2019-08-24T14:15:22Z",
        "currency": "string",
        "cancellationOptions": {
            "id": "63204ced0e05f277f3cc3ebf",
            "name": "Standard",
            "fixedFee": 15,
            "cancellationRules": [
                {
                    "startDay": 0,
                    "endDay": 0,
                    "percent": 0
                }
            ]
        },
        "selfCancelEnabled": false,
        "customFieldSets": [
            "string"
        ],
        "enableQrCodes": true,
        "displayNetPrice": true
    },
    "taxRate": {
        "id": "123456789012345678901234",
        "createdBy": "Username",
        "modifiedBy": "Username",
        "dateCreated": "2024-02-19T08:57:43.041Z",
        "dateModified": "2024-02-19T08:57:43.041Z",
        "createdByUserId": "c0316f28-4d2d-4c79-b5fc-bd25f2bca40c",
        "modifiedByUserId": "c0316f28-4d2d-4c79-b5fc-bd25f2bca40c",
        "name": "string",
        "countryCode": "string",
        "percent": 0,
        "taxRateId": "string"
    },
    "address": {
        "name": "string",
        "address": "string",
        "addressAdditional": "string",
        "zipCode": "string",
        "city": "string",
        "countryCode": "string",
        "geocoordinates": "string"
    },
    "onlineDetails": {
        "platform": {
            "id": "string",
            "name": "string"
        },
        "link": "string",
        "accessCode": "string"
    },
    "calendar": {
        "startDateTime": "2019-08-24T14:15:22Z",
        "endDateTime": "2019-08-24T14:15:22Z",
        "timeZoneId": "string",
        "isIndividualTimes": true,
        "displayAppointmentList": true,
        "appointments": [
            {
                "date": "\"0001-01-01\"",
                "timeFrom": "\"PT00H00M00S\"",
                "timeTo": "\"PT00H00M00S\"",
                "isAllDay": true,
                "isFreeDay": true
            }
        ]
    },
    "publicationSettings": {
        "startDateTime": "2019-08-24T14:15:22Z",
        "endDateTime": "2019-08-24T14:15:22Z",
        "isActivated": true,
        "isPublic": true,
        "portals": [
            {
                "portalId": "string"
            }
        ]
    },
    "imageCollection": {
        "hasMobileAlternative": true
    },
    "contactPersonSettings": {
        "showBanner": true,
        "contact": {
            "usedTemplateId": "string",
            "name": "string",
            "position": "string",
            "phone": "string",
            "email": "string",
            "header": "string",
            "subHeader": "string",
            "shortInfo": "string"
        }
    },
    "emailSettings": {
        "formOfAddress": 0,
        "signature": "string"
    }
}'

Responses

🟢200OK
application/json
Body
data
object (EventForDetailedValidationResult) 
optional
Result of the Validation command.
model
object (EventForDetailed) 
optional
Short version of the event dto
isValid
boolean 
optional
Indicates if the validation was successful. [Default true]
message
string  | null 
optional
metaData
object (ResponseMetaData) 
optional
totalResults
integer <int32>
optional
responseTimeStamp
string <date-time>
optional
statusCode
integer <int32>
optional
Example
{
  "data": {
    "model": {
      "id": "string",
      "name": "string",
      "registrationSettings": {
        "registrationPlatform": 0,
        "externalRegistrationLink": "string",
        "registrationForm": 0,
        "minAttendees": 0,
        "maxAttendees": 0,
        "ticketCategories": [
          {
            "ticketId": "string",
            "name": "string",
            "price": 0,
            "maxTickets": 0,
            "isOnSale": true,
            "description": "string",
            "bookedTickets": 0,
            "netPrice": 0
          }
        ],
        "registrationDeadline": "2019-08-24T14:15:22Z",
        "currency": "string",
        "cancellationOptions": {
          "id": "string",
          "name": "string",
          "fixedFee": 0,
          "cancellationRules": [
            {
              "startDay": 0,
              "endDay": 0,
              "percent": 0
            }
          ]
        },
        "selfCancelEnabled": false,
        "pricing": "string",
        "attendeesCount": 0,
        "minActivePrice": 0,
        "customFieldSets": [
          "string"
        ],
        "displayNetPrice": false
      },
      "taxRate": {
        "name": "string",
        "countryCode": "string",
        "percent": 0,
        "id": "string"
      },
      "category": {
        "id": "string",
        "name": "string",
        "colorCode": "string"
      },
      "series": "string",
      "eventNumber": "string",
      "publicationSettings": {
        "startDateTime": "2019-08-24T14:15:22Z",
        "endDateTime": "2019-08-24T14:15:22Z",
        "isActivated": true,
        "isPublic": true
      },
      "portalTags": [
        {
          "id": "123456789012345678901234",
          "text": "SomeTag"
        }
      ],
      "shortInfo": "string",
      "description": "string",
      "address": {
        "name": "string",
        "address": "string",
        "addressAdditional": "string",
        "zipCode": "string",
        "city": "string",
        "countryCode": "string",
        "geocoordinates": "string",
        "countryLocalized": "string"
      },
      "onlineDetails": {
        "platform": {
          "id": "string",
          "name": "string"
        },
        "link": "string",
        "accessCode": "string"
      },
      "calendar": {
        "startDateTime": "2019-08-24T14:15:22Z",
        "endDateTime": "2019-08-24T14:15:22Z",
        "timeZoneId": "string",
        "isIndividualTimes": true,
        "displayAppointmentList": true,
        "appointments": [
          {
            "date": "\"0001-01-01\"",
            "timeFrom": "\"PT00H00M00S\"",
            "timeTo": "\"PT00H00M00S\"",
            "isAllDay": true,
            "isFreeDay": true
          }
        ]
      },
      "contactPersonSettings": {
        "showBanner": true,
        "contact": {
          "name": "string",
          "position": "string",
          "phone": "string",
          "email": "string",
          "header": "string",
          "subHeader": "string",
          "shortInfo": "string",
          "imageURL": "string"
        }
      },
      "emailSettings": {
        "formOfAddress": 0,
        "signature": "string"
      },
      "imageCollection": {
        "hasMobileAlternative": true,
        "eventImageObjects": [
          {
            "name": "string",
            "alternativeText": "string",
            "imageType": 0,
            "imageUrl": "string",
            "width": 0,
            "height": 0
          }
        ]
      },
      "fileCollection": [
        {
          "fileUrl": "string",
          "displayName": "string"
        }
      ],
      "eventLink": "string",
      "locationInfo": "string",
      "eventPaymentMethodSettings": {
        "paymentMethod": 0,
        "sendTicketOnInvoice": true
      }
    },
    "isValid": true
  },
  "message": "string",
  "metaData": {
    "totalResults": 0,
    "responseTimeStamp": "2019-08-24T14:15:22Z"
  },
  "statusCode": 0
}
Previous
Deletes a list of events
Next
Get event as iCal format
Built with