Cardly

cardly

Cardly helps businesses create great engagement with customers by getting out of inboxes and into mailboxes.

Marketing Automation Customer Appreciation Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (20)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create Contact ListCARDLY_CREATE_CONTACT_LISTAcción

Tool to add a new contact list. use after defining name and optional custom fields, before populating the list with contacts.

Parámetros de entrada

namestringObligatorio
A short, unique name for this contact list.
fieldsobject[]
Custom fields to add to this list. New fields will be created; existing fields (matched by name) updated.
descriptionstring
Free-text description of this contact list.

Parámetros de salida

dataobjectObligatorio
The newly created contact list.
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Standard API status object.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create WebhookCARDLY_CREATE_WEBHOOKAcción

Tool to create a new webhook subscription. use when you need cardly to notify your application via http post for specific events.

Parámetros de entrada

eventsstring[]Obligatorio
List of event names this webhook subscribes to; only notifications for these events will be sent.
metadataobject
Arbitrary key/value pairs to attach to this webhook for user-defined metadata.
targetUrlstringObligatorio
The URL this webhook will send POST requests to once one of the subscribed events is triggered. Must be a valid HTTPS endpoint.
descriptionstring
Free-text description of what this webhook is for.

Parámetros de salida

dataobjectObligatorio
The newly created webhook object.
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Standard API status object.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Invitation by EmailCARDLY_DELETE_INVITATION_BY_EMAILAcción

Tool to delete an invitation by email address. use when you need to invalidate an outstanding invitation immediately.

Parámetros de entrada

emailstringObligatorio
The email address of the invitation to delete.

Parámetros de salida

dataobjectObligatorio
Details of the deleted invitation.
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status metadata.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete WebhookCARDLY_DELETE_WEBHOOKAcción

Tool to delete a webhook. use after confirming the webhook id to immediately cease all activity and event subscriptions for that webhook.

Parámetros de entrada

idstringObligatorio
The unique ID of the webhook to delete.

Parámetros de salida

dataobjectObligatorio
The webhook object that was deleted
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status object
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Generate PreviewCARDLY_GENERATE_PREVIEWAcción

Tool to generate a low-quality, watermarked preview document for a card. use after confirming artwork and template details to estimate costs and delivery.

Parámetros de entrada

styleobject
Global style overrides (optional)
senderobject
Sender details (provide all fields if specifying)
artworkstringObligatorio
Artwork UUID or slug to preview
messagesobject
Message overrides when not using a template
shipToMeboolean
True to send a blank envelope back to sender
templatestring
Template ID for variable substitution (optional)
recipientobjectObligatorio
Envelope recipient details
variablesobject
Key/value map of template variables to inject
shippingMethodstringenum
Shipping method (per-region support varies)
standardtrackedexpress
requestedArrivalstring
Desired arrival date (ISO 8601) for estimates
purchaseOrderNumberstring
Reference number for internal tracking

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ArtworkCARDLY_LIST_ARTWORKAcción

Tool to retrieve the currently available artwork for your organisation. use when you need to list and paginate artwork items, optionally filtering to only your own artwork.

Parámetros de entrada

limitinteger
Maximum number of artwork items to return
offsetinteger
Number of records to skip before returning results
ownOnlyboolean
If true, return only artwork owned by your organisation; defaults to false

Parámetros de salida

dataobjectObligatorio
Paginated artwork data
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status information
testModeboolean
True when using a test-mode API key, omitted otherwise
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Credit HistoryCARDLY_LIST_CREDIT_HISTORYAcción

Tool to list credit history records. use after checking account balance to review recent credits/debits.

Parámetros de entrada

limitinteger
Maximum number of records to retrieve per page, must be at least 1.
offsetinteger
Number of records to skip before starting to collect the result set, must be non-negative.
effectiveTime.gtstring
YYYY-MM-DD HH:ii:ss formatted string to retrieve only results after this time.
effectiveTime.ltstring
YYYY-MM-DD HH:ii:ss formatted string to retrieve only results before this time.
effectiveTime.gtestring
YYYY-MM-DD HH:ii:ss formatted string to retrieve only results after or equal to this time.
effectiveTime.ltestring
YYYY-MM-DD HH:ii:ss formatted string to retrieve only results before or equal to this time.

Parámetros de salida

dataobjectObligatorio
Container for pagination and result records.
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Overall API call status.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List FontsCARDLY_LIST_FONTSAcción

Tool to list your currently available fonts. use after confirming authentication to explore font options in cardly.

Parámetros de entrada

limitinteger
Maximum number of records per page, must be at least 1.
offsetinteger
Number of records to skip before starting the result set, must be non-negative.
organisationOnlyboolean
If true, return only fonts exclusive to your organisation.

Parámetros de salida

dataobjectObligatorio
Data containing pagination and results.
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status object.
testModeboolean
Indicates if the response is in test mode.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Gift Credit HistoryCARDLY_LIST_GIFT_CREDIT_HISTORYAcción

Tool to list gift credit history records for your organization. use when you need paginated gift credit entries with optional time-based filters.

Parámetros de entrada

limitinteger
Maximum number of records to return. Defaults to server-side default if unspecified.
offsetinteger
Number of records to skip for pagination. Defaults to server-side default if unspecified.
effectiveTime.gtstring
YYYY-MM-DD HH:ii:ss formatted string to retrieve only results after this time.
effectiveTime.ltstring
YYYY-MM-DD HH:ii:ss formatted string to retrieve only results before this time.
effectiveTime.gtestring
YYYY-MM-DD HH:ii:ss formatted string to retrieve only results after or equal to this time.
effectiveTime.ltestring
YYYY-MM-DD HH:ii:ss formatted string to retrieve only results before or equal to this time.

Parámetros de salida

dataobjectObligatorio
Results and pagination data.
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status object.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List InvitationsCARDLY_LIST_INVITATIONSAcción

Tool to retrieve active invitations for your organisation with optional filters. use when you need to audit invited users and their statuses before sending new invitations or revoking access.

Parámetros de entrada

limitinteger
Maximum number of invitations to return. Defaults to API default if omitted.
offsetinteger
Number of invitation records to skip before returning results. Defaults to 0 if omitted.
expiredOnlyboolean
If true, only return expired invitations.
acceptedOnlyboolean
If true, only return accepted invitations.
includeAcceptedboolean
If true, includes accepted invitations in the response. Default filters them out.

Parámetros de salida

dataobjectObligatorio
Paginated invitations data
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status object
testModeboolean
True when using a test-mode API key, omitted otherwise
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List MediaCARDLY_LIST_MEDIAAcción

Tool to retrieve the currently available media sizes for product artwork. use when you need to explore or validate media options before creating artwork.

Parámetros de entrada

limitinteger
Maximum number of media items to return, defaults to 25 if omitted.
offsetinteger
Number of records to skip for pagination, defaults to 0 if omitted.
organisationOnlyboolean
If true, only return media items exclusive to your organisation.

Parámetros de salida

dataobjectObligatorio
Paginated media data results
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status including code, messages, and build version
testModeboolean
Indicates test mode when using a test API key
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List OrdersCARDLY_LIST_ORDERSAcción

Tool to retrieve orders placed by your organisation. use when you need to fetch paginated order history after confirming the endpoint.

Parámetros de entrada

limitinteger
Maximum number of orders to return. Defaults to API default if omitted.
offsetinteger
Number of records to skip before returning results. Defaults to 0 if omitted.

Parámetros de salida

dataobjectObligatorio
Paginated orders data.
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status details.
testModeboolean
True when using a test-mode API key, omitted otherwise.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List TemplatesCARDLY_LIST_TEMPLATESAcción

Tool to retrieve your currently available templates from cardly. use to list and paginate templates for selection in card sends.

Parámetros de entrada

limitinteger
Maximum number of templates to return. Defaults to API default if omitted.
offsetinteger
Number of records to skip before returning results. Defaults to 0 if omitted.

Parámetros de salida

dataobjectObligatorio
Paginated template data
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status object
testModeboolean
True when using a test-mode API key, omitted otherwise
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List UsersCARDLY_LIST_USERSAcción

Tool to retrieve all users associated with your account. use when you need to list and paginate user accounts.

Parámetros de entrada

limitinteger
Maximum number of users to return. Defaults to API default if omitted.
offsetinteger
Number of user records to skip before returning results. Defaults to 0 if omitted.

Parámetros de salida

dataobjectObligatorio
Paginated users data
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status including status, messages, and version
testModeboolean
True when using a test-mode API key, omitted otherwise
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List WebhooksCARDLY_LIST_WEBHOOKSAcción

Tool to retrieve any active or disabled webhooks set up for your organisation. use when you need to audit configured webhook endpoints before modifying subscriptions.

Parámetros de entrada

limitinteger
Maximum number of webhooks to return. Defaults to API default if omitted.
offsetinteger
Number of webhook records to skip before returning results. Defaults to 0 if omitted.

Parámetros de salida

dataobjectObligatorio
Paginated webhooks data
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status object
testModeboolean
True when using a test-mode API key, omitted otherwise
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Writing StylesCARDLY_LIST_WRITING_STYLESAcción

Tool to list available writing styles. use when you need to retrieve writing styles available for handwriting personalization.

Parámetros de entrada

limitinteger
Number of records to return, defaults to 25 if omitted.
offsetinteger
Number of records to skip for pagination, defaults to 0 if omitted.

Parámetros de salida

dataobjectObligatorio
Data object containing meta and list of writing styles
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status including status, messages, and version
testModeboolean
Indicates test mode when using a test API key
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve Account BalanceCARDLY_RETRIEVE_ACCOUNT_BALANCEAcción

Tool to retrieve the current account and gift credit balances for your organisation. use after authenticating to verify available credit before placing orders.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
The nested data object containing balances.
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status including overall API call status, messages, and build version.
testModeboolean
Indicates if the call ran in test mode with a test API key.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve OrderCARDLY_RETRIEVE_ORDERAcción

Tool to retrieve information on a specific order. use after obtaining an order id to fetch its details.

Parámetros de entrada

idstringObligatorio
Unique identifier of the order to retrieve.

Parámetros de salida

dataobjectObligatorio
Detailed order information.
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status details.
testModeboolean
True if response was returned in test mode.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Retrieve UserCARDLY_RETRIEVE_USERAcción

Tool to retrieve detailed information about a specific user. use after obtaining the user id to fetch its details.

Parámetros de entrada

idstringObligatorio
Unique ID of the user to retrieve.

Parámetros de salida

dataobjectObligatorio
Detailed user information.
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Response status object.
testModeboolean
True when using a test-mode API key, omitted otherwise.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update WebhookCARDLY_UPDATE_WEBHOOKAcción

Tool to update a webhook’s settings, including target url and events. use after retrieving existing webhook to apply configuration changes.

Parámetros de entrada

idstringObligatorio
The unique ID of the webhook to update.
eventsstring[]Obligatorio
List of event names this webhook subscribes to; only notifications for these events will be sent.
disabledboolean
If true, disables the webhook; if false, enables it.
metadataobject
Arbitrary key/value pairs to attach to this webhook for user-defined metadata.
targetUrlstringObligatoriouri
The URL this webhook will send POST requests to once one of its subscribed events is triggered.
descriptionstring
Free-text description of what this webhook is for.

Parámetros de salida

dataobjectObligatorio
The updated webhook object.
errorstring
Error if any occurred during the execution of the action
stateobjectObligatorio
Standard API status object.
testModeboolean
True when using a test-mode API key; omitted otherwise.
successfulbooleanObligatorio
Whether or not the action execution was successful or not