Skip to content

SSC

API Service Supporter Create#

Occurence: A new supporter record has been created using using an API call from external software.

Key Data: Any of the data relating specifically to the new supporter record. Depending on the export group used, not all possible fields may be included in the data.

Export file columns#

Account ID#

Identifies the subaccount this item belongs to

Example: 94

Supporter ID#

The unique numerical database identifier for a supporter.

Example: 212200 Default: 0

Supporter Email#

The primary email address of a supporter, which will typically be used as the basis for identifying a unique supporter to which any transactions will be associated. <= 500 characters

Example: otto.nv@example.com

Date Created#

The date a supporter was created. [ISO 8601 format date]

Example: 2024-12-01

Date Modified#

The date a supporter was last modified. [ISO 8601 format date]

Example: 2024-12-01

Campaign Number#

No output for this transaction type.

Campaign Type#

SSC

Campaign ID#

No output for this transaction type.

Campaign Data 1#

No output for this transaction type.

Campaign Data 2#

No output for this transaction type.

Campaign Data 3#

No output for this transaction type.

Campaign Data 4#

No output for this transaction type.

Campaign Data 5#

No output for this transaction type.

Campaign Data 6#

No output for this transaction type.

Campaign Data 7#

No output for this transaction type.

Campaign Data 8#

No output for this transaction type.

Campaign Data 9#

No output for this transaction type.

Campaign Data 10#

No output for this transaction type.

Campaign Data 11#

No output for this transaction type.

Campaign Data 12#

No output for this transaction type.

Campaign Data 13#

No output for this transaction type.

Campaign Data 14#

No output for this transaction type.

Campaign Data 15#

No output for this transaction type.

Campaign Data 16#

No output for this transaction type.

Campaign Data 17#

No output for this transaction type.

Campaign Data 18#

No output for this transaction type.

Campaign Data 19#

No output for this transaction type.

Campaign Data 20#

No output for this transaction type.

Campaign Data 21#

No output for this transaction type.

Campaign Data 22#

No output for this transaction type.

Campaign Data 23#

No output for this transaction type.

Campaign Data 24#

No output for this transaction type.

Campaign Data 25#

No output for this transaction type.

Campaign Data 26#

No output for this transaction type.

Campaign Data 27#

No output for this transaction type.

Campaign Data 28#

No output for this transaction type.

Campaign Data 29#

No output for this transaction type.

Campaign Data 30#

No output for this transaction type.

Campaign Data 31#

No output for this transaction type.

Campaign Data 32#

No output for this transaction type.

Campaign Data 33#

No output for this transaction type.

Campaign Data 34#

No output for this transaction type.

Campaign Data 35#

No output for this transaction type.

External Reference 1#

When used outside of API page processing, this field may be populated using the URL parameters utm_source or by the generic parameter en_txn1. Content will be automatically truncated if the maximum length is exceeded, and the three last characters replaced by '...' to indicate that a string has been truncated <= 100 characters

External Reference 2#

When used outside of API page processing, this field may be populated using the URL parameters utm_medium or by the generic parameter en_txn2. Content will be automatically truncated if the maximum length is exceeded, and the three last characters replaced by '...' to indicate that a string has been truncated <= 100 characters

External Reference 3#

When used outside of API page processing, this field may be populated using the URL parameters utm_campaign or by the generic parameter en_txn3. Note: Content will be automatically truncated if the maximum length is exceeded, and the three last characters replaced by '...' to indicate that a string has been truncated <= 100 characters

External Reference 4#

When used outside of API page processing, this field may be populated using the URL parameters utm_content or by the generic parameter en_txn4. Note: Content will be automatically truncated if the maximum length is exceeded, and the three last characters replaced by '...' to indicate that a string has been truncated <= 100 characters

External Reference 5#

When used outside of API page processing, this field may be populated using the URL parameters utm_term or by the generic parameter en_txn5. Note: Content will be automatically truncated if the maximum length is exceeded, and the three last characters replaced by '...' to indicate that a string has been truncated <= 100 characters

External Reference 6#

When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn6. When added as a page parameter, the field is referred to as Campaign Reference 1 in the dashboard settings. If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the three last characters replaced by '...' to indicate that a string has been truncated <= 100 characters

External Reference 7#

When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn7. When added as a page parameter, the field is referred to as Campaign Reference 2 in the dashboard settings. If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the three last characters replaced by '...' to indicate that a string has been truncated <= 100 characters

External Reference 8#

When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn8. When added as a page parameter, the field is referred to as Campaign Reference 3 in the dashboard settings. If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the three last characters replaced by '...' to indicate that a string has been truncated <= 100 characters

External Reference 9#

When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn9. When added as a page parameter, the field is referred to as Campaign Reference 4 in the dashboard settings. If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the three last characters replaced by '...' to indicate that a string has been truncated <= 100 characters

External Reference 10#

When used outside of API page processing, this field may also be populated by a user-defined page property [Page > Admin > Campaign References], or by the url query parameter en_txn10. When added as a page parameter, the field is referred to as Campaign Reference 5 in the dashboard settings. If a value is presented in both places, the url query parameter will take precedence. Note: Content will be automatically truncated if the maximum length is exceeded, and the three last characters replaced by '...' to indicate that a string has been truncated <= 100 characters

Origin Source#

The name of this origin source as specified by the user. The available Origin Sources can be managed through the Pages > Components > Origin Source section in the dashboard.

Example: ECF

Email Address#

The primary email address of a supporter, which will typically be used as the basis for identifying a unique supporter to which any transactions will be associated. <= 500 characters

Example: otto.nv@example.com

First Name#

A supporter's first name <= 500 characters

Example: Otto

Middle Name#

A supporter's middle name <= 500 characters

Example: Niemand

Last Name#

A supporter's last name <= 500 characters

Example: Normalverbraucher

Address 1#

The first line of the supporter's address <= 1000 characters

Address 2#

The second line of the supporter's address <= 1000 characters

Address 3#

The third line of the supporter's address <= 1000 characters

City#

The city in a supporter's address <= 500 characters

Example: Musterstadt

Region#

The supporter's region, state, county, province or similar <= 500 characters

Example: Musterregion

Country#

The supporter's country <= 500 characters

Example: DE

Phone Number#

The primary phone number for a supporter <= 200 characters

Example: +49 4066969123