Skip to content
  • Auto
  • Light
  • Dark
Talk to an expert

Set Ingest Aliases

Create or update customer ingest aliases
client.v1.customers.setIngestAliases(CustomerSetIngestAliasesParamsparams, RequestOptionsoptions?): void
post/v1/customers/{customer_id}/setIngestAliases

Sets the ingest aliases for a customer. Ingest aliases can be used in the customer_id field when sending usage events to Metronome. This call is idempotent. It fully replaces the set of ingest aliases for the given customer.

Parameters
paramscustomer_idstringingest_aliasesarrayCustomerSetIngestAliasesParams
Hide ParametersShow Parameters
customer_idstring

Path param:

formatuuid
ingest_aliasesarray
Array<string>

Body param:

import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

await client.v1.customers.setIngestAliases({
  customer_id: 'd7abd0cd-4ae9-4db7-8676-e986a4ebd8dc',
  ingest_aliases: ['[email protected]'],
});