Create a custom event by alias.
IMPORTANT: the body of the request depends of the fields defined in each custom event definition.
POST https://api.connectif.cloud/custom-events/alias/{alias}
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| alias | string | Alias of the custom event |
Required |
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| createContact | boolean | Whether the contact should be created or not, depending on whether the contact exists. Defaults to false. |
The request body takes a complete CreateCustomEvent resource, containing the following writable properties:
{
"<key>": "string"
}| Name | Type | Description | Additional |
|---|---|---|---|
| <key> | map of string |
A custom field of the custom event. The key must be the field id defined in Connectif and the value must be of the appropriate type: string for text fields; number for decimal fields; integer for integer fields; boolean for boolean fields; and an array of string for checkbox fields. |
Optional |
This request requires the use of one of following authorization methods:
API key
.
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 201 | Created Success. |
CreateCustomEventResponse |
| 400 | Bad Request Bad request. |
HttpError |
| 401 | Unauthorized Not authorized to access API. |
|
| 403 | Forbidden Permission not granted to the API Key or account has been blocked. |
HttpError |
| 404 | Not Found Resource not found. |
HttpError |
| 413 | Request Entity Too Large Resource is too big. Maximum allowed size is 50Mb. |
HttpError |
| 422 | Unprocessable Entity Resource contains validation errors. |
HttpUnprocessableEntityError |
| 429 | Too Many Requests Requests rate limit reached. |