Courier (Independent Publisher) (Preview)

Courier is a service and web studio for development teams to manage all product-triggered communications (email, chat, in-app, SMS, push, etc.) in one place. Courier is built for developers who want to deliver an exceptional notification experience.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following:      -   Azure Government regions      -   Azure China regions      -   US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following:      -   US Government (GCC)      -   US Government (GCC High)      -   China Cloud operated by 21Vianet      -   US Department of Defense (DoD)

Contact
Name	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Connector Metadata
Publisher	Troy Taylor
Website	https://www.courier.com/
Privacy policy	https://www.courier.com/privacy/
Categories	Communication;Social Media

Creating a connection

The connector supports the following authentication types:

Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
Token (in the form 'Bearer yourToken')	securestring	The Token (in the form 'Bearer yourToken') for this api	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add subscriber(s) to a list	Add additional subscribers to a list.
Add users to a bulk job	Ingest user data into a bulk job.
Archive a message	Request that a message be archived.
Create a brand	Creates a new brand from the settings provided.
Create a bulk job	Creates a bulk job for the message parameters provided.
Create a profile	Merge the supplied values with an existing profile or create a new profile if one doesn't already exist.
Create or update an audience	Creates or updates an audience based on the parameters and filters provided.
Delete a list	Deletes a list by list identifier.
Delete a profile	Deletes the specified recipient profile.
Delete an audience	Deletes the specified recipient audience.
Get a brand	Retrieve a specific brand by identifier.
Get a bulk job	Retrieve the information about a bulk job.
Get a bulk job's users	Retrieve the users of a bulk job.
Get a list	Retrieve the items of a list.
Get a message	Retrieve the status of a message.
Get a message's content	Retrieve the content of a previously sent message.
Get a message's history	Retrieve the events of a previously sent message.
Get a profile	Retrieves the specified recipient profile.
Get all audit events	Retrieve a list of audit events.
Get all recipient lists	Retrieve a list of all the recipient lists.
Get an audience	Returns the specified audience by identifier.
Get an audit event	Retrieve a specific audit event by identifier.
Get list's subscriptions	Retrieves the subscriptions for a list.
List all audiences	Retrieve all audiences associated with your account.
List audience members	Retrieve a list of members of an audience.
List brands	Retrieve a list of brands.
List messages	Retrieve the statuses of previously sent messages.
List notifications	Retrieves a list of notifications.
Restore a list	Restores an existing list by identifier.
Run a bulk job	Start running a bulk job.
Run a templated automation	Invoke an automation run from an automation template.
Run an ad-hoc automation	Invoke an automation in an ad-hoc run.
Send a message	Sends a message to one or more recipients.
Unsubscribe a user from a list	Deletes a subscription to a list by list and recipient identifiers.
Update a list	Creates or replaces an existing list with the supplied values.
Update a profile	Updates on a portion of a profile.

Add subscriber(s) to a list

Operation ID:

ListSubscribersPost

Add additional subscribers to a list.

Parameters

Name	Key	Required	Type	Description
List ID	list_id	True	string	The list identifier.
Recipient ID	recipientId		string	The recipient identifier.

Returns

response

string

Add users to a bulk job

Operation ID:

BulkJobUsersPost

Ingest user data into a bulk job.

Parameters

Name	Key	Required	Type	Description
Job ID	job_id	True	string	The job identifier.
Recipient	recipient		string	The recipient.

Returns

response

string

Archive a message

Operation ID:

MessagePut

Request that a message be archived.

Parameters

Name	Key	Required	Type	Description
Request ID	request_id	True	string	The request identifier.

Returns

response

string

Create a brand

Operation ID:

BrandPost

Creates a new brand from the settings provided.

Parameters

Name	Key	Required	Type	Description
ID	id		string	The identifier.
Name	name	True	string	The name.
Primary	primary		string	The primary.
Secondary	secondary		string	The secondary.
Tertiary	tertiary		string	The tertiary.
Bar Color	barColor		string	The bar color.
HREF	href		string	The HREF.
Image	image		string	The image.
Markdown	markdown		string	The markdown.
URL	url		string	The URL address.
URL	url		string	The URL address.
URL	url		string	The URL address.
URL	url		string	The URL address.
URL	url		string	The URL address.
Disable Message Icon	disableMessageIcon		boolean	Whether to disable message icon.
Placement	placement		string	The placement.
Items	items		array of string	The items.

