← Tools Reference

Courier

Courier integration (Communication, Marketing). Imported from open-connector.

API key10 toolshttps://api.courier.com
POST
courier_send_message
Send a Courier message to one or more recipients.

/send

2 parameters
ParamTypeRequiredDescription
messageobjectrequiredThe Courier message object passed to POST /send.
idempotencyKeystringoptionalThe optional Courier Idempotency-Key header value used to deduplicate a logical…
GET
courier_get_profile
Return a Courier user profile and preferences by user ID.

/profiles/{userId}

1 parameter
ParamTypeRequiredDescription
userIdstringrequiredThe Courier user ID associated with the profile.
POST
courier_merge_profile
Merge values into a Courier user profile or create it when missing.

/profiles/{userId}

2 parameters
ParamTypeRequiredDescription
userIdstringrequiredThe Courier user ID associated with the profile.
profileobjectoptionalThe Courier profile object to merge into the user profile.
DELETE
courier_delete_profile
Delete a Courier user profile by user ID.

/profiles/{userId}

1 parameter
ParamTypeRequiredDescription
userIdstringrequiredThe Courier user ID associated with the profile.
GET
courier_list_lists
List Courier subscription lists with optional cursor and pattern filters.

/lists

2 parameters
ParamTypeRequiredDescription
cursorstringoptionalThe Courier pagination cursor for the next page.
patternstringoptionalThe Courier list pattern filter.
GET
courier_get_list
Return a Courier subscription list by list ID.

/lists/{listId}

1 parameter
ParamTypeRequiredDescription
listIdstringrequiredThe Courier list ID.
PUT
courier_upsert_list
Create or replace a Courier subscription list.

/lists/{listId}

3 parameters
ParamTypeRequiredDescription
listIdstringrequiredThe Courier list ID.
namestringrequiredThe Courier subscription list name.
preferencesobjectoptionalThe Courier recipient preferences object.
DELETE
courier_delete_list
Delete a Courier subscription list by list ID.

/lists/{listId}

1 parameter
ParamTypeRequiredDescription
listIdstringrequiredThe Courier list ID.
GET
courier_list_list_subscriptions
List subscriptions for a Courier subscription list.

/lists/{listId}/subscriptions

2 parameters
ParamTypeRequiredDescription
listIdstringrequiredThe Courier list ID.
cursorstringoptionalThe Courier pagination cursor for the next page.
DELETE
courier_unsubscribe_list_subscriber
Unsubscribe one Courier user profile from a subscription list.

/lists/{listId}/subscriptions/{userId}

2 parameters
ParamTypeRequiredDescription
listIdstringrequiredThe Courier list ID.
userIdstringrequiredThe Courier user ID associated with the profile.