Segment

Delete Credential. Deletes an existing Credential. Fails with a `409 Conflict` if the Credential is still in use by a Warehouse or Source (including a disabled one). This check isn't atomic with the delete — a Warehouse or Source that attaches to this Credential in between would be orphaned rather than blocking the delete. • When called, this endpoint may generate the `Warehouse Credential Deleted` event in the [audit trail](/tag/Audit-Trail). This endpoint requires the user to have at least the following permission(s): * Workspace Owner. DESTRUCTIVE: this removes the resource it names.

Remove Filter from Destination. Deletes a Destination filter. • When called, this endpoint may generate the `Destination Filter Deleted` event in the [audit trail](/tag/Audit-Trail). DESTRUCTIVE: this removes the resource it names.

Delete Destination. Deletes an existing Destination. • When called, this endpoint may generate the `Integration Deleted` event in the [audit trail](/tag/Audit-Trail). Config API omitted fields: - `catalogId`. DESTRUCTIVE: this removes the resource it names.

Remove Subscription from Destination. Deletes an existing Destination subscription. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 5 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information. DESTRUCTIVE: this removes the resource it names.

Delete Filter By Id. Deletes a filter by id. • This endpoint is in **Beta** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Space Filters feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Filter Deleted` event in the [audit trail](/tag/Audit-Trail). DESTRUCTIVE: this removes the resource it names.

Delete Function. Deletes a Function. • In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information. DESTRUCTIVE: this removes the resource it names.

Remove Users from User Group. Removes one or multiple users or invites from a user group by email. • When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Group Memberships Deleted * User Removed From User Group The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information. DESTRUCTIVE: this removes the resource it names.

Delete User Group. Removes a user group from a Workspace. • When called, this endpoint may generate the `User Group Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information. DESTRUCTIVE: this removes the resource it names.

Delete Insert Function Instance. Deletes an insert Function instance. • In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information. DESTRUCTIVE: this removes the resource it names.

Delete Invites. Removes a list of invitations to join a Workspace. • When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Invite Deleted * Group Memberships Deleted The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information. DESTRUCTIVE: this removes the resource it names. NOT route-validated by the build sweep: no path parameter, so a probe would have revoked real pending invites in the shared workspace rather than answering about a sentinel.

Delete Label. Deletes a label. • When called, this endpoint may generate the `Label Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information. DESTRUCTIVE: this removes the resource it names.

Delete Reverse Etl Model. Deletes an existing Model. • When called, this endpoint may generate the `Model Deleted` event in the [audit trail](/tag/Audit-Trail). DESTRUCTIVE: this removes the resource it names.

Delete Source. Deletes an existing Source. • When called, this endpoint may generate the `Source Deleted` event in the [audit trail](/tag/Audit-Trail). DESTRUCTIVE: this removes the resource it names.

Delete Live Plugin Code. Delete the Live Plugin code for a Source. This will not disable Live Plugins for the Source, but will remove any existing code. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Live Plugins feature enabled. Please reach out to your customer success manager for more information. DESTRUCTIVE: this removes the resource it names.

Remove Write Key from Source. Removes a Write Key from a Source. • When called, this endpoint may generate the `Source Modified` event in the [audit trail](/tag/Audit-Trail). DESTRUCTIVE: this removes the resource it names.

Remove Activation from Audience. Deletes an Activation. The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information. DESTRUCTIVE: this removes the resource it names.

Remove Destination from Audience. Removes a Destination from an Audience. If there are activations associated with the Destination, the request will return a 409 Conflict error. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. DESTRUCTIVE: this removes the resource it names.

Remove Audience from Space. Deletes an Audience by id and spaceId. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Audience Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information. DESTRUCTIVE: this removes the resource it names.

Remove Audience Schedule from Audience. Deletes an audience schedule for a Linked Audience (audienceType = LINKED). • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information. DESTRUCTIVE: this removes the resource it names.

Remove Computed Trait from Space. Deletes a Computed Trait by id and spaceId. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Computed Trait feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Computed Trait Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 20 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information. DESTRUCTIVE: this removes the resource it names.

Remove Profiles Warehouse from Space. Deletes an existing Profiles Warehouse. • When called, this endpoint may generate the `Profiles Sync Warehouse Deleted` event in the [audit trail](/tag/Audit-Trail). DESTRUCTIVE: this removes the resource it names.

Delete Tracking Plan. Deletes a Tracking Plan. • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information. DESTRUCTIVE: this removes the resource it names.

Remove Rules from Tracking Plan. Deletes Tracking Plan rules. • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information. DESTRUCTIVE: this removes the resource it names.

Remove Source from Tracking Plan. Disconnects a Source from a Tracking Plan. • When called, this endpoint may generate the `Source Modified` event in the [audit trail](/tag/Audit-Trail). • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information. DESTRUCTIVE: this removes the resource it names.

Delete Transformation. Deletes a Transformation. • When called, this endpoint may generate the `Transformation Deleted` event in the [audit trail](/tag/Audit-Trail). • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information. DESTRUCTIVE: this removes the resource it names.

Delete Users. Removes one or multiple users. • When called, this endpoint may generate the `Group Memberships Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information. DESTRUCTIVE: this removes the resource it names. NOT route-validated by the build sweep: no path parameter, so a probe would have removed real workspace users rather than answering about a sentinel.

Delete Warehouse. Deletes an existing Warehouse. • When called, this endpoint may generate the `Storage Destination Deleted` event in the [audit trail](/tag/Audit-Trail). DESTRUCTIVE: this removes the resource it names.

Remove Source Connection from Warehouse. Disconnects a Source from a Warehouse. DESTRUCTIVE: this removes the resource it names.

Get Workspace. Returns the Workspace associated with the token used to access this resource.

List Audit Events. Returns a list of Audit Trail events.

Get Destinations Catalog. Returns a list of all available Destinations in the Segment catalog.

Get Destination Metadata. Returns a Destination catalog item by its id.

Get Sources Catalog. Returns a list of all available Sources in the Segment catalog.

Get Source Metadata. Returns a Source catalog item by its id.

Get Warehouses Catalog. Returns a list of all available Warehouses in the Segment catalog.

Get Warehouse Metadata. Returns a Warehouse catalog item by its id.

List Credentials. Returns a list of Credentials. This endpoint requires the user to have at least the following permission(s): * Workspace Owner * Warehouse Admin * Source Admin * Entities Admin * Unify and Engage Admin.

Get Credential. Returns a Credential by its id. This endpoint requires the user to have at least the following permission(s): * Workspace Owner * Warehouse Admin * Source Admin * Entities Admin * Unify and Engage Admin.

List Credential Consumers. Returns the Warehouses and Sources that use a Credential. This endpoint requires the user to have at least the following permission(s): * Workspace Owner * Warehouse Admin * Source Admin * Entities Admin * Unify and Engage Admin.

Get Egress Failed Metrics from Delivery Overview. Get events that failed to be delivered to Destination.

Get Ingress Failed Metrics from Delivery Overview. Get events that failed on ingest.

Get Filtered At Destination Metrics from Delivery Overview. Get events that were filtered at Destination.

Get Filtered At Source Metrics from Delivery Overview. Get events that were filtered at Source.

Get Egress Success Metrics from Delivery Overview. Get events successfully delivered to Destination.

Get Ingress Success Metrics from Delivery Overview. Get events that were successfully received by Segment.

List Filters from Destination. Lists filters for a Destination.

Get Filter in Destination. Gets a Destination filter by id.

List Destinations. Returns a list of Destinations.

Get Destination. Returns a Destination by its id. Config API omitted fields: - `catalogId`.

List Delivery Metrics Summary from Destination. Get an event delivery metrics summary from a Destination. Based on the granularity chosen, there are restrictions on the time range you can query: **Minute**: - Max time range: 4 hours - Oldest possible start time: 48 hours in the past **Hour**: - Max Time range: 7 days - Oldest possible start time: 7 days in the past **Day**: - Max time range: 14 days - Oldest possible start time: 14 days in the past.

List Subscriptions from Destination. Lists subscriptions for a Destination. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information.

Get Subscription from Destination. Gets a Destination subscription by id. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information.

Echo. Public Echo endpoint.

Get Events Volume from Workspace. Enumerates the Workspace event volumes over time in minute increments. The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Filters for Space. Lists filters for a space. • This endpoint is in **Beta** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Space Filters feature enabled. Please reach out to your customer success manager for more information.

Get Filter By Id. Gets a filter by id. • This endpoint is in **Beta** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Space Filters feature enabled. Please reach out to your customer success manager for more information.

List Functions. Lists all Functions in a Workspace. • In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.

Get Function. Gets a Function. • In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.

List Function Versions. Lists versions for a Function in a Workspace. • In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.

Get Function Version. Gets a Function version. • In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.

List User Groups. Returns all user groups.

Get User Group. Returns a user group.

List Invites from User Group. Returns the emails of invitees to a user group.

List Users from User Group. Returns users belonging to a user group.

List Insert Function Instances. Lists all insert Function instances connected to the given insert Function. • In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.

Get Insert Function Instance. Gets an insert Function instance. • In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.

List Invites. Returns a list of invitations to join a Workspace. Config API omitted fields: - `parent`.

List Labels. Returns a list of all available labels.

List Workspace Regulations. Lists all Workspace-scoped regulations. Please note: List Workspace regulations only returns deletion requests from the past 90 days. Deletion requests older than 90 days are not retained and will result in 404 resource not found.

Get Regulation. Gets a regulation from the Workspace. Config API omitted fields: - `parent`.

List Regulations from Source. Lists all Source-scoped regulations. Please note: List regulations for Source only returns deletion requests from the past 90 days. Deletion requests older than 90 days are not retained and will result in 404 resource not found.

List Reverse Etl Models. Returns a list of Reverse ETL Models.

Get Reverse Etl Model. Returns a Reverse ETL Model by its id.

List Reverse ETL Sync Statuses from Model And Subscription Id. Get the sync statuses for a Reverse ETL mapping subscription. The sync status includes all detailed information about the sync - sync status, duration, details about the extract and load phase if applicable, etc. The default page count is 10, and then the next page can be fetched by passing the `cursor` query parameter.

Get Reverse ETL Sync Status. Get the sync status for a Reverse ETL sync. The sync status includes all detailed information about the sync - sync status, duration, details about the extract and load phase if applicable, etc. The rate limit for this endpoint is 250 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Roles. Returns a list of Roles available to apply to permissions for users and/or groups.

List Sources. Returns a list of Sources.

Get Source. Returns a Source by its id.

List Connected Destinations from Source. Returns a list of Destinations connected to a Source.

List Connected Warehouses from Source. Returns a list of Warehouses connected to a Source.

Get Latest from Live Plugins. Get the latest Live Plugins for your Source. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Live Plugins feature enabled. Please reach out to your customer success manager for more information.

List Schema Settings in Source. Retrieves the schema configuration settings for a Source. If Protocols is not enabled for the Source, the configurations specific to Protocols will have default values.

List Spaces. List Spaces. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Spaces feature enabled. Please reach out to your customer success manager for more information.

Get Space. Returns the Space by id. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Spaces feature enabled. Please reach out to your customer success manager for more information.

List Audiences. Returns Audiences by spaceId. Supports including audience schedules using `?include=schedules`. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Activations from Audience. Lists all Activations. The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Get Activation from Audience. Gets a single Activation by id. The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Destinations from Audience. Lists all Destinations from an Audience. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Get Audience. Returns the Audience by id and spaceId. Supports including audience schedules using `?include=schedules`. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 100 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Audience Consumers from Space And Audience. Returns the list of consumers for the given audience. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 25 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Audience Schedules from Space And Audience. Returns the list of schedules for the given audience. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.

Get Audience Schedule from Space And Audience. Returns the schedule for the given audience and scheduleId. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.

Get Audience Preview. Reads the results of an audience preview. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 300 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Supported Destinations from Audience. Lists the Destinations that have been reviewed and validated for activation with this audience type. Use this endpoint to discover the available action ids and the Destination fields that can be mapped before creating an Activation. Destinations returned with an empty actions array are audience Destinations that are configured through connection settings rather than action mappings, and do not use destinationMapping. Destinations that are not returned here have not been reviewed for activation and are unsupported. To request a review for an additional Destination, contact your customer success manager. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Computed Traits. Returns Computed Traits by spaceId. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Computed Trait feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 25 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Get Computed Trait. Returns the Computed Trait by id and spaceId • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Computed Trait feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 100 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Properties from Entity. Returns a list of Properties for an Entity in a Space. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. <div style="background-color: #e8f4fd; border: 1px solid #90caf9; border-radius: 6px; padding: 16px; margin: 16px 0; color: #0d47a1; line-height: 1.5;"> <ul style="margin: 0; padding-left: 20px; font-size: 13px;"> <li style="margin-bottom: 6px;"><strong>Forward-only pagination</strong>: this endpoint does not support backward traversal. The <code>pagination.previous</code> field is always absent; use <code>pagination.next</code> to advance through pages.</li> </ul> </div> The rate limit for this endpoint is 25 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Sample Values from Entity Property. Returns sample values for an Entity Property in a Space. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. The rate limit for this endpoint is 25 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Entity Paths. Returns a list of Entity Paths for a Space. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. The rate limit for this endpoint is 25 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Events. Returns a list of Events for a Space. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. The rate limit for this endpoint is 25 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Properties from Event. Returns a list of Properties for an Event in a Space. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. The rate limit for this endpoint is 25 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Sample Values from Event Property. Returns sample values for an Event Property in a Space. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. The rate limit for this endpoint is 25 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Profiles Warehouse in Space. Lists all Profile Warehouses for a given space id. • When called, this endpoint may generate the `Profiles Sync Warehouse Retrieved` event in the [audit trail](/tag/Audit-Trail).

List Selective Syncs from Warehouse And Space. Returns the schema for a Space Warehouse connection, including Collections and Properties.

List Traits. Returns a list of Traits for a Space. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. <div style="background-color: #e8f4fd; border: 1px solid #90caf9; border-radius: 6px; padding: 16px; margin: 16px 0; color: #0d47a1; line-height: 1.5;"> <ul style="margin: 0; padding-left: 20px; font-size: 13px;"> <li style="margin-bottom: 6px;"><strong>Forward-only pagination</strong>: this endpoint does not support backward traversal. The <code>pagination.previous</code> field is always absent; use <code>pagination.next</code> to advance through pages.</li> <li style="margin-bottom: 6px;"><strong>Approximate total count</strong>: <code>pagination.totalEntries</code> is an upper bound that decreases as you paginate — the final page reflects the exact deduplicated count.</li> <li style="margin-bottom: 6px;"><strong>Duplicate entries</strong>: when sorting by <code>lastSeenAt</code>, duplicate trait entries may appear across pages for Spaces with more than 2,500 traits. Sorting by <code>trait</code> is not affected.</li> </ul> </div> The rate limit for this endpoint is 25 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Sample Values from Trait. Returns sample values for a Trait in a Space. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. The rate limit for this endpoint is 25 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Suppressions. Lists all suppressions in a given Workspace.

List Tracking Plans. Returns a list of Tracking Plans. • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.

Get Tracking Plan. Returns a Tracking Plan. • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.

List Rules from Tracking Plan. Lists Tracking Plan rules. • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 200 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Sources from Tracking Plan. Lists Sources connected to a Tracking Plan. • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information. This endpoint requires the user to have at least the following permission(s): * Source Read-only * Tracking Plan Read-only.

List Transformations. Lists all Transformations in the Workspace. • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.

Get Transformation. Gets a Transformation. • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.

Get Daily Workspace API Calls Usage. Provides daily cumulative API call counts for a usage period.

Get Daily Per Source API Calls Usage. Provides daily cumulative per-source API call counts for a usage period.

Get Daily Workspace MTU Usage. Provides daily cumulative MTU counts for a usage period.

Get Daily Per Source MTU Usage. Provides daily cumulative per-source MTU counts for a usage period.

List Users. Returns a list of users with access to the Workspace.

Get User. Returns a user given their id.

List User Groups from User. Returns all groups a user belongs to.

List Warehouses. Returns a list of Warehouses.

Get Warehouse. Returns a Warehouse by its id.

Get Advanced Sync Schedule from Warehouse. Returns the advanced sync schedule for a Warehouse. The rate limit for this endpoint is 2 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Connected Sources from Warehouse. Returns the list of Sources that are connected to a Warehouse.

List Selective Syncs from Warehouse And Source. Returns the schema for a Warehouse, including Sources, Collections, and Properties. The rate limit for this endpoint is 2 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Syncs from Warehouse And Source. Returns the overview of syncs for a Source connected to a Warehouse. The rate limit for this endpoint is 2 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Get Connection State from Warehouse. Verifies the state of Warehouse connection settings. The rate limit for this endpoint is 200 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

List Syncs from Warehouse. Returns the overview of syncs for every Source connected to a Warehouse. The rate limit for this endpoint is 2 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Update Credential. Updates an existing Credential. All Warehouses using this Credential are affected immediately. • When called, this endpoint may generate the `Warehouse Credential Modified` event in the [audit trail](/tag/Audit-Trail). This endpoint requires the user to have at least the following permission(s): * Workspace Owner.

Update Filter for Destination. Updates a filter in a Destination. • When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Destination Filter Enabled * Destination Filter Disabled.

Update Destination. Updates an existing Destination. **Note**: if you attempt to update read-only settings for your destination you'll encounter the following behavior: * If only read-only properties are being updated, the endpoint will return an HTTP 400 error. * If there's a mix of writable and read-only properties in the payload, the request will be accepted, the writable properties will be updated and the read-only properties ignored. • When called, this endpoint may generate the `Integration Disabled` event in the [audit trail](/tag/Audit-Trail). Config API omitted fields: - `updateMask`.

Update Subscription for Destination. Updates an existing Destination subscription. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 5 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Update Filter By Id. Updates a filter by id and replaces the existing filter. • This endpoint is in **Beta** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Space Filters feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Filter Updated` event in the [audit trail](/tag/Audit-Trail).

Update Function. Updates a Function. • In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information. Config API omitted fields: - `updateMask`.

Update User Group. Updates a user group for a Workspace. • When called, this endpoint may generate the `User Group Updated` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Update Insert Function Instance. Updates an insert Function instance connected to the given Destination. • In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.

Update Reverse Etl Model. Updates an existing Reverse ETL Model. • When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Model Settings Saved * Model State Change Toggled.

Update Source. Updates an existing Source. • When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Source Modified * Source Enabled * Source Settings Modified * Source Disabled Config API omitted fields: - `updateMask`.

Update Schema Settings in Source. Updates the schema configuration for a Source. If Protocols is not enabled for the Source, any updates to Protocols-specific configurations will not be applied. Config API omitted fields: - `updateMask`.

Update Activation for Audience. Updates an Activation. The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Update Destination for Audience. Updates a Destination for an Audience. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information.

Update Audience for Space. Updates the Audience. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Audience Modified` event in the [audit trail](/tag/Audit-Trail). • Note that when an Audience is updated, the Audience will be locked from future edits until the changes have been incorporated. You can find more information [in the Segment docs](https://segment-docs.netlify.app/docs/engage/audiences/#editing-realtime-audiences-and-traits). The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Update Audience Schedule for Audience. Updates an audience schedule for a Linked Audience (audienceType = LINKED). • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Update Computed Trait for Space. Updates the Computed Trait. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Computed Trait feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Computed Trait Modified` event in the [audit trail](/tag/Audit-Trail). • Note that when a Computed Trait is updated, the Computed Trait will be locked from future edits until the changes have been incorporated. You can find more information [in the Segment docs](https://segment-docs.netlify.app/docs/unify/traits/computed-traits/#editing-realtime-traits). Note: The definition for a Computed Trait updated using the API is not editable through the Segment App. The rate limit for this endpoint is 10 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Update Profiles Warehouse for Space Warehouse. Updates an existing Profiles Warehouse. • When called, this endpoint may generate the `Profiles Sync Warehouse Updated` event in the [audit trail](/tag/Audit-Trail).

Update Selective Sync for Warehouse And Space. Updates the schema for a Space Warehouse connection, including Collections and Properties. • When called, this endpoint may generate the `Profiles Sync Warehouse Modified` event in the [audit trail](/tag/Audit-Trail).

Update Tracking Plan. Updates a Tracking Plan. • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information. Config API omitted fields: - `updateMask`.

Update Rules in Tracking Plan. Updates Tracking Plan rules. • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.

Update Transformation. Updates an existing Transformation. • When called, this endpoint may generate the `Transformation Updated` event in the [audit trail](/tag/Audit-Trail). • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.

Update Warehouse. Updates an existing Warehouse. • When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Storage Destination Modified * Storage Destination Enabled.

Update Selective Sync for Warehouse. Configures the schema for a Warehouse, including Sources, Collections, and Properties. • When called, this endpoint may generate the `Storage Destination Modified` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 2 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Create Credential. Creates a new Credential. • When called, this endpoint may generate the `Warehouse Credential Created` event in the [audit trail](/tag/Audit-Trail). This endpoint requires the user to have at least the following permission(s): * Workspace Owner * Warehouse Admin * Source Admin * Entities Admin * Unify and Engage Admin.

Create Download. Create Customer Insights Presigned URLsThe rate limit for this endpoint is 120 requests per day per workspaceId, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Create Dbt Model Sync Trigger. Creates a trigger for a new dbt model sync for a Source. The rate limit for this endpoint is 10 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Create Filter for Destination. Creates a filter in a Destination. • When called, this endpoint may generate the `Destination Filter Created` event in the [audit trail](/tag/Audit-Trail).

Preview Destination Filter. Simulates the application of a Destination filter to a provided JSON payload.

Create Destination. Creates a new Destination. • When called, this endpoint may generate the `Integration Created` event in the [audit trail](/tag/Audit-Trail).

Create Destination Subscription. Creates a new Destination subscription. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Destination Subscriptions feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 5 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Create Filter for Space. Creates a filter for a space. A space filter applies to events coming from all Sources connected to a space. • This endpoint is in **Beta** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Space Filters feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Filter Created` event in the [audit trail](/tag/Audit-Trail).

Create Function. Creates a Function. • In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.

Create Function Deployment. Deploys a Function. Only applicable to Source Function instances. • In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.

Restore Function Version. Restore an old Function version as the latest version. • In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.

Create User Group. Creates a user group. • When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* User Group Created * Policy Created The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Add Permissions to User Group. Adds a list of access permissions to a user group. • When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Policy Created * User Group Policy Updated The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Add Users to User Group. Adds a list of users or invites to a user group. • When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Subjects Added to Group * User Added To User Group The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Create Insert Function Instance. Creates an insert Function instance connected to the given Destination. • In order to successfully call this endpoint, the specified Workspace needs to have the Functions feature enabled. Please reach out to your customer success manager for more information.

Create Invites. Invites a list of users to join a Workspace. • When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Non-Segment User Invited to Workspace * Policy Created * New Segment User Invited to Workspace Config API omitted fields: - `parent` The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Create Label. Creates a new label. • When called, this endpoint may generate the `Label Created` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Create Workspace Regulation. Creates a Workspace-scoped regulation. Config API omitted fields: - `attributes`, - `userAgent` Rate limit headers will be updated to reflect regulation-specific limits (tracked separately for Segment-only vs Segment & Destination regulation types): - X-RateLimit-Remaining: Remaining requests for the regulation type category - Segment-only Regulations: DELETE_INTERNAL, SUPPRESS_WITH_DELETE_INTERNAL, SUPPRESS_ONLY, UNSUPPRESS, DELETE_ARCHIVE_ONLY - Segment & Destination Regulations: DELETE_ONLY, SUPPRESS_WITH_DELETE - X-RateLimit-Reset: RFC 5322 timestamp for when the quota resets (for example, Tue, 31 Dec 2024 23:59:59 GMT) The rate limit for this endpoint is 600 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Create Cloud Source Regulation. Creates a Source-scoped regulation. Please Note: Suppression rules at the Workspace level take precedence over those at the Source level. If a user has been suppressed at the Workspace level, any attempt to un-suppress at the Source level is not supported and the processing of the request will fail in Segment Config API omitted fields: - `attributes`, - `userAgent` Rate limit headers will be updated to reflect regulation-specific limits (tracked separately for Segment-only vs Segment & Destination regulation types): - X-RateLimit-Remaining: Remaining requests for the regulation type category - Segment-only Regulations: DELETE_INTERNAL, SUPPRESS_WITH_DELETE_INTERNAL, SUPPRESS_ONLY, UNSUPPRESS, DELETE_ARCHIVE_ONLY - Segment & Destination Regulations: DELETE_ONLY, SUPPRESS_WITH_DELETE - X-RateLimit-Reset: RFC 5322 timestamp for when the quota resets (for example, Tue, 31 Dec 2024 23:59:59 GMT) The rate limit for this endpoint is 600 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Create Source Regulation. Creates a Source-scoped regulation. Please Note: Suppression rules at the Workspace level take precedence over those at the Source level. If a user has been suppressed at the Workspace level, any attempt to un-suppress at the Source level is not supported and the processing of the request will fail in Segment Config API omitted fields: - `attributes`, - `userAgent` Rate limit headers will be updated to reflect regulation-specific limits (tracked separately for Segment-only vs Segment & Destination regulation types): - X-RateLimit-Remaining: Remaining requests for the regulation type category - Segment-only Regulations: DELETE_INTERNAL, SUPPRESS_WITH_DELETE_INTERNAL, SUPPRESS_ONLY, UNSUPPRESS, DELETE_ARCHIVE_ONLY - Segment & Destination Regulations: DELETE_ONLY, SUPPRESS_WITH_DELETE - X-RateLimit-Reset: RFC 5322 timestamp for when the quota resets (for example, Tue, 31 Dec 2024 23:59:59 GMT) The rate limit for this endpoint is 600 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Create Reverse Etl Model. Creates a new Reverse ETL Model. • When called, this endpoint may generate the `Model Created` event in the [audit trail](/tag/Audit-Trail).

Cancel Reverse ETL Sync for Model. Cancels a sync for a Reverse ETL Connection. It might take a few seconds to completely cancel the sync. Will return an error if the sync is already completed or cancelled.

Create Reverse ETL Manual Sync. Triggers a manual sync for a Reverse ETL Connection. In the request body, the `subscription id` is the id that follows after `/mappings/` portion in the URL of the sync. For example, the `subscription id` would be `2` for this sync: https://app.Segment.com/example-workspace/reverse-etl/destinations/example-destination/sources/example-source/instances/1/mappings/2/source-id/3/model-id/4/sync-details The rate limit for this endpoint is 20 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Create Source. Creates a new Source. • When called, this endpoint may generate the `Source Created` event in the [audit trail](/tag/Audit-Trail).

Add Labels to Source. Adds an existing label to a Source. • When called, this endpoint may generate the `Source Modified` event in the [audit trail](/tag/Audit-Trail).

Create Live Plugin. Creates or updates a Live Plugin for your Source with given code. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Live Plugins feature enabled. Please reach out to your customer success manager for more information.

Create Write Key for Source. Creates a new Write Key for the Source. • When called, this endpoint may generate the `Source Modified` event in the [audit trail](/tag/Audit-Trail).

Batch Query Activations for Space. Lists Activations in bulk across many Audiences in one call. Intended for bulk reads, for example pulling activation metadata for hundreds of audiences on a schedule, so callers don't need one `listActivationsFromAudience` call per audience. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Create Audience. Creates Audience. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Audience Created` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Add Destination to Audience. Establishes a connection between an audience and a Destination. To start syncing data, you must create an Activation for the connection created here. Note that the Destination must be added to Engage through the Engage Settings page within the App before creating the connection through the API. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Add Activation to Audience. Defines how audience data is sent to a Destination. This step enables the data sync. You must establish a connection (Add Destination to Audience) for this audience before an Activation can be created. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Force Execute Audience Run. The ability to force execute a run for an Audience is limited to Linked Audiences (audienceType = `LINKED`). • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Audience Run Forced` event in the [audit trail](/tag/Audit-Trail).

Add Audience Schedule to Audience. The ability to configure the run schedule for an Audience is limited to Linked Audiences (audienceType = LINKED). Note that if a Linked Audience remains disabled for 90 days Segment will delete the associated schedule and a new schedule will need to be created. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 50 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Create Audience Preview. Previews Audience. • In order to successfully call this endpoint, the specified Workspace needs to have the Audience feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Audience Preview Created` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 5 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information. This endpoint also has a rate limit of 700 requests per month per spaceId, which is lower than the default due to access pattern restrictions.

Create Computed Trait. Creates a Computed Trait • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Computed Trait feature enabled. Please reach out to your customer success manager for more information. • When called, this endpoint may generate the `Computed Trait Created` event in the [audit trail](/tag/Audit-Trail). Note: The definition for a Computed Trait created using the API is not editable through the Segment App. The rate limit for this endpoint is 10 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Batch Query Messaging Subscriptions for Space. <div style="background-color: #fff3cd; border: 1px solid #ffc107; border-radius: 6px; padding: 16px; margin: 16px 0; color: #856404; display: flex; align-items: center; gap: 12px; line-height: 1.5;"> <span style="color: #ff9800; font-size: 16px; flex-shrink: 0;">⚠️</span> <div style="line-height: 1.5;"> <div style="font-weight: 600; font-size: 14px; margin-bottom: 6px;"> Engage Premier features will no longer be available after December 15, 2025. </div> <div style="font-size: 13px;"> This API will be deactivated after this date. </div> </div> </div> Get Messaging Subscriptions for space. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Spaces feature enabled. Please reach out to your customer success manager for more information.

Create Profiles Warehouse. Creates a new Profiles Warehouse. • When called, this endpoint may generate the `Profiles Sync Warehouse Created` event in the [audit trail](/tag/Audit-Trail).

Create Tracking Plan. Creates a Tracking Plan. • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.

Add Source to Tracking Plan. Connects a Source to a Tracking Plan. • When called, this endpoint may generate the `Source Modified` event in the [audit trail](/tag/Audit-Trail). • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.

Create Transformation. Creates a new Transformation. • When called, this endpoint may generate the `Transformation Created` event in the [audit trail](/tag/Audit-Trail). • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.

Add Permissions to User. Adds a list of access permissions to a user. • When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Policy Created * User Policy Updated The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Create Warehouse. Creates a new Warehouse. • When called, this endpoint may generate the `Storage Destination Created` event in the [audit trail](/tag/Audit-Trail).

Add Connection from Source to Warehouse. Connects a Source to a Warehouse. • When called, this endpoint may generate the `Storage Destination Modified` event in the [audit trail](/tag/Audit-Trail).

Create Validation in Warehouse. Validates input settings against a Warehouse. • When called, this endpoint may generate the `Storage Destination Settings Validation` event in the [audit trail](/tag/Audit-Trail).

Replace Users in User Group. Replaces the members of a user group by email. • When called, this endpoint may generate one or more of the following [audit trail](/tag/Audit-Trail) events:* Subjects Added to Group * User Added To User Group * Group Memberships Deleted The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Replace Permissions for User Group. Updates the list of access permissions for a user group. • When called, this endpoint may generate the `Policy Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Replace Labels in Source. Replaces all labels in a Source.

Replace Messaging Subscriptions in Spaces. <div style="background-color: #fff3cd; border: 1px solid #ffc107; border-radius: 6px; padding: 16px; margin: 16px 0; color: #856404; display: flex; align-items: center; gap: 12px; line-height: 1.5;"> <span style="color: #ff9800; font-size: 16px; flex-shrink: 0;">⚠️</span> <div style="line-height: 1.5;"> <div style="font-weight: 600; font-size: 14px; margin-bottom: 6px;"> Engage Premier features will no longer be available after December 15, 2025. </div> <div style="font-size: 13px;"> This API will be deactivated after this date. </div> </div> </div> Replace Messaging Subscriptions in Spaces. • This endpoint is in **Alpha** testing. Please submit any feedback by sending an email to friends@segment.com. • In order to successfully call this endpoint, the specified Workspace needs to have the Spaces feature enabled. Please reach out to your customer success manager for more information. The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Replace Rules in Tracking Plan. Replaces Tracking Plan rules. • In order to successfully call this endpoint, the specified Workspace needs to have the Protocols feature enabled. Please reach out to your customer success manager for more information.

Replace Permissions for User. Updates the list of access permissions for a user. • When called, this endpoint may generate the `Policy Deleted` event in the [audit trail](/tag/Audit-Trail). The rate limit for this endpoint is 60 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.

Replace Advanced Sync Schedule for Warehouse. Updates the advanced sync schedule for a Warehouse, replacing the sync schedule with a new schedule. The rate limit for this endpoint is 2 requests per minute, which is lower than the default due to access pattern restrictions. Once reached, this endpoint will respond with the 429 HTTP status code with headers indicating the limit parameters. See [Rate Limiting](/#tag/Rate-Limits) for more information.