Returns

response

string

Create a bulk job

Operation ID:

BulkJobPost

Creates a bulk job for the message parameters provided.

Parameters

Name	Key	Required	Type	Description
Event	event		string	The event.
Brand	brand		string	The brand.
Template	template		string	The template.
Brand ID	brand_id		string	The brand identifier.
Method	method		string	The method.
Channels	channels		array of string	The channels.
Event	event		string	The event.
Tags	tags		array of string	The tags.
Trace ID	trace_id		string	The trace identifier.
Campaign	campaign		string	The campaign.
Content	content		string	The content.
Medium	medium		string	The medium.
Source	source		string	The source.
Term	term		string	The term.

Returns

Name	Path	Type	Description
Job ID	jobId	string	The job identifier.

Create a profile

Operation ID:

ProfilePost

Merge the supplied values with an existing profile or create a new profile if one doesn't already exist.

Parameters

Name	Key	Required	Type	Description
Recipient ID	recipient_id	True	string	The recipient identifier.
Email	email		string	The email address.
Phone Number	phone_number		string	The phone number.
Formatted	formatted		string	The formatted address.
Street Address	street_address		string	The street address.
Locality	locality		string	The locality.
Region	region		string	The region.
Postal Code	postal_code		string	The postal code.
Country	country		string	The country.
Birth Date	birthdate		string	The birth date.
Email Verified	email_verified		boolean	Whether email verified.
Phone Number Verified	phone_number_verified		boolean	Whether phone number verified.
Given Name	given_name		string	The given name.
Middle Name	middle_name		string	The middle name.
Family Name	family_name		string	The family name.
Preferred Name	preferred_name		string	The preferred name.
Gender	gender		string	The gender.
Locale	locale		string	The locale.
Picture	picture		string	The picture.
Profile	profile		string	The profile.
Sub	sub		string	The sub.
Updated At	updated_at		string	When updated at.
Website	website		string	The website.
Zone Info	zoneinfo		string	The zone info.
Named User	named_user		string	The named user.
Device Types	device_types		array of string	The device types.
APN	apn		string	The APN.
Target ARN	target_arn		string	The target ARN.
Channel ID	channel_id		string	The channel identifier.
User ID	user_id		string	The user identifier.
Token	token		string	The token.
Tokens	tokens		array of string	The tokens.
Facebook PS ID	facebookPSID		string	The Facebook PS identifier.
Firebase Token	firebaseToken		string	The Firebase token.
From	from		string	The From.
ID	id		string	The identifier.
User ID	user_id		string	The user identifier.
Conversation ID	conversation_id		string	The conversation identifier.
Tenant ID	tenant_id		string	The tenant identifier.
Service URL	service_url		string	The service URL address.
OneSignal Player ID	oneSignalPlayerID		string	The OneSignal Player identifier.
Access Token	access_token		string	The access token.
Channel	channel		string	The channel.
Email	email		string	The email address.
User ID	user_id		string	The user identifier.
URL	url		string	The URL address.
URL	url		string	The URL address.
Method	method		string	The methods.
Mode	mode		string	The mode.
Username	username		string	The username.
Password	password		string	The password.
Token	token		string	The token.
Profile	profile		string	The profile.

Returns

response

string

Create or update an audience

Operation ID:

AudiencePut

Creates or updates an audience based on the parameters and filters provided.

Parameters

Name	Key	Required	Type	Description
Audience ID	audience_id	True	string	The audience identifier.
Name	name		string	The name.
Path	path		string	The path.
Operator	operator		string	The operator.
Value	value		string	The value.
Path	path		string	The path.
Operator	operator		string	The operator.
Value	value		string	The value.

Returns

