Disclaimer banner cps-icon-v2

This documentation applies to the Legacy platform. If your dashboard matches the screenshot shown here, please refer to the new platform documentation.

Disclaimer banner image
New documentation
Disclaimer banner image

Claim $PayByName Tag

API POST Fields (in addition to the Main Fields described in the Introduction)

Field Name
Claim $PayByName Tag
cmd
Descriptionclaim_pbn_tag
Required?Yes
tagid
DescriptionThe tag's unique ID (obtained from 'get_pbn_list'.
Required?Yes
name
DescriptionName for the tag; for example a value of 'Apple' would be the PayByName tag $Apple. Make sure to use the case you want the tag displayed with.
Required?Yes
Field NameDescriptionRequired?
Claim $PayByName Tag
cmdclaim_pbn_tagYes
tagidThe tag's unique ID (obtained from 'get_pbn_list'.Yes
nameName for the tag; for example a value of 'Apple' would be the PayByName tag $Apple. Make sure to use the case you want the tag displayed with.Yes

API Response

A successful call to this command will give you a result similar to this (JSON):
{
	"error":"ok",
	"result":[]
}