Event Details
The Event Details entity specifies an event to be used the Reminder type Creative, this entity is immutable once created and so none of the attributes can be edited.
Event Details Attributes
| Attribute | Description | Required | Possible Values |
|---|---|---|---|
| event_name | R | Max length 300 characters | |
| event_time_zone | The event_time_zone is an optional parameter which is only used for display purposes by Snap Ads Manager, if this attribute is left out it will default to the time zone of the Ad Account | O | Africa/Cairo, Africa/Johannesburg, America/Anchorage, America/Cancun, America/Chicago, America/Dawson, America/Dawson_Creek, America/Denver, America/Edmonton, America/Halifax, America/Hermosillo, America/Los_Angeles, America/Mazatlan, America/Mexico_City, America/Montevideo, America/New_York, America/Phoenix, America/Rainy_River, America/Regina, America/Tijuana, America/Toronto, America/Vancouver, Asia/Amman, Asia/Beirut, Asia/Dubai, Asia/Hong_Kong, Asia/Irkutsk, Asia/Jerusalem, Asia/Kamchatka, Asia/Krasnoyarsk, Asia/Magadan, Asia/Nicosia, Asia/Omsk, Asia/Qatar, Asia/Riyadh, Asia/Shanghai, Asia/Singapore, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Atlantic/Canary, Australia/Perth, Australia/Sydney, Europe/Amsterdam, Europe/Berlin, Europe/Brussels, Europe/Dublin, Europe/Helsinki, Europe/Istanbul, Europe/Kaliningrad, Europe/London, Europe/Luxembourg, Europe/Madrid, Europe/Malta, Europe/Moscow, Europe/Oslo, Europe/Paris, Europe/Rome, Europe/Samara, Europe/Stockholm, Europe/Vienna, Europe/Vilnius, Europe/Warsaw, Europe/Zurich, Pacific/Auckland, Pacific/Honolulu, UTC |
| event_start_time | Date in format of epoch timestamp in milliseconds This date is used to determine the event start time. | R | |
| ad_account_id | The Ad Account where the event details lives | R |
Create an Event Details entity
This endpoint will create an Event Details entity within a specified ad account.
HTTP Request
POST https://adsapi.snapchat.com/v1/adaccounts/{ad_account_id}/event_details
Parameters
| Parameter | Default | Description |
|---|---|---|
| ad_account_id | Ad Account ID |
curl -X POST \
-H "Authorization: Bearer meowmeowmeow" \
-H "Content-Type: application/json" \
-d '{"event_details":[{"event_name": "Poodle Show Launch","event_time_zone": "America/New_York","event_start_time": "1741363620","ad_account_id": "82225ba6-7559-4000-9663-bace8adff5f8"}]}' \
"https://adsapi.snapchat.com/v1/adaccounts/82225ba6-7559-4000-9663-bace8adff5f8/event_details"
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "082bcf55-c594-4de8-a944-aee8e2986cff",
"event_details": [
{
"sub_request_status": "SUCCESS",
"event_detail": {
"id": "b762edbd-7f9b-44ea-8dd0-f9f3e6405aec",
"updated_at": "2025-03-18T11:38:04.359Z",
"created_at": "2025-03-18T11:38:04.359Z",
"event_name": "Poodle Show Launch",
"event_start_time": 1741363620,
"event_time_zone": "America/New_York",
"ad_account_id": "82225ba6-7559-4000-9663-bace8adff5f8"
}
}
]
}
Get an Event Details entity
This endpoint retrieves a specific Event Details entity.
HTTP Request
GET https://adsapi.snapchat.com/v1/event_details/{event_details_id}
URL Parameters
| Parameter | Default | Description |
|---|---|---|
| event_details_id | Event Details ID |
curl "https://asapi.snapchat.com/v1/event_details/5ec9b3d8-8ad7-4375-a835-16f21742823e" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "7ce99e05-cd84-43f1-a138-11cb6200465f",
"event_details": [
{
"sub_request_status": "SUCCESS",
"event_detail": {
"id": "5ec9b3d8-8ad7-4375-a835-16f21742823e",
"updated_at": "2025-02-24T16:12:55.747Z",
"created_at": "2025-02-24T16:12:55.747Z",
"event_name": "Squirrels Motion Picture launch",
"event_start_time": 1741363620,
"event_time_zone": "America/New_York",
"ad_account_id": "82225ba6-7559-4000-9663-bace8adff5f8"
}
}
]
}
Get all Event Details entities under an Ad Account
This endpoint retrieves all Event Details entities under an Ad Account.
HTTP Request
GET https://adsapi.snapchat.com/v1/adaccounts/{ad_account_id}/event_details
URL Parameters
| Parameter | Default | Description |
|---|---|---|
| ad_account_id | Ad Account ID |
curl "https://adsapi.snapchat.com/v1/adaccounts/82225ba6-7559-4000-9663-bace8adff5f8/event_details" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
"request_status": "SUCCESS",
"request_id": "43499453-db00-4574-aef4-60dc39f0f6bb",
"paging": {},
"event_details": [
{
"sub_request_status": "SUCCESS",
"event_detail": {
"id": "5ec9b3d8-8ad7-4375-a835-16f21742823e",
"updated_at": "2025-02-24T16:12:55.747Z",
"created_at": "2025-02-24T16:12:55.747Z",
"event_name": "Squirrels Motion Picture launch",
"event_start_time": 1741363620,
"event_time_zone": "America/New_York",
"ad_account_id": "82225ba6-7559-4000-9663-bace8adff5f8"
}
},
{
"sub_request_status": "SUCCESS",
"event_detail": {
"id": "b762edbd-7f9b-44ea-8dd0-f9f3e6405aec",
"updated_at": "2025-03-18T11:38:04.359Z",
"created_at": "2025-03-18T11:38:04.359Z",
"event_name": "Poodle Show Launch",
"event_start_time": 1741363620,
"event_time_zone": "America/New_York",
"ad_account_id": "82225ba6-7559-4000-9663-bace8adff5f8"
}
}
]
}
Delete an Event Details entity
This endpoint deletes a specific Event Details entity, we recommend that you use this endpoint with caution as there is no way to reinstate a deleted entity. Before you delete an Event Details entity you should always make sure it's not being used by an active Reminder Creative.
HTTP Request
DELETE https://adsapi.snapchat.com/v1/event_details/{event_details_id}
URL Parameters
| Parameter | Description |
|---|---|
| event_details_id | The ID of the Event Details entity to be deleted |
curl -X DELETE "https://adsapi.snapchat.com/v1/event_details/7ded6d53-0805-4ff8-b984-54a7eb5c8918" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "success",
"request_id": "57b01b6200ff05d100ff30ca9b1d0001737e616473617069736300016275696c642d35396264653638322d312d31312d3700010101",
"ads": []
}
Was this page helpful?