Name	Path	Type	Description
ID	id	string	The identifier.
Name	name	string	The name.
Description	description	string	The description.
Operator	filter.operator	string	The operator.
Value	filter.value	string	The value.
Path	filter.path	string	The path.
Filters	filter.filters	array of object
Path	filter.filters.path	string	The path.
Operator	filter.filters.operator	string	The operator.
Value	filter.filters.value	string	The value.

Delete a list

Operation ID:

ListDelete

Deletes a list by list identifier.

Parameters

Name	Key	Required	Type	Description
List ID	list_id	True	string	The list identifier.

Returns

response

string

Delete a profile

Operation ID:

ProfileDelete

Deletes the specified recipient profile.

Parameters

Name	Key	Required	Type	Description
Recipient ID	recipient_id	True	string	The recipient identifier.

Returns

Name	Path	Type	Description
Status	status	string	The status.

Delete an audience

Operation ID:

AudienceDelete

Deletes the specified recipient audience.

Parameters

Name	Key	Required	Type	Description
Audience ID	audience_id	True	string	The audience identifier.

Returns

response

string

Get a brand

Operation ID:

BrandGet

Retrieve a specific brand by identifier.

Parameters

Name	Key	Required	Type	Description
Brand ID	brand_id	True	string	The brand identifier.

Returns

Name	Path	Type	Description
Created	created	integer	When created.
ID	id	string	The identifier.
Name	name	string	The name.
Published	published	integer	When published.
Updated	updated	integer	The updated.
Version	version	string	The version.
Primary	settings.colors.primary	string	The primary.
Secondary	settings.colors.secondary	string	The secondary.
Tertiary	settings.colors.tertiary	string	The tertiary.
Bar Color	settings.email.header.barColor	string	The bar color.
HREF	settings.email.header.logo.href	string	The HREF.
Image	settings.email.header.logo.image	string	The image.
Markdown	settings.email.footer.markdown	string	The markdown.
URL	settings.email.footer.social.facebook.url	string	The URL address.
URL	settings.email.footer.social.instagram.url	string	The URL address.
URL	settings.email.footer.social.linkedin.url	string	The URL address.
URL	settings.email.footer.social.medium.url	string	The URL address.
URL	settings.email.footer.social.twitter.url	string	The URL address.
Disable Message Icon	settings.inapp.disableMessageIcon	boolean	Whether to disable message icon.
Placement	settings.inapp.placement	string	The placement.
Items	snippets.items	array of string	The items.

Get a bulk job

Operation ID:

BulkJobGet

Retrieve the information about a bulk job.

Parameters

Name	Key	Required	Type	Description
Job ID	job_id	True	string	The job identifier.

Returns

Name	Path	Type	Description
Event	job.definition.event	string	The event.
Enqueued	job.enqueued	integer	The enqueued.
Failures	job.failures	integer	The failures.
Received	job.received	integer	When received.
Status	job.status	string	The status.

Get a bulk job's users

Operation ID:

BulkJobUsersGet

Retrieve the users of a bulk job.

Parameters

Name	Key	Required	Type	Description
Job ID	job_id	True	string	The job identifier.

Returns

Name	Path	Type	Description
Items	items	array of object
Recipient	items.recipient	string	The recipient.
Email	items.email	string	The email address.
Locale	items.locale	string	The locale.
Cursor	paging.cursor	string	The cursor.
More	paging.more	boolean	Whether there is more.

Get a list

Operation ID:

ListGet

Retrieve the items of a list.

Parameters

Name	Key	Required	Type	Description
List ID	list_id	True	string	The list identifier.

Returns

Name	Path	Type	Description
Created	created	string	When created.
ID	id	string	The identifier.
Name	name	string	The name.
Updated	updated	string	The updated.

Get a message

Operation ID:

MessageGet

Retrieve the status of a message.

Parameters

Name	Key	Required	Type	Description
Message ID	message_id	True	string	The message identifier.

Returns

