Immediate operation elements

The immediate operation elements enable you to carry out a range of individual tasks without needing the authorization token required for other SOAP API activities. See Authentication elements and Authorization token for more details.

Instead, the userKey and apiKey tokens are used for authentication and, together with other required data, they are applied to carry out a single operation. This avoids the need for the three SOAP calls (authentication, service call, token invalidation) that are required for other service requests. See Contactsend SOAP API for more details.

Immediate operations have been designed to provide both scalability and performance enhancements to overcome the inherent limitations of triggerable campaigns. As a result, immediate operations should always be the preferred option. See Externally triggerable campaigns for more details.

From the 201306.1 release, a new set of immediate operation elements are available, which enable you to attach custom data content to a single outgoing message. As a result, these new elements add send custom data attachment functionality to existing immediate operations elements. All of these custom data attachment elements include the suffix CA (Custom Attachment) in their name.

From the 201502.1 (2.1.1) release, a new, enhanced set of immediate operations are available, known as immediate operation elements V2. As the original immediate operation elements have now been deprecated, we encourage you to adopt the V2 set as it expands, to benefit from the enhanced features as they become available. See Immediate operation elements V2 for more details.

Available elements

Click the appropriate link for more details about each relevant element:

Note:

All of the following elements have now been deprecated.

  • sendImmediateMessage

    Sends a single, one-shot message using the template associated with the IMMEDIATE campaign selected by the campaign identifier.

  • sendImmediateMessageSidCid

    Sends a single, one-shot message using the template associated with the IMMEDIATE campaign selected by the campaign identifier.

  • sendImmediateMessageSDataCData

    Sends a single, one-shot message using the template associated with the IMMEDIATE campaign selected by the campaign identifier/alias.

  • sendImmediateMessageSIdCData

    Sends a single, one-shot message using the template associated with the IMMEDIATE campaign selected by the campaign identifier/alias.

  • sendImmediateMessageSdataCAl

    Sends a single, one-shot message using the template associated with the IMMEDIATE campaign selected by the campaign ALIAS.

  • sendImmediateMessageSidCAl

    Sends a single, one-shot message using the template associated with the IMMEDIATE campaign selected by the campaign ALIAS.

  • sendImmediateMessageSDataCIdCA

    Sends a single, one-shot message using the template associated with the IMMEDIATE campaign selected by the campaign identifier.

  • sendImmediateMessageSidCidCA

    Sends a single, one-shot message using the template associated with the IMMEDIATE campaign selected by the campaign identifier.

  • sendImmediateMessageSDataCDataCA

    Sends a single, one-shot message using the template associated with the IMMEDIATE campaign selected by the campaign identifier/alias.

  • sendImmediateMessageSIdCDataCA

    Sends a single, one-shot message using the template associated with the IMMEDIATE campaign selected by the campaign identifier/alias.

  • sendImmediateMessageSdataCAlCA

    Sends a single, one-shot message using the template associated with the IMMEDIATE campaign selected by the campaign ALIAS.

  • sendImmediateMessageSidCAlCA

    Sends a single, one-shot message using the template associated with the IMMEDIATE campaign selected by the campaign ALIAS.


See also: