Set default account campaign

Description

This endpoint allows to set the default campaign for the active account provided that a valid campaignId is passed and the account is part of that campaign.

HTTP Method

POST

Path

/account/campaign/{campaignId}

Authentication

Requires an authenticated user.

Parameters

Table 5.  Parameters for " Set default account campaign "

NameTypeValue TypeDescription
campaignIdPATHlongthe id of the campaign to be set as default. The user must already be part of that campaign.
forAccountIdFORMlong(Optional) the id of the account to be added in the campaign. The authenticated user is allowed to link an account to the provided campaign if it owns the campaign and if the campaign supports NFC badges
forDeviceKeyFORMString(Optional) A device public key can be provided instead of the accountId. If the device key is provided, the provided accountId is ignored and retrieved from device.
extRefIdFORMString(optional) the user id on a 3rd party system, processed only if a valid campaign id is provided
sendEmailIdFORMLong(optional) the id of the send email option. Please note that any value greater then 0 will override the campaign behavior. Currently we support - '0' (default behavior), '1' (no email sent), '2' (specific date and time), '3' (if present to event), '4' (send now)
sendEmailTimestampFORMLong(optional) an Unix timestamp, only valid for 'sendEmailId=2'
stopProcessingFORMBoolean(optional) if no messages should be send to this account for the context of this campaign
visitorCategoriesFORMString(optional) a comma separated value of object categories IDs or system paths. It will only work if the user was created in the campaign context and those categories are valid and designed to be applied to a campaign visitor.
staffExhibitorIdFORMLong(optional) the ID of the exhibitor this user should be linked as a staff.

Error Codes

10000 ( Account )

An unhandled exception has occured.

10022 ( Account )

The campaign does not exist.

10036 ( Account )

The account is not part of the provided campaign

150001 ( Common )

The endpoint requires an authenticated account

150002 ( Common )

Don't have the permission to execute this request

20015 ( Device )

The provided device is not valid

Response Schema

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xs:schema elementFormDefault="qualified" version="1.0" targetNamespace="http://xsd.poken.com" xmlns:tns="http://xsd.poken.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">

  <xs:element name="response">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="success" type="tns:Status" default="FAILURE" minOccurs="0"/>
        <xs:element name="error" type="tns:Error" nillable="true" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

  <xs:complexType name="Error">
    <xs:sequence>
      <xs:element name="code" type="xs:string"/>
      <xs:element name="description" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:simpleType name="Status">
    <xs:restriction base="xs:string">
      <xs:enumeration value="SUCCESS"/>
      <xs:enumeration value="FAILURE"/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Sample Response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response xmlns="http://xsd.poken.com">
	<success>SUCCESS</success>
</response>