Name	Path	Type	Description
ID	id	string	The identifier.
Status	status	string	The status.
Enqueued	enqueued	integer	The enqueued.
Sent	sent	integer	The sent.
Delivered	delivered	integer	The delivered.
Opened	opened	integer	The opened.
Clicked	clicked	integer	The clicked.
Recipient	recipient	string	The recipient.
Event	event	string	The event.
Notification	notification	string	The notification.
Error	error	string	The error.
Reason	reason	string	The reason.
Providers	providers	array of object
Sent	providers.sent	integer	The sent.
Delivered	providers.delivered	integer	The delivered.
Clicked	providers.clicked	integer	The clicked.
Opened	providers.opened	integer	The opened.
Error	providers.error	string	The error.
Provider	providers.provider	string	The provider.
Status	providers.status	string	The status.

Get a message's content

Operation ID:

MessageContentGet

Retrieve the content of a previously sent message.

Parameters

Name	Key	Required	Type	Description
Message ID	message_id	True	string	The message identifier.

Returns

Name	Path	Type	Description
Results	results	array of object
Channel	results.channel	string	The channel.
Channel ID	results.channel_id	string	The channel identifier.
HTML	results.content.html	string	The HTML.
Subject	results.content.subject	string	The subject.
Text	results.content.text	string	The text.
Blocks	results.content.blocks	array of object
Type	results.content.blocks.type	string	The type.
Text	results.content.blocks.text	string	The text.

Get a message's history

Operation ID:

MessageHistoryGet

Retrieve the events of a previously sent message.

Parameters

Name	Key	Required	Type	Description
Message ID	message_id	True	string	The message identifier.
Type	type		string	The type.

Returns

Name	Path	Type	Description
Results	results	array of object
Name	results.data.name	string	The name.
Event	results.event	string	The event.
Recipient	results.recipient	string	The recipient.
TS	results.ts	integer	The TS.
Type	results.type	string	The type.
Event ID	results.event_id	string	The event identifier.
Notification ID	results.notification_id	string	The notification identifier.
ID	results.channel.id	string	The identifier.
ID	results.integration.id	string	The identifier.
Provider	results.integration.provider	string	The provider.

Get a profile

Operation ID:

ProfileGet

Retrieves the specified recipient profile.

Parameters

Name	Key	Required	Type	Description
Recipient ID	recipient_id	True	string	The recipient identifier.

Returns

Name	Path	Type	Description
Email	profile.email	string	The email address.
Phone Number	profile.phone_number	string	The phone number.

Get all audit events

Operation ID:

AuditEventsGet

Retrieve a list of audit events.

Parameters

Name	Key	Required	Type	Description
Cursor	cursor		string	The cursor.

Returns

Name	Path	Type	Description
Cursor	paging.cursor	string	The cursor.
More	paging.more	boolean	Whether there is more.
Results	results	array of object
Audit Event ID	results.auditEventId	string	The audit event identifier.
ID	results.actor.id	string	The identifier.
Email	results.actor.email	string	The email address.
ID	results.target.id	string	The identifier.
Email	results.target.email	string	The email address.
Source	results.source	string	The source.
Timestamp	results.timestamp	string	The timestamp.
Type	results.type	string	The type.

Get all recipient lists

Operation ID:

ListsGet

Retrieve a list of all the recipient lists.

Returns

Name	Path	Type	Description
Cursor	paging.cursor	string	The cursor.
More	paging.more	boolean	Whether there is more.
Results	results	array of object
Created	results.created	string	When created.
ID	results.id	string	The identifier.
Name	results.name	string	The name.
Updated	results.updated	string	When updated.

Get an audience

Operation ID:

AudienceGet

Returns the specified audience by identifier.

Parameters

Name	Key	Required	Type	Description
Audience ID	audience_id	True	string	The audience identifier.

Returns

Name	Path	Type	Description
ID	id	string	The identifier.
Name	name	string	The name.
Description	description	string	The description.
Operator	filter.operator	string	The operator.
Value	filter.value	string	The value.
Path	filter.path	string	The path.

Get an audit event

Operation ID:

AuditEventGet

Retrieve a specific audit event by identifier.

Parameters

Name	Key	Required	Type	Description
Audit Event ID	audit-event-id	True	string	The audit event identifier.

Returns

