cobra CRM Cloud - API Docs
StartWebsitecobra Knowledge Portal
StartWebsitecobra Knowledge Portal
  1. Bookings
  • 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
      • Parse clipboard text to create a person
      • 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
      • Analytics
        • Counts how often a specific company appears in different touchpoints in the last 3 months.
        • Calculate the total turnover of a company over its entire history. The data of the turnover touchpoints will be evaluated. Different currencies are not taken into account. It is assumed that all entries have been made in one currency.
      • 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
        • Create one or more relation managed by people role entries
        • Delete multiple relation managed by people role entries from the list by their IDs
        • Delete a relation managed by people role entry from the list by its IDs
      • 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 logo provider service 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)
        POST
      • Gets a booking by its ID
        GET
      • Gets the confirmation infos for a successful booking (public)
        GET
      • Deletes an existing booking
        DELETE
      • Deletes a list of bookings
        DELETE
      • Calculates the current cancellation rules that apply when cancelling a booking including all tickets
        POST
      • Cancels a booking and all belonging tickets
        POST
      • Cancels a booking and all belonging tickets
        POST
      • Calculates the current cancellation rules that apply when cancelling a booking including all tickets
        GET
      • Sets the booker information for a booking
        POST
      • Sends an invoice mail to the booker
        POST
      • Sets the invoice number of an external booking
        POST
      • Change the status of a payment
        POST
      • Collects the booking history statistics for an event
        POST
      • Collects the booking history actions for an event
        POST
      • Looks for data inconsistency in a booking and executes reparations.
        POST
    • 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, using filter criteria.
      • 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, using filter criteria.
      • Sets information data for the invited person
      • Imports invitations from a file
      • Send an filtered invitation free e-mail to a list of persons to invite
      • 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 to a file
    • 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
      • Validates a website name
      • 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 Forms
    • Images
      • Uploads the header image for a form
      • Deletes the header image for a form
    • Responses
      • Gets a form response by its id
      • Deletes an existing form response
      • Deletes multiple existing form responses
      • Exports form responses as csv stream
      • Add custom integration data to a form response
      • Returns true and a message to display if a threshold of free responses has been used
    • Gets a form by its id
    • 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
  • 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.
  • TenantInfoSubscription
    • /tenant-info/subscriptions/payment/urls/checkout
    • Gets the checkout URL for a payment.
    • /tenant-info/subscriptions/payment/urls/customer-portal
    • Gets the customer portal URL.
    • Increases the quantity of a payment.
    • Gets the active subscriptions for the current tenant.
  • TenantInfoV
    • /v2/tenant-info/tariff
  1. Bookings

Sets the booker information for a booking

POST
https://api.cobra.de/v1/events/bookings/{id}/booker
Last modified:2025-07-14 18:05:38

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
a person, as used in create operations (bookings and invitations)
company
string  | null 
optional
Company.
Example:
Sample Company Ltd
department
string  | null 
optional
Company department.
Example:
Marketing
valueAddedTaxIDNumber
string  | null 
optional
Value added tax identification number (VATIN) needed for invoicing of companies.
Example:
DE 123456789
jobTitle
string  | null 
optional
Job Title.
Example:
CTO
salutation
string  | null 
optional
Salutation of contact.
Example:
Mrs
title
string  | null 
optional
Title of contact.
Example:
Dr.
firstName
string  | null 
optional
First name of contact.
Example:
Jane
lastName
string  | null 
optional
Last name of contact.
Example:
Doe
email
string  | null 
optional
E-Mail address.
Example:
j.doe@samplecompany.com
phone
string  | null 
optional
Phone number.
Example:
0049515498765402
countryCode
string  | null 
optional
The country code of the address, based on ISO 3166-1 Alpha-2 standard (two digits, Uppercase).
Example:
DE
address
string  | null 
optional
Address street / house number.
Example:
Sample Street 98
addressAdditional
string  | null 
optional
Additional address info.
Example:
appartment B
zipCode
string  | null 
optional
ZipCode.
Example:
12345
city
string  | null 
optional
City.
Example:
Town upon river
Example
{
    "company": "Sample Company Ltd",
    "department": "Marketing",
    "valueAddedTaxIDNumber": "DE 123456789",
    "jobTitle": "CTO",
    "salutation": "Mrs",
    "title": "Dr.",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "j.doe@samplecompany.com",
    "phone": "0049515498765402",
    "countryCode": "DE",
    "address": "Sample Street 98",
    "addressAdditional": "appartment B",
    "zipCode": "12345",
    "city": "Town upon river"
}

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 -g --request POST 'https://api.cobra.de/v1/events/bookings/{id}/booker' \
--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 '{
    "company": "Sample Company Ltd",
    "department": "Marketing",
    "valueAddedTaxIDNumber": "DE 123456789",
    "jobTitle": "CTO",
    "salutation": "Mrs",
    "title": "Dr.",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "j.doe@samplecompany.com",
    "phone": "0049515498765402",
    "countryCode": "DE",
    "address": "Sample Street 98",
    "addressAdditional": "appartment B",
    "zipCode": "12345",
    "city": "Town upon river"
}'

Responses

🟢200OK
application/json
Body
data
object (BookingObjectForDetailed) 
optional
DTO for displaying a booking.
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
invoiceAddress
object (PersonForDetailed) 
optional
detailed information for a person Cobra.EventPro.Booking.Shared.Api.DTOs.DetailedDTOs.PersonBaseDetailedDTO
booker
object (PersonForDetailed) 
optional
detailed information for a person Cobra.EventPro.Booking.Shared.Api.DTOs.DetailedDTOs.PersonBaseDetailedDTO
tickets
array[object (TicketForDetailed) {27}]  | null 
optional
The booked tickets.
miscellaneous
string  | null 
optional
The miscellaneous field for extra text input.
utmMedium
string  | null 
optional
The utmMedium parameter. Identifies what type of link was used, such as cost per click or email.
utmSource
string  | null 
optional
The utmSource parameter. Identifies which site sent the traffic.
utmCampaign
string  | null 
optional
The utmCampaign parameter. Identifies a specific product promotion or strategic campaign.
bookingConsentText
string  | null 
optional
The terms and conditions as text.
paymentInformation
object (PaymentInformation) 
optional
DTO for displaying the general payment infos of a booking.
orderNumber
string  | null 
read-onlyoptional
The order number of the booking.
registrationLink
string  | null 
read-onlyoptional
The registration url on the portal where the booked event is hosted.
portalUrl
string  | null 
read-onlyoptional
The portal where the booked event is hosted.
registrationDate
string <date-time> | null 
read-onlyoptional
The registration date of the booking.
cancellationSettings
object (CancellationInformationForDetailed) 
optional
DTO for displaying a booking.
customFieldAnswers
array[object (CustomFieldAnswer) {3}]  | null 
optional
[optional] list of answers to additional form fields
invitationId
string  | null 
optional
[optional] id of the invitation used for the booking
externalPaymentSettings
object (ExternalPaymentSettings) 
optional
DTO for displaying external payment settings for a booking.
message
string  | null 
optional
metaData
object (ResponseMetaData) 
optional
totalResults
integer <int32>
optional
responseTimeStamp
string <date-time>
optional
statusCode
integer <int32>
optional
Example
{
    "data": {
        "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",
        "invoiceAddress": {
            "company": "Sample Company Ltd",
            "department": "Marketing",
            "valueAddedTaxIDNumber": "DE 123456789",
            "jobTitle": "CTO",
            "salutation": "Mrs",
            "title": "Dr.",
            "firstName": "Jane",
            "lastName": "Doe",
            "email": "j.doe@samplecompany.com",
            "phone": "0049515498765402",
            "countryCode": "DE",
            "address": "Sample Street 98",
            "addressAdditional": "appartment B",
            "zipCode": "12345",
            "city": "Town upon river",
            "countryLocalized": "string",
            "name": "string",
            "peopleID": "string",
            "businessCardID": "string"
        },
        "booker": {
            "company": "Sample Company Ltd",
            "department": "Marketing",
            "valueAddedTaxIDNumber": "DE 123456789",
            "jobTitle": "CTO",
            "salutation": "Mrs",
            "title": "Dr.",
            "firstName": "Jane",
            "lastName": "Doe",
            "email": "j.doe@samplecompany.com",
            "phone": "0049515498765402",
            "countryCode": "DE",
            "address": "Sample Street 98",
            "addressAdditional": "appartment B",
            "zipCode": "12345",
            "city": "Town upon river",
            "countryLocalized": "string",
            "name": "string",
            "peopleID": "string",
            "businessCardID": "string"
        },
        "tickets": [
            {
                "ticketId": "string",
                "eventId": "string",
                "eventName": "string",
                "ticketCategoryId": "string",
                "ticketName": "string",
                "description": "string",
                "price": 0,
                "netPrice": 0,
                "taxRateDetails": {
                    "databaseId": "string",
                    "countryCode": "string",
                    "taxRateId": "string"
                },
                "priceID": "string",
                "currency": "string",
                "startDate": "2019-08-24T14:15:22Z",
                "endDate": "2019-08-24T14:15:22Z",
                "location": "string",
                "eventSeries": "string",
                "eventNumber": "string",
                "eventCategory": "string",
                "isUsed": true,
                "registrationPlatform": "string",
                "statusLocalized": "string",
                "status": 0,
                "paymentItemInformation": {
                    "lineItemID": "string",
                    "productID": "string",
                    "basePrice": 0,
                    "discounts": [
                        {
                            "discountAmount": 0,
                            "currency": "string",
                            "couponID": "string"
                        }
                    ],
                    "actualPrice": 0
                },
                "participant": {
                    "company": "Sample Company Ltd",
                    "department": "Marketing",
                    "valueAddedTaxIDNumber": "DE 123456789",
                    "jobTitle": "CTO",
                    "salutation": "Mrs",
                    "title": "Dr.",
                    "firstName": "Jane",
                    "lastName": "Doe",
                    "email": "j.doe@samplecompany.com",
                    "phone": "0049515498765402",
                    "countryCode": "DE",
                    "address": "Sample Street 98",
                    "addressAdditional": "appartment B",
                    "zipCode": "12345",
                    "city": "Town upon river",
                    "countryLocalized": "string",
                    "name": "string",
                    "peopleID": "string",
                    "businessCardID": "string"
                },
                "onlineDetailParticipationLink": "string",
                "participantLink": "string",
                "integrationDataList": [
                    {
                        "key": "string",
                        "value": {
                            "integrationName": "string",
                            "status": 0,
                            "link": "string",
                            "payload": "string",
                            "message": "string",
                            "statusLocalized": "string"
                        }
                    }
                ],
                "customFieldAnswers": [
                    {
                        "label": "string",
                        "kind": "string",
                        "answer": "string"
                    }
                ]
            }
        ],
        "miscellaneous": "string",
        "utmMedium": "string",
        "utmSource": "string",
        "utmCampaign": "string",
        "bookingConsentText": "string",
        "paymentInformation": {
            "paymentType": 0,
            "paymentTypeLocalized": "string",
            "paymentStatus": 0,
            "paymentStatusLocalized": "string",
            "invoiceNumber": "string",
            "onlinePaymentInformation": {
                "paymentIntentID": "string",
                "checkoutSessionID": "string",
                "invoiceAmount": 0,
                "totalDiscount": 0,
                "paymentMethod": "string",
                "paymentMethodLocalized": "string",
                "paymentDate": "2019-08-24T14:15:22Z",
                "invoiceUrl": "string",
                "invoiceFileUrl": "string"
            }
        },
        "orderNumber": "string",
        "registrationLink": "string",
        "portalUrl": "string",
        "registrationDate": "2019-08-24T14:15:22Z",
        "cancellationSettings": {
            "cancellationReason": 0,
            "fullRefundOverride": true,
            "totalRefund": 0,
            "cancellationDate": "2019-08-24T14:15:22Z"
        },
        "customFieldAnswers": [
            {
                "label": "string",
                "kind": "string",
                "answer": "string"
            }
        ],
        "invitationId": "string",
        "externalPaymentSettings": {
            "externalInvoiceEmailAddress": "string",
            "sendTicketOnInvoice": true
        }
    },
    "message": "string",
    "metaData": {
        "totalResults": 0,
        "responseTimeStamp": "2019-08-24T14:15:22Z"
    },
    "statusCode": 0
}
🟠400Bad Request
🟠404Not Found
Modified at 2025-07-14 18:05:38
Previous
Calculates the current cancellation rules that apply when cancelling a booking including all tickets
Next
Sends an invoice mail to the booker
Built with