---
title: "POST /api/customer/event/edit"
method: POST
path: "/api/customer/event/edit"
---

# POST /api/customer/event/edit

`POST /api/customer/event/edit`

Edit an existing event for a specific customer using either API key or a user token

## Headers

- `x-api-key` string

## Request body

- object
  - `apiKey` string — API key for authentication (alternate to header x-api-key)
  - `token` string — User token for authentication
  - `customerData` CustomerObject
    - `email` string, email, required — The email of the user or lead. *Must be unique.
    - `firstName` string — The first name of the user or lead.
    - `lastName` string — The last name of the user or lead.
    - `title` string — The user's title (e.g. CEO, CTO, Mr, etc.).
    - `phoneNumber` string — The phone number of the user or lead.
    - `organization` string — The organization of the user or lead (e.g. company name).
    - `website` string — The user's website.
    - `address` string — The user's address.
    - `city` string — The user's city.
    - `state` string — The user's state.
    - `zip` string — The user's zip code.
    - `country` string — The user's country.
    - `billingAddress` string — The user's billing address.
    - `billingCity` string — The user's billing city.
    - `billingState` string — The user's billing state.
    - `billingZip` string — The user's billing zip code.
    - `billingCountry` string — The user's billing country.
    - `subscriptionType` string — The user's subscription type.
    - `socialMediaHandles` object[] — The user's social media handles.
      - `platform` string — The social media platform (e.g. facebook, twitter, tiktok, linkedin, etc.).
      - `handle` string — The user's handle on the social media platform (e.g. johndoe).
    - `notes` string — Any additional notes for the user or lead.
    - `customFields` object[] — The user's custom fields.
      - `name` string — The name of the custom field.
      - `value` string — The value of the custom field.
  - `eventData` EventObject
    - `date` integer — A Unix timestamp in seconds representing when the event occurred.
    - `eventType` 'email' | 'chat' | 'payment_information' | 'video_meeting' | 'note' | 'meeting' | 'email_activity', required — The type of event that has occurred.
    - `eventFrom` string — The source of the event, e.g. Zoom, Google Meet, HelpScout, Drift, etc.
    - `message` string — The note or email's HTML (recommended) or text body.
    - `toEmail` string, email — The email of the user or lead.
    - `link` string — The link to the event, e.g. Zoom link, Google Meet link, Chata link, etc.
    - `subject` string — The subject of an email
    - `amount` number, float — The amount related to the event, e.g. 100.00.
    - `currency` string — The currency of the amount, e.g. USD, CAD, etc.
    - `paymentEvent` 'canceled_subscription' | 'failed_payment' | 'new_payment' | 'new_dispute' | 'new_refund' | 'new_subscription' | 'updated_subscription' | 'new_customer' — The type of payment event that has occurred.
    - `meeting` MeetingObject
      - `iCalUID` string, required — Unique id for iCalendar standard, for identifying events across calendaring systems. See more: https://datatracker.ietf.org/doc/html/rfc5545#section-3.8.4.7
      - `title` string, required — The title of the meeting event.
      - `status` 'confirmed' | 'tentative' | 'cancelled', required — The status of the meeting event.
      - `description` string — The description of the meeting event. Preferably in HTML format.
      - `url` string — The URL of the meeting event. (e.g. Zoom link, Google Meet link, etc.)
      - `phoneNumbers` string[] — The phone numbers of the meeting event.
      - `endDate` integer — A Unix timestamp in seconds representing when the meeting event ends.
      - `provider` string — The provider of the meeting event. (e.g. Zoom, Google Meet, etc.)
      - `participants` string[] — Email addresses of the meeting event's participants.
      - `password` string — The password of the meeting event. (e.g. Zoom password, etc.)
      - `meetingCode` string — The meeting code of the meeting event. (e.g. Zoom meeting code, etc.)
      - `pin` string — The pin of the meeting event. (e.g. Zoom pin, etc.)
    - `emailActivity` EmailActivityObject
      - `title` string — The title of the email activity.
      - `type` 'received' | 'opened' | 'clicked' | 'bounced' | 'markedAsSpam' | 'subscriptionChanged' | 'unsubscribed', required — The type of email activity event.

## Response `200`

Event data updated successfully

- object
  - `success` boolean
  - `message` string

## Other responses

- `401` — No API key or token provided or Invalid API key or Invalid token
- `404` — User not found
- `500` — Internal server error

---

[API](https://skmtc.dev/usersketch/apis/usersketch-api.md) · [All operations](https://skmtc.dev/usersketch/apis/usersketch-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/usersketch/usersketch-api/revisions/d53c94e971a4/schema)