Emailit icon

Emailit

Transactional email platform. Send emails, manage domains, templates, audiences, webhooks, suppressions, contacts, and verify emails via the Emailit API.

Audiences → Update an audience

AI-generated

Summary

Update an existing audience by its ID, optionally modifying its name and description or sending custom JSON fields merged into the update request body.

Inputs

  • Id (required) — The ID of the audience to update.
  • Name — The new name for the audience.
  • Description — The new description for the audience.
  • Custom Body — Arbitrary JSON to include in the request body. This custom body is deep-merged with standard fields and takes priority.
  • Custom Headers — Custom HTTP headers to include in the update request.
  • Query Filters — Key-value pairs to include as query-string parameters for filtering.
  • Return All — Whether to return all results or only a single page if the response supports pagination.
  • Batching — Settings to batch input items, controlling batch size and interval.
  • Debug — Include full request details (URL, query, headers, body) in output for troubleshooting.
  • Pagination — Configuration for handling paginated responses, including modes and parameter names.
  • Timeout (ms) — Timeout in milliseconds to wait for the server response before aborting.

Output shape

a JSON object representing the updated audience details as returned from the API

Supports pagination options if the API response is paginated. Custom JSON in 'Custom Body' overrides standard fields if conflicts arise. Includes debug data in output if enabled.

Links

Discussion