Event Types
Get event types
This endpoint retrieves event types of your account.
Parameters
HTTP Headers
| Name | Description |
|---|---|
| Authorization | An authorisation header containing meta information, see OAuth2 |
Query Parameters
| Name | Description |
|---|---|
| name | The name of a specific event type to filter for. |
Responses
200 - The event types of your account.
| Name | Description |
|---|---|
| application/json | EventTypeDto |
|
|
|
400 - Bad Request
| Name | Description |
|---|---|
| application/json | ClientErrorDto |
|
|
|
401 - Unauthorized
Create an event type
This endpoint creates a new event type representing a touchpoint along your customer journey.
Please contact us in case you are unsure adding more event types!
Parameters
HTTP Headers
| Name | Description |
|---|---|
| Authorization | An authorisation header containing meta information, see OAuth2. |
Body
| Content-Type | Type |
|---|---|
| application/json | EventTypePostDto |
|
|
|
Responses
201 - The created event type.
| Name | Description |
|---|---|
| application/json | EventTypeDto |
|
|
|
400 - Bad Request
| Name | Description |
|---|---|
| application/json | ClientErrorDto |
|
|
|
401 - Unauthorized
409 - Conflict
| Name | Description |
|---|---|
| application/json | ClientErrorDto |
|
|
|
Get an event type by ID
This endpoint retrieves an event type by its UUID.
Parameters
Route Parameters
| Name | Description |
|---|---|
| id | The ID of the event type object. |
HTTP Headers
| Name | Description |
|---|---|
| Authorization | An authorisation header containing meta information, see OAuth2. |
Responses
200 - The event type object.
| Name | Description |
|---|---|
| application/json | EventTypeDto |
|
|
|
400 - Bad Request
| Name | Description |
|---|---|
| application/json | ClientErrorDto |
|
|
|
401 - Unauthorized
404 - Not Found
| Name | Description |
|---|---|
| application/json | ClientErrorDto |
|
|
|
Update an event type by ID
This endpoint updates an event type by its UUID.
Parameters
Route Parameters
| Name | Description |
|---|---|
| id | The ID of the event type object. |
HTTP Headers
| Name | Description |
|---|---|
| Authorization | An authorisation header containing meta information, see OAuth2. |
Body
| Content-Type | Type |
|---|---|
| application/json | EventTypePutDto |
|
|
|
Responses
200 - The updated event type.
| Name | Description |
|---|---|
| application/json | EventTypeDto |
|
|
|
400 - Bad Request
| Name | Description |
|---|---|
| application/json | ClientErrorDto |
|
|
|
401 - Unauthorized
404 - Not Found
| Name | Description |
|---|---|
| application/json | ClientErrorDto |
|
|
|
Delete an event type by ID
This endpoint deletes an event type by its UUID.
Do note that related events, invites and reviews will not be deleted.
Please contact us in case you are unsure removing event types!
Parameters
Route Parameters
| Name | Description |
|---|---|
| id | The ID of the event type object. |
HTTP Headers
| Name | Description |
|---|---|
| Authorization | An authorisation header containing meta information, see OAuth2. |
Responses
204 - No Content
400 - Bad Request
| Name | Description |
|---|---|
| application/json | ClientErrorDto |
|
|
|
401 - Unauthorized
404 - Not Found
| Name | Description |
|---|---|
| application/json | ClientErrorDto |
|
|
|
Models
EventTypeDto
Properties
id
string
The event type ID as an eTrusted UUID.
createdAt
string
updatedAt
string
active
boolean
A boolean value that indicates whether the event type is active or not.
If an event type is inactive, events for this type will not be accepted anymore.
name
string
The name of the event type.
checkout is the default event type for every account.
The event type ID as an eTrusted UUID.
A boolean value that indicates whether the event type is active or not.
If an event type is inactive, events for this type will not be accepted anymore.
The name of the event type.
checkout is the default event type for every account.
ClientErrorDto
Properties
Error
string
A summary of the error.
ErrorDescription
string
A detailed description of the error.
A summary of the error.
A detailed description of the error.
EventTypePostDto
Properties
active
boolean
A boolean value that indicates whether the event type is active or not.
If an event type is inactive, events for this type will no longer be accepted.
name
string
The name of the event type.
It needs to be unique for your account and must match our pattern.
A boolean value that indicates whether the event type is active or not.
If an event type is inactive, events for this type will no longer be accepted.
The name of the event type.
It needs to be unique for your account and must match our pattern.
EventTypePutDto
Properties
active
boolean
A boolean value that indicates whether the event type is active or not.
If an event type is inactive, events for this type will no longer be accepted.
A boolean value that indicates whether the event type is active or not.
If an event type is inactive, events for this type will no longer be accepted.
Need further support?
Visit the Help Centre for further information, or contact us. Are some words or terms unfamiliar? Then visit the glossary for clarification.