Creates a new invitation for an event - cobra CRM Cloud

Request

Header Params

X-Integration-Name

string

required

Integration name

Example:

API Documentation

X-Integration-Provider

string

required

Integration provider

Example:

cobra GmbH

X-Cobra-TenantId

string

required

Tenant ID

Example:

12e39e53-ece1-4d8d-8958-e782de1dbef0

X-Integration-Contact

string

optional

Integration contact

Example:

info@cobra.de

Accept-Language

string

optional

Example:

Body Params application/json

properties to create an invitation to an event.

invitee

object (InviteeForCreate)

optional

Invited person information

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

string | null

optional

E-Mail address.

<= 320 characters

Example:

j.doe@samplecompany.com

Match pattern:

^[a-zäöüA-ZÄÖÜ0-9!#$%&'*+\/=?^_`{|}~-]+(\.[a-zäöüA-ZÄÖÜ0-9!#$%&'*+\/=?^_`{|}~-]+)*@([a-zäöüA-ZÄÖÜ0-9]([a-zäöüA-ZÄÖÜ0-9-]*[a-zäöüA-ZÄÖÜ0-9])?\.)+[a-zA-Z0-9]{2,20}$

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:

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

portalId

string | null

optional

[Required] id of the website where the event is published.

Example:

663538c523034a3be3e09236

eventId

string | null

optional

[Required] id of the event.

Example:

663538c523034a3be3e09236

ticketCategoryId

string | null

optional

[optional] id of the ticket category.

if the ticket category id is specified, only this kind of ticket can be booked by the person invited,

if it is null, the person invited can select the kind of ticket to book

Example:

1f6816e7-9ded-4b9e-9191-730c266f3878

useDirectBooking

boolean | null

optional

[Required] if true, the accept link will redirect directly to the booking form, if false it will redirect to the event details page

Example:

true

Example

{
    "invitee": {
        "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"
    },
    "portalId": "663538c523034a3be3e09236",
    "eventId": "663538c523034a3be3e09236",
    "ticketCategoryId": "1f6816e7-9ded-4b9e-9191-730c266f3878",
    "useDirectBooking": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Body

data

object (InvitationDetailed)

optional

details of an invitation to an event

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

invitee

object (InviteeDetailed)

optional

Detailed information about a person invited to an event

portalId

string | null

optional

[Required] id of the website where the event is published.

Example:

663538c523034a3be3e09236

eventId

string | null

optional

[Required] id of the event

Example:

663538c523034a3be3e09236

ticketCategoryId

string | null

optional

[optional] id of the ticket category.

if the ticket category id is specified, only this kind of ticket can be booked by the person invited,

if it is null, the person invited can select the kind of ticket to book

Example:

1f6816e7-9ded-4b9e-9191-730c266f3878

useDirectBooking

boolean | null

optional

[Required] if true, the accept link will redirect directly to the booking form, if false it will redirect to the event details page

Example:

true

status

enum<integer> <int32>

optional

Allowed values:

0128

statusLocalized

string | null

read-onlyoptional

invitation status localized text

Example:

Eingeladen

acceptLink

string | null

read-onlyoptional

link to accept the invitation

depends on the UseDirectBooking property and the type of event

Example:

https://ourdomain.unsere-events.de/webseminar-marketing/662f65c9181b5c06beb1fbc3/66017bc6af5bd94cfcde5faa

rejectLink

string | null

read-onlyoptional

link to refuse the invitation

Example:

https://ourdomain.unsere-events.de/webseminar-marketing/662f65c9181b5c06beb1fbc3/absage/66017bc6af5bd94cfcde5faa/

linksSuffix

string | null

read-onlyoptional

part of url for this invitation, add to the booking page to reach the special page for the invitee

Example:

66017bc6af5bd94cfcde5faa

registrationLink

string | null

read-onlyoptional

registration link on the portal (used as basis for the accept and reject links)

Example:

https://ourdomain.unsere-events.de/webseminar-marketing/662f65c9181b5c06beb1fbc3

importFile

string | null

read-onlyoptional

source of the invitation, only filled when imported from a file, empty if the invitation was created manually

Example:

ExportedAddressList.csv

eventName

string | null

read-onlyoptional

name of the event

Example:

Webseminar Marketing

ticketCategoryName

string | null

read-onlyoptional

name of the ticket category

Example:

standard

ticketCategoryDescription

string | null

read-onlyoptional

description of the ticket category

Example:

standard ticket, including lunch voucher

portalHostname

string | null

read-onlyoptional

hostname of the portal

Example:

ourdomain.unsere-events.de

invitationEmail

object (EmailAction)

optional

information related to sending an email

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",
        "invitee": {
            "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"
        },
        "portalId": "663538c523034a3be3e09236",
        "eventId": "663538c523034a3be3e09236",
        "ticketCategoryId": "1f6816e7-9ded-4b9e-9191-730c266f3878",
        "useDirectBooking": true,
        "status": 0,
        "statusLocalized": "Eingeladen",
        "acceptLink": "https://ourdomain.unsere-events.de/webseminar-marketing/662f65c9181b5c06beb1fbc3/66017bc6af5bd94cfcde5faa",
        "rejectLink": "https://ourdomain.unsere-events.de/webseminar-marketing/662f65c9181b5c06beb1fbc3/absage/66017bc6af5bd94cfcde5faa/",
        "linksSuffix": "66017bc6af5bd94cfcde5faa",
        "registrationLink": "https://ourdomain.unsere-events.de/webseminar-marketing/662f65c9181b5c06beb1fbc3",
        "importFile": "ExportedAddressList.csv",
        "eventName": "Webseminar Marketing",
        "ticketCategoryName": "standard",
        "ticketCategoryDescription": "standard ticket, including lunch voucher",
        "portalHostname": "ourdomain.unsere-events.de",
        "invitationEmail": {
            "emailDateTime": "2024-02-19T08:57:43.041Z",
            "username": "Username",
            "userId": "c0316f28-4d2d-4c79-b5fc-bd25f2bca40c",
            "status": 0,
            "statusLocalized": "Email message sent successfully"
        }
    },
    "message": "string",
    "metaData": {
        "totalResults": 0,
        "responseTimeStamp": "2019-08-24T14:15:22Z"
    },
    "statusCode": 0
}

🟠400Bad Request