SaveOrRemoveCampaignExternalId

RPC Configuration

Rpc Name:

Plain: SaveOrRemoveCampaignExternalId
Sha1: 8c579cc4a271f83d0b20ada10b3932804b5dada1

Rpc Call

RPCs can be called by their plain name or their SHA1 representation.

Rpc Parameters:

"building_id" : int,
"campaign_id" : int,
"external_id" : ?string = null 

Parameter Description

Saves, Updates or Removes an External ID of a Campaign. External Ids must be unique within the context.
@param int building_id The building-id the campaign belongs to.

@param ?string external_id The External Id with up to 128 Chars. If null is send, the External Id will be removed.

@return array|bool

Requires Login:

true

Requires Context:

Context

The context providing parameter can either be a contagt-id (8-Bytes, Alphaumeric) or an integer as a building id. The context parameter name should make the choice obviouse, the type has not to be defined manually.

true

Requires contextParamName:

building_id

Requires WriteAccess:

WriteAccess

Only accounts that have an explicit write access to the defined context can execute this RPC, no matter if the authentication level matches or not.

true

Requires AuthenticationLevel:

Context

Authentication levels allow the SuperUser to define a by-RPC granular access configuration. If RPCs are chained in a single unified call and lenient is enabled, all allowed RPCs will be executed, while execution will fail entirely with lenient set to false.

LOCAL_ADMINISTRATOR

Requires Subbuilding Merge Strategy:

SUBBUILDING_ONLY

Cache Configuration

Response Cache

All writing RPCs are not Cacheable, also Caching will be disabled by the paramters nocache and readonly.

Cache enabled:

false

Sample Request

->

{
    "building_id": 131,
    "campaign_id": 15,
    "external_id": "Hellloooww"
}

<-

false