Name	Path	Type	Description
Audit Event ID	auditEventId	string	The audit event identifier.
ID	actor.id	string	The identifier.
Email	actor.email	string	The email address.
ID	target.id	string	The identifier.
Email	target.email	string	The email address.
Source	source	string	The source.
Timestamp	timestamp	string	The timestamp.
Type	type	string	The type.

Get list's subscriptions

Operation ID:

ListSubscriptionsGet

Retrieves the subscriptions for a list.

Parameters

Name	Key	Required	Type	Description
List ID	list_id	True	string	The list identifier.
Cursor	cursor		string	The cursor.

Returns

Name	Path	Type	Description
Cursor	paging.cursor	string	The cursor.
More	paging.more	boolean	Whether there is more.
Items	items	array of object
Recipient ID	items.recipientId	string	The recipient identifier.
Created	items.created	string	When created.

List all audiences

Operation ID:

AudiencesGet

Retrieve all audiences associated with your account.

Parameters

Name	Key	Required	Type	Description
Cursor	cursor		string	The cursor.

Returns

Name	Path	Type	Description
Items	items	array of object
ID	items.id	string	The identifier.
Name	items.name	string	The name.
Description	items.description	string	The description.
Operator	items.filter.operator	string	The operator.
Value	items.filter.value	string	The value.
Path	items.filter.path	string	The path.
Cursor	paging.cursor	string	The cursor.
More	paging.more	boolean	Whether there is more.

List audience members

Operation ID:

AudienceMembersGet

Retrieve a list of members of an audience.

Parameters

Name	Key	Required	Type	Description
Audience ID	audience_id	True	string	The audience identifier.
Cursor	cursor		string	The cursor.

Returns

Name	Path	Type	Description
Items	items	array of object
Member ID	items.member_id	string	The member identifier.
Added At	items.added_at	string	When added at.
Audience ID	items.audience_id	string	The audience identifier.
Audience Version	items.audience_version	integer	The audience version.
Reason	items.reason	string	The reason.
Cursor	paging.cursor	string	The cursor.
More	paging.more	boolean	Whether there is more.

List brands

Operation ID:

BrandsGet

Retrieve a list of brands.

Parameters

Name	Key	Required	Type	Description
Cursor	cursor		string	The cursor.

Returns

Name	Path	Type	Description
Cursor	paging.cursor	string	The cursor.
More	paging.more	boolean	Whether there is more.
Results	results	array of object
Created	results.created	integer	When created.
ID	results.id	string	The identifier.
Name	results.name	string	The name.
Published	results.published	integer	When published.
Updated	results.updated	integer	When updated.
Version	results.version	string	The version.
Primary	results.settings.colors.primary	string	The primary.
Secondary	results.settings.colors.secondary	string	The secondary.
Tertiary	results.settings.colors.tertiary	string	The tertiary.
Bar Color	results.settings.email.header.barColor	string	The bar color.
HREF	results.settings.email.header.logo.href	string	The HREF.
Image	results.settings.email.header.logo.image	string	The image.
Markdown	results.settings.email.footer.markdown	string	The markdown.
URL	results.settings.email.footer.social.facebook.url	string	The URL address.
URL	results.settings.email.footer.social.instagram.url	string	The URL address.
URL	results.settings.email.footer.social.linkedin.url	string	The URL address.
URL	results.settings.email.footer.social.medium.url	string	The URL address.
URL	results.settings.email.footer.social.twitter.url	string	The URL address.
Disable Message Icon	results.settings.inapp.disableMessageIcon	boolean	Whether to disable message icon.
Placement	results.settings.inapp.placement	string	The placement.
Items	results.snippets.items	array of string	The items.

List messages

Operation ID:

MessagesGet

Retrieve the statuses of previously sent messages.

Parameters

Name	Key	Required	Type	Description
Archived	archived		boolean	Whether archived.
Cursor	cursor		string	The cursor.
Event	event		string	The event.
List	list		string	The list.
Message ID	messageId		string	The message identifier.
Notification	notification		string	The notification.
Recipient	recipient		string	The recipient.
Status	status		string	The status.
Tags	tags		string	The tags.

Returns

Name	Path	Type	Description
Cursor	paging.cursor	string	The cursor.
More	paging.more	boolean	Whether there is more.
Results	results	array of object
ID	results.id	string	The identifier.
Status	results.status	string	The status.
Enqueued	results.enqueued	integer	The enqueued.
Sent	results.sent	integer	The sent.
Delivered	results.delivered	integer	The delivered.
Opened	results.opened	integer	The opened.
Clicked	results.clicked	integer	The clicked.
Recipient	results.recipient	string	The recipient.
Event	results.event	string	The event.
Notification	results.notification	string	The notification.
Error	results.error	string	The error.
Reason	results.reason	string	The reason.

List notifications

Operation ID:

NotificationsGet

Retrieves a list of notifications.

Parameters

Name	Key	Required	Type	Description
Cursor	cursor		string	The cursor.

Returns

Name	Path	Type	Description
Cursor	paging.cursor	string	The cursor.
More	paging.more	boolean	Whether there is more.
Results	results	array of object
Created At	results.created_at	integer	When created at.
ID	results.id	string	The identifier.
Data	results.tags.data	array of object
ID	results.tags.data.id	string	The identifier.
Name	results.tags.data.name	string	The name.
Title	results.title	string	The title.
Updated At	results.updated_at	integer	When updated at.

Restore a list

Operation ID:

ListRestorePut

Restores an existing list by identifier.

Parameters

Name	Key	Required	Type	Description
List ID	list_id	True	string	The list identifier.

Returns

response

string

Run a bulk job

Operation ID:

BulkJobRunPost

Start running a bulk job.

Parameters

Name	Key	Required	Type	Description
Job ID	job_id	True	string	The job identifier.

Returns

response

object

Run a templated automation

Operation ID:

AutomationTemplatedPost

Invoke an automation run from an automation template.

Parameters

Name	Key	Required	Type	Description
Template ID	templateId	True	string	The template identifier.
Brand	brand		string	The brand.
Template	template		string	The template.
Recipient	recipient		string	The recipient.

Returns

Name	Path	Type	Description
Run ID	runId	string	The run identifier.

Run an ad-hoc automation

Operation ID:

AutomationAdHocPost

Invoke an automation in an ad-hoc run.

Parameters

Name	Key	Required	Type	Description
Cancelation Token	cancelation_token		string	The cancellation token.
Brand	brand		string	The brand.
Template	template		string	The template.
Recipient	recipient		string	The recipient.

Returns

Name	Path	Type	Description
Run ID	runId	string	The run identifier.

Send a message

Operation ID:

MessageSendPost

Sends a message to one or more recipients.

Parameters

Name	Key	Required	Type	Description
Idempotency	idempotency	True	string	The idempotency key.
Title	title		string	The title.
Body	body		string	The body.
User ID	user_id		string	The user identifier.
List ID	list_id		string	The list identifier.
Audience ID	audience_id		string	The audience identifier.
Email	email		string	The email address.
Phone Number	phone_number		string	The phone number.
Locale	locale		string	The locale.

Returns

Name	Path	Type	Description
Request ID	requestId	string	The request identifier.

Unsubscribe a user from a list

Operation ID:

ListSubscribeDelete

Deletes a subscription to a list by list and recipient identifiers.

Parameters

Name	Key	Required	Type	Description
List ID	list_id	True	string	The list identifier.
Recipient ID	recipient_id	True	string	The recipient identifier.

Returns

response

string

Update a list

Operation ID:

ListPut

Creates or replaces an existing list with the supplied values.

Parameters

Name	Key	Required	Type	Description
List ID	list_id	True	string	The list identifier.
Name	name		string	The name.

Returns

response

string

Update a profile

Operation ID:

ProfilePatch

Updates on a portion of a profile.

Parameters

Name	Key	Required	Type	Description
Recipient ID	recipient_id	True	string	The recipient identifier.
Operation	op		string	The operation.
Path	path		string	The path.
Value	value		string	The value.

Returns

Name	Path	Type	Description
Status	status	string	The status.

Definitions

string

This is the basic data type 'string'.

object

This is the type 'object'.