Stannp

Stannp integration (Marketing). Imported from open-connector.

API key10 toolshttps://api.stannp.com

GET

stannp_get_account_balance

Retrieve the Stannp account balance for the connected regional account.

/v1/accounts/balance

GET

stannp_list_recipients

List Stannp recipients, optionally filtered by group and paginated.

/v1/recipients/list

3 parameters

Param	Type	Required	Description
groupId	integer	optional	Optional group ID to filter recipients.
offset	integer	optional	Number of records to skip before returning results.
limit	integer	optional	Maximum number of records to return.

GET

stannp_get_recipient

Retrieve a single Stannp recipient by ID.

/v1/recipients/get/{recipientId}

1 parameter

Param	Type	Required	Description
recipientId	integer	required	ID of the Stannp recipient to retrieve.

POST

stannp_create_recipient

Create a Stannp recipient and optionally add it to a group.

/v1/recipients/new

19 parameters

Param	Type	Required	Description
groupId	integer	optional	Optional group ID to add the new recipient to.
title	string	optional	Recipient title, such as Mr, Mrs, or Dr.
firstname	string	optional	Recipient first name.
lastname	string	optional	Recipient last name.
company	string	optional	Recipient company name.
jobTitle	string	optional	Recipient job title.
address1	string	optional	Recipient address line 1.
address2	string	optional	Recipient address line 2.
address3	string	optional	Recipient address line 3.
city	string	optional	Recipient city.
county	string	optional	Recipient county, province, or state.
postcode	string	optional	Recipient postal code or ZIP code.
country	string	optional	Recipient ISO 3166-1 alpha-2 country code.
email	string	optional	Recipient email address.
phoneNumber	string	optional	Recipient phone number.
refId	string	optional	External reference ID for matching a recipient across systems.
onDuplicate	string	optional	Duplicate handling mode when Stannp finds an existing recipient.
testLevel	string	optional	Duplicate detection strategy used by Stannp.
customFields	object	optional	Custom Stannp recipient fields to send as top-level recipient parameters.

POST

stannp_delete_recipient

Permanently delete a Stannp recipient by ID.

/v1/recipients/delete

1 parameter

Param	Type	Required	Description
recipientId	integer	required	ID of the Stannp recipient to delete.

GET

stannp_list_groups

List Stannp recipient groups with optional offset and limit pagination.

/v1/groups/list

2 parameters

Param	Type	Required	Description
offset	integer	optional	Number of records to skip before returning results.
limit	integer	optional	Maximum number of records to return.

POST

stannp_create_group

Create an empty Stannp recipient group.

/v1/groups/new

1 parameter

Param	Type	Required	Description
name	string	required	Name of the new Stannp recipient group.

POST

stannp_add_recipients_to_group

Add one or more existing Stannp recipients to a recipient group.

/v1/groups/add/{groupId}

2 parameters

Param	Type	Required	Description
groupId	integer	required	ID of the Stannp group to update.
recipientIds	array	required	Stannp recipient IDs to add to the group.

POST

stannp_remove_recipients_from_group

Remove one or more existing Stannp recipients from a recipient group.

/v1/groups/remove/{groupId}

2 parameters

Param	Type	Required	Description
groupId	integer	required	ID of the Stannp group to update.
recipientIds	array	required	Stannp recipient IDs to remove from the group.

POST

stannp_validate_address

Validate and normalize a UK, US, or Canadian postal address with Stannp.

/v1/addresses/validate

10 parameters

Param	Type	Required	Description
company	string	optional	Company name.
address1	string	required	Address line 1.
address2	string	optional	Address line 2.
address3	string	optional	Address line 3.
city	string	optional	Address city.
postcode	string	optional	Address postal code. Recommended for accurate validation.
country	string	optional	ISO 3166-1 alpha-2 country code. Recommended for accurate validation.
state	string	optional	Two-letter US state abbreviation.
province	string	optional	Two-letter Canadian province abbreviation.
zipcode	string	optional	US or Canadian ZIP/postal code. Required by Stannp if city is absent.