Knowledge base

PMTA knowledge base›Block <signals>›Directive§ 11.1.6.2.7

customer-id

<signals>

Vendor customer ID — the line is no longer needed
in the configuration this is a linecustomer-idinside the block <signals>
A line that stopped being mandatory

The customer ID the api-key is associated with. Before PowerMTA 5.5 it had to be set if tracking was done by the engine. Since 5.5 it is not needed: the engine determines the account from the key itself.

The line is not declared deprecated, but there is no longer any point in it. It turns up in migrated configurations and in manual examples left over from earlier versions.

Removing it is safe — in version six it affects nothing.

The main trap is considering it mandatory because of old examples. In the manual itself, examples for neighboring lines still show customer-id 123, although this line’s own section says it is no longer needed. Reading the examples, it is easy to conclude that nothing works without it.
What the Hub does. It does not write it: we do not use export to external analytics, and even if we did, the line is not needed in version six.
Recommended values

The decision depends only on the version:

Version Line
before 5.5 mandatory for engine-side tracking
5.5 and later not needed, can be removed
The requirement before version 5.5 and its cancellation since 5.5 are from the manual (§ 11.1.6.2.7). The remark about examples in neighboring sections is ours.
Example configuration
# this is how it was before 5.5; in version six the line can be removed
<signals>
    engagement-tracking sparkpost
    customer-id 123</signals>
Examples in neighboring sections of the manual still show it — this is a legacy of earlier versions, not a requirement.
yellow — — directive names, blue — blocks. They are highlighted the same way in the text of the card.
▲

Common mistakes and problems

what people get wrong and how it ends1 mistake▶

Keeping the line, considering it mandatory

§ 11.1.6.2.7

What it costsIn version six it does nothing. There is no harm, but the configuration keeps a line the next reader will take for a needed one.
How to spot itThe line is there, the engine version is six.
How to do it rightDelete it.
Compatibility
PowerMTA 6.0
described in the manual of this version · platform: any
The vendor does not state the first version for every directive — there is no note here. The name also appears in the 5.0 edition of the manual.
Reference data
Syntax
customer-id <number>
Values
vendor customer ID
Applying
reload, no restart needed
Queue
will not touch what is already queued
Where to write it
<signals>
How many times
once in the block
Everything here comes from the manual, with the section.
Inheritance
There is no inheritance: the line lives inside <signals>, and there is one such block per node.
How to check on the node
Find the line in the configuration and make sure the version is six:
grep -rn "customer-id" /etc/pmta/ ; pmta show version 2>/dev/null | head -2
On version 5.5 and later the line can be deleted without consequences.
In the Hub
Cost of a mistake
safe: a wrong value breaks nothing
Scenarios
Prepare a node for sending