HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Id Tag / Update

Update a Id Tag

Path Params
integer
required
Body Params
string

Token used for authorization

string | null

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

date-time | null
string
enum

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:
string
enum
Allowed:
string | null
enum
Allowed:
string | null

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.
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!

string | null
integer | null

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

Responses

Language
Credentials
Bearer
API Token
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json