Id Tag / Create

post

https://{tenantUrl}/public-api/resources/id-tags/v2.0

Create new Id Tag

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

operatorId

integer | null

The operator ID for this resource.
Required for global admin tokens.
Optional for operator-scoped tokens (defaults to token's operator).

idTagUid

string

required

Token used for authorization

idLabel

string | null

Visual or other label that could be associated with the ID Tag

expireAt

date-time | null

status

string

enum

required

The status of the ID tag. Use it to disable or suspend a tag

enabled The tag is enabled and is accepted as authentication method
disabled The tag is disabled by the admin user and is not acceptable as authorization method
suspended The tag is suspended by the owner of the tag and is not acceptable as authorization method

Allowed:

type

string

enum

required

Allowed:

vehicleType

string | null

enum

Allowed:

paymentMethodId

string | null

deprecated

Use defaultPaymentOption instead.

The payment method that will be associated with the ID Tag.

For credit/debit cards the paymentMethodId should be provided
For Corporate billing - corporate:{id}
For Subscription - use "subscription" to use the user's active subscription
For Auto selection - use "auto" (recommended) or null (deprecated)
The "last used" concept has been replaced with "auto" selection which cycles through available payment methods.

defaultPaymentOption

string

The default payment option for this ID tag. Accepted values:

auto - Automated fallback sequence
A payment card ID - Specific registered payment card
corporate:{id} - Corporate billing account (replace {id} with the corporate billing ID)
subscription - User's active post-paid subscription

At charging time, if the chosen payment option doesn't apply to the session (e.g., corporate billing not eligible for the charge point, subscription not applicable), the platform falls back to the user's other available payment methods.

userId

integer | null

Associate the ID tag with a user account. If the user is not presented, the tag will not be authorized! It makes sense to prepare the tags in advance, in case there is another process/entity is going to later assign them!

externalId

string | null

partnerId

integer

The administrator accounts of the selected Partner will be able to edit and delete the specified ID tag

vehicleId

integer

Associate the ID tag with a vehicle.

Responses

201Id Tag created successfully

401Access token is missing or invalid

403You do not have permission to perform the action

422The payload you provided is invalid

429Too many requests. Please try again later. For more information, please check the rate limit headers X-RateLimit-*