Brevo

Catalogue des nœuds Actions
Sur cette page

API REST Brevo : contacts, listes, campagnes, e-mail transactionnel, webhooks

Utilisation et spécificités

Sélectionnez une opération, renseignez les paramètres de chemin et de requête, puis les champs guidés du corps. Le mode avancé expose le catalogue complet et custom_request permet un appel personnalisé. Les droits, domaines d’envoi et signatures webhook restent propres au fournisseur.

Type technique : brevo. Runtime : nodulz.

Identifiants et prérequis

Créez l’identifiant dans la rubrique Identifiants de votre instance nodulz, puis sélectionnez-le dans le nœud. Les identifiants disponibles dépendent du propriétaire et du partage. Consultez le guide des identifiants pour les accès et la rotation.

Paramètres

Les noms ci-dessous correspondent aux clés techniques. Les valeurs par défaut ne constituent pas une configuration prête à exécuter : renseignez les champs requis par votre opération. Les chemins contenant [] décrivent les éléments d’une liste ; certains champs dépendent du mode sélectionné.

Paramètre Type Par défaut Valeurs / limites
credentialId string "" -
operation string "sendtransacemail" -
pathParams string "{}" -
queryParams string "{}" -
body string "" -
bodyFieldValues string "{}" -
customMethod enum "post" get, post, put, patch, delete
customPath string "" -
requestMode enum "curated" curated, advanced

Opérations disponibles

ID HTTP Chemin / paramètres
addcontacttolist post /contacts/lists/{listId}/contacts/add - pathParams: listId - corps requis
addsubscriptiontotier post /loyalty/tier/programs/{pid}/contacts/{cid}/tiers/{tid} - pathParams: pid, cid, tid - corps requis
authenticatedomain put /senders/domains/{domainName}/authenticate - pathParams: domainName - corps requis
batchdeleteobjectrecords post /objects/{object_type}/batch/delete - pathParams: object_type - identifiers (json) - corps requis
begintransaction post /loyalty/balance/programs/{pid}/transactions - pathParams: pid - amount * (number), balanceDefinitionId * (string), autoComplete (boolean), balanceExpiryInMinutes (number), contactId (number), eventTime (string), LoyaltySubscriptionId (string), meta (json), transactionType (string) [credit, debit], ttl (number) - corps requis
blocknewdomain post /smtp/blockedDomains - domain * (string) - corps requis
canceltransaction post /loyalty/balance/programs/{pid}/transactions/{tid}/cancel - pathParams: pid, tid - corps requis
completeredeemtransaction post /loyalty/offer/programs/{pid}/rewards/redeem/{tid}/complete - pathParams: pid, tid - corps requis
completetransaction post /loyalty/balance/programs/{pid}/transactions/{tid}/complete - pathParams: pid, tid - corps requis
createattribute post /contacts/attributes/{attributeCategory}/{attributeName} - pathParams: attributeCategory, attributeName - enumeration (json), isRecurring (boolean), multiCategoryOptions (json), type (string) [text, date, float, boolean, id, category, multiple-choice, user], value (string) - corps requis
createbalancelimit post /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits - pathParams: pid, bdid - constraintType * (string) [transaction, amount], durationUnit * (string) [day, week, month, year], durationValue * (number), transactionType * (string) [credit, debit], value * (number), slidingSchedule (boolean) - corps requis
createbalanceorder post /loyalty/balance/programs/{pid}/create-order - pathParams: pid - amount * (number), balanceDefinitionId * (string), contactId * (number), dueAt * (string), source * (string) [engine, user], expiresAt (string), meta (json) - corps requis
createbatchevents post /events/batch - events * (json) - corps requis
createbatchorder post /orders/status/batch - orders * (json), historical (boolean), notifyUrl (string) - corps requis
createconsentgroup post /contacts/consent-groups - name * (string), signupMode * (string) [manual, automatic], description (string), listIds (json) - corps requis
createcontact post /contacts - attributes (json), email (string), emailBlacklisted (boolean), ext_id (string), forceMerge (boolean), getId (boolean), listIds (json), smsBlacklisted (boolean), smtpBlacklistSender (json), updateEnabled (boolean) - corps requis
createcouponcollection post /couponCollections - defaultCoupon * (string), name * (string), expirationDate (string), remainingCouponsAlert (number), remainingDaysAlert (number) - corps requis
createcoupons post /coupons - collectionId * (string), coupons * (json) - corps requis
createdoicontact post /contacts/doubleOptinConfirmation - email * (string), includeListIds * (json), redirectionUrl * (string), templateId * (number), attributes (json), contactPixelTrackingConsent (boolean), excludeListIds (json) - corps requis
createdomain post /senders/domains - name * (string) - corps requis
createemailcampaign post /emailCampaigns - name * (string), sender * (json), abTesting (boolean), attachmentUrl (string), emailExpirationDate (json), footer (string), header (string), htmlContent (string), htmlUrl (string), increaseRate (number), initialQuota (number), inlineImageActivation (boolean), ipWarmupEnable (boolean), mirrorActive (boolean), params (json), previewText (string), recipients (json), replyTo (string), scheduledAt (string), sendAtBestTime (boolean), splitRule (number), subject (string), subjectA (string), subjectB (string) - corps requis
createevent post /events - event_name * (string), identifiers * (json), contact_properties (json), event_date (string), event_properties (json), object (json) - corps requis
createexternalfeed post /feeds - name * (string), url * (string), authType (string) [basic, token, noAuth], cache (boolean), headers (json), maxRetries (number), password (string), token (string), username (string) - corps requis
createfolder post /contacts/folders - name (string) - corps requis
createlist post /contacts/lists - folderId * (number), name * (string) - corps requis
createnewlp post /loyalty/config/programs - name * (string), description (string), documentId (string), meta (json) - corps requis
createorder post /orders/status - amount * (number), createdAt * (string), id * (string), products * (json), status * (string), updatedAt * (string), billing (json), coupons (json), identifiers (json), metaInfo (json), storeId (string) - corps requis
createpaymentrequest post /payments/requests - cart * (json), contactId * (number), reference * (string), configuration (json), description (string), notification (json) - corps requis
createproductalert post /products/{id}/alerts/{type} - pathParams: id, type - contactIdentifiers (json) - corps requis
createreward post /loyalty/offer/programs/{pid}/offers - pathParams: pid - name * (string), publicDescription (string), publicImage (string), publicName (string) - corps requis
createsender post /senders - email * (string), name * (string), ips (json) - corps requis
createsmscampaign post /smsCampaigns - content * (string), name * (string), sender * (string), organisationPrefix (string), recipients (json), scheduledAt (string), unicodeEnabled (boolean), unsubscribeInstruction (string) - corps requis
createsmtptemplate post /smtp/templates - sender * (json), subject * (string), templateName * (string), attachmentUrl (string), htmlContent (string), htmlUrl (string), isActive (boolean), replyTo (string), tag (string), toField (string) - corps requis
createtierfortiergroup post /loyalty/tier/programs/{pid}/tier-groups/{gid}/tiers - pathParams: pid, gid - accessConditions * (json), name * (string), imageRef (string), tierRewards (json) - corps requis
createtiergroup post /loyalty/tier/programs/{pid}/tier-groups - pathParams: pid - name * (string), downgradeSchedule (json), downgradeStrategy (string) [real_time, membership_anniversary, tier_anniversary], meta (json), tierOrder (json), upgradeSchedule (json), upgradeStrategy (string) [real_time, membership_anniversary, tier_anniversary] - corps requis
createupdatebatchcategory post /categories/batch - categories * (json), updateEnabled (boolean) - corps requis
createupdatebatchproducts post /products/batch - products * (json), updateEnabled (boolean) - corps requis
createupdatecategory post /categories - id * (string), deletedAt (string), isDeleted (boolean), name (string), updateEnabled (boolean), url (string) - corps requis
createupdateproduct post /products - id * (string), name * (string), alternativePrice (number), brand (string), categories (json), deletedAt (string), description (string), imageUrl (string), isDeleted (boolean), metaInfo (json), parentId (string), price (number), sku (string), stock (number), updateEnabled (boolean), url (string) - corps requis
createvoucher post /loyalty/offer/programs/{pid}/rewards/attribute - pathParams: pid - rewardId * (string), code (string), contactId (number), expirationDate (string), loyaltySubscriptionId (string), meta (json), validFrom (string), value (number) - corps requis
createwebhook post /webhooks - url * (string), auth (json), batched (boolean), channel (string) [email, sms], description (string), domain (string), events (json), headers (json), type (string) [transactional, marketing, inbound] - corps requis
createwhatsappcampaign post /whatsappCampaigns - name * (string), recipients * (json), scheduledAt * (string), templateId * (number) - corps requis
createwhatsapptemplate post /whatsappCampaigns/template - bodyText * (string), category * (string) [MARKETING, UTILITY], language * (string), name * (string), headerText (string), mediaUrl (string), source (string) [Automation, Conversations] - corps requis
delete_companies_by_param delete /companies/{id} - pathParams: id
delete_conversations_messages_by_param delete /conversations/messages/{id} - pathParams: id
delete_conversations_pushedmessages_by_param delete /conversations/pushedMessages/{id} - pathParams: id
delete_corporate_group_by_param delete /corporate/group/{id} - pathParams: id
delete_corporate_subaccount_by_param delete /corporate/subAccount/{id} - pathParams: id
delete_corporate_user_revoke_by_param delete /corporate/user/revoke/{email} - pathParams: email
delete_crm_attributes_by_param delete /crm/attributes/{id} - pathParams: id
delete_crm_deals_by_param delete /crm/deals/{id} - pathParams: id
delete_crm_files_by_param delete /crm/files/{id} - pathParams: id
delete_crm_notes_by_param delete /crm/notes/{id} - pathParams: id
delete_crm_tasks_by_param delete /crm/tasks/{id} - pathParams: id
delete_smtp_blockedcontacts_by_param delete /smtp/blockedContacts/{email} - pathParams: email
delete_smtp_log_by_param delete /smtp/log/{identifier} - pathParams: identifier
deleteattribute delete /contacts/attributes/{attributeCategory}/{attributeName} - pathParams: attributeCategory, attributeName
deletebalancedefinition delete /loyalty/balance/programs/{pid}/balance-definitions/{bdid} - pathParams: pid, bdid
deletebalancelimit delete /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} - pathParams: pid, bdid, blid
deleteblockeddomain delete /smtp/blockedDomains/{domain} - pathParams: domain
deleteconsentgroup delete /contacts/consent-groups/{id} - pathParams: id
deletecontact delete /contacts/{identifier} - pathParams: identifier
deletecontactmembers delete /loyalty/config/programs/{pid}/subscription-members - pathParams: pid
deletecontactsubscription delete /loyalty/config/programs/{pid}/contact/{cid} - pathParams: pid, cid
deletedomain delete /senders/domains/{domainName} - pathParams: domainName
deleteemailcampaign delete /emailCampaigns/{campaignId} - pathParams: campaignId
deleteexternalfeed delete /feeds/{uuid} - pathParams: uuid
deletefolder delete /contacts/folders/{folderId} - pathParams: folderId
deletehardbounces post /smtp/deleteHardbounces - contactEmail (string), endDate (string), startDate (string) - corps requis
deletelist delete /contacts/lists/{listId} - pathParams: listId
deleteloyaltyprogram delete /loyalty/config/programs/{pid} - pathParams: pid
deletemultiattributeoptions delete /contacts/attributes/{attributeType}/{multipleChoiceAttribute}/{multipleChoiceAttributeOption} - pathParams: attributeType, multipleChoiceAttribute, multipleChoiceAttributeOption
deletepaymentrequest delete /payments/requests/{id} - pathParams: id
deletescheduledemailbyid delete /smtp/email/{identifier} - pathParams: identifier
deletesender delete /senders/{senderId} - pathParams: senderId
deletesmscampaign delete /smsCampaigns/{campaignId} - pathParams: campaignId
deletesmtptemplate delete /smtp/templates/{templateId} - pathParams: templateId
deletetier delete /loyalty/tier/programs/{pid}/tiers/{tid} - pathParams: pid, tid
deletetiergroup delete /loyalty/tier/programs/{pid}/tier-groups/{gid} - pathParams: pid, gid
deletewebhook delete /webhooks/{webhookId} - pathParams: webhookId
deletewhatsappcampaign delete /whatsappCampaigns/{campaignId} - pathParams: campaignId
edituserpermission post /organization/user/update/permissions - all_features_access * (string) [true, false], email * (string), privileges * (json) - corps requis
emailexportrecipients post /emailCampaigns/{campaignId}/exportRecipients - pathParams: campaignId - recipientsType * (string) [all, nonClickers, nonOpeners, clickers, openers, softBounces, hardBounces, unsubscribed], notifyURL (string) - corps requis
exportwebhookshistory post /webhooks/export - event * (string) [invalid_parameter, missing_parameter, hardBounce, softBounce, delivered, spam, request, opened, click, invalid, deferred, blocked, unsubscribed, error, uniqueOpened, loadedByProxy, allEvents], notifyURL * (string), type * (string) [transactional, marketing], days (number), email (string), endDate (string), messageId (string), sort (string), startDate (string), webhookId (number) - corps requis
get_companies get /companies
get_companies_by_param get /companies/{id} - pathParams: id
get_conversations_messages_by_param get /conversations/messages/{id} - pathParams: id
get_conversations_pushedmessages_by_param get /conversations/pushedMessages/{id} - pathParams: id
get_corporate_group_by_param get /corporate/group/{id} - pathParams: id
get_corporate_ip get /corporate/ip
get_corporate_masteraccount get /corporate/masterAccount
get_corporate_subaccount get /corporate/subAccount
get_corporate_subaccount_by_param get /corporate/subAccount/{id} - pathParams: id
get_crm_attributes_companies get /crm/attributes/companies
get_crm_attributes_deals get /crm/attributes/deals
get_crm_deals get /crm/deals
get_crm_deals_by_param get /crm/deals/{id} - pathParams: id
get_crm_files get /crm/files
get_crm_files_by_param get /crm/files/{id} - pathParams: id
get_crm_files_by_param_data get /crm/files/{id}/data - pathParams: id
get_crm_notes get /crm/notes
get_crm_notes_by_param get /crm/notes/{id} - pathParams: id
get_crm_pipeline_details get /crm/pipeline/details
get_crm_pipeline_details_all get /crm/pipeline/details/all
get_crm_pipeline_details_by_param get /crm/pipeline/details/{pipelineID} - pathParams: pipelineID
get_crm_tasks get /crm/tasks
get_crm_tasks_by_param get /crm/tasks/{id} - pathParams: id
get_crm_tasktypes get /crm/tasktypes
get_ecommerce_attribution_metrics get /ecommerce/attribution/metrics
get_ecommerce_attribution_metrics_by_param_by_param get /ecommerce/attribution/metrics/{conversionSource}/{conversionSourceId} - pathParams: conversionSource, conversionSourceId
get_ecommerce_attribution_products_by_param_by_param get /ecommerce/attribution/products/{conversionSource}/{conversionSourceId} - pathParams: conversionSource, conversionSourceId
get_ecommerce_config_displaycurrency get /ecommerce/config/displayCurrency
get_loyalty_balance_programs_by_param_active_balance get /loyalty/balance/programs/{pid}/active-balance - pathParams: pid
get_loyalty_balance_programs_by_param_transaction_history get /loyalty/balance/programs/{pid}/transaction-history - pathParams: pid
get_loyalty_offer_programs_by_param_offers get /loyalty/offer/programs/{pid}/offers - pathParams: pid
get_loyalty_offer_programs_by_param_rewards_by_param get /loyalty/offer/programs/{pid}/rewards/{rid} - pathParams: pid, rid
get_loyalty_offer_programs_by_param_vouchers get /loyalty/offer/programs/{pid}/vouchers - pathParams: pid
getabtestcampaignresult get /emailCampaigns/{campaignId}/abTestCampaignResult - pathParams: campaignId
getaccount get /account
getaccountactivity get /organization/activities
getaggregatedsmtpreport get /smtp/statistics/aggregatedReport
getallexternalfeeds get /feeds
getassociatedrecords get /objects/{object_type}/associated-records - pathParams: object_type
getattributes get /contacts/attributes
getbalancedefinition get /loyalty/balance/programs/{pid}/balance-definitions/{bdid} - pathParams: pid, bdid
getbalancedefinitionlist get /loyalty/balance/programs/{pid}/balance-definitions - pathParams: pid
getbalancelimit get /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} - pathParams: pid, bdid, blid
getblockeddomains get /smtp/blockedDomains
getcategories get /categories
getcategoryinfo get /categories/{id} - pathParams: id
getcodecount get /loyalty/offer/programs/{pid}/code-pools/{cpid}/codes-count - pathParams: pid, cpid
getconsentgroup get /contacts/consent-groups/{id} - pathParams: id
getconsentgroups get /contacts/consent-groups
getcontactbalances get /loyalty/balance/programs/{pid}/contact-balances - pathParams: pid
getcontactinfo get /contacts/{identifier} - pathParams: identifier
getcontacts get /contacts
getcontactsfromlist get /contacts/lists/{listId}/contacts - pathParams: listId
getcontactstats get /contacts/{identifier}/campaignStats - pathParams: identifier
getcorporateinviteduserslist get /corporate/invited/users
getcorporateuserpermission get /corporate/user/{email}/permissions - pathParams: email
getcouponcollection get /couponCollections/{id} - pathParams: id
getcouponcollections get /couponCollections
getdomainconfiguration get /senders/domains/{domainName} - pathParams: domainName
getdomains get /senders/domains
getemailcampaign get /emailCampaigns/{campaignId} - pathParams: campaignId
getemailcampaigns get /emailCampaigns
getemaileventreport get /smtp/statistics/events
getevents get /events
getexternalfeedbyuuid get /feeds/{uuid} - pathParams: uuid
getfolder get /contacts/folders/{folderId} - pathParams: folderId
getfolderlists get /contacts/folders/{folderId}/lists - pathParams: folderId
getfolders get /contacts/folders
getinboundemailattachment get /inbound/attachments/{downloadToken} - pathParams: downloadToken
getinboundemailevents get /inbound/events
getinboundemaileventsbyuuid get /inbound/events/{uuid} - pathParams: uuid
getinviteduserslist get /organization/invited/users
getips get /senders/ips
getipsfromsender get /senders/{senderId}/ips - pathParams: senderId
getlist get /contacts/lists/{listId} - pathParams: listId
getlistoftiergroups get /loyalty/tier/programs/{pid}/tier-groups - pathParams: pid
getlists get /contacts/lists
getloyaltyprograminfo get /loyalty/config/programs/{pid} - pathParams: pid
getloyaltyprogramtier get /loyalty/tier/programs/{pid}/tiers - pathParams: pid
getlplist get /loyalty/config/programs
getorders get /orders
getparametersubscriptioninfo get /loyalty/config/programs/{pid}/account-info - pathParams: pid
getpaymentrequest get /payments/requests/{id} - pathParams: id
getprocess get /processes/{processId} - pathParams: processId
getprocesses get /processes
getproductinfo get /products/{id} - pathParams: id
getproducts get /products
getrecords get /objects/{object_type}/records - pathParams: object_type
getscheduledemailbyid get /smtp/emailStatus/{identifier} - pathParams: identifier
getsegments get /contacts/segments
getsenders get /senders
getsharedtemplateurl get /emailCampaigns/{campaignId}/sharedUrl - pathParams: campaignId
getsmscampaign get /smsCampaigns/{campaignId} - pathParams: campaignId
getsmscampaigns get /smsCampaigns
getsmsevents get /transactionalSMS/statistics/events
getsmstemplates get /transactionalSMS/templates
getsmtpreport get /smtp/statistics/reports
getsmtptemplate get /smtp/templates/{templateId} - pathParams: templateId
getsmtptemplates get /smtp/templates
getsubaccountgroups get /corporate/groups
getsubscriptionbalances get /loyalty/balance/programs/{pid}/subscriptions/{cid}/balances - pathParams: pid, cid
gettiergroup get /loyalty/tier/programs/{pid}/tier-groups/{gid} - pathParams: pid, gid
gettransacaggregatedsmsreport get /transactionalSMS/statistics/aggregatedReport
gettransacblockedcontacts get /smtp/blockedContacts
gettransacemailcontent get /smtp/emails/{uuid} - pathParams: uuid
gettransacemailslist get /smtp/emails
gettransacsmsreport get /transactionalSMS/statistics/reports
getuserpermission get /organization/user/{email}/permissions - pathParams: email
getwalletpassinstallurl get /wallet/passes/{passId}/installUrl/{contactId} - pathParams: passId, contactId
getwebhook get /webhooks/{webhookId} - pathParams: webhookId
getwebhooks get /webhooks
getwhatsappcampaign get /whatsappCampaigns/{campaignId} - pathParams: campaignId
getwhatsappcampaigns get /whatsappCampaigns
getwhatsappconfig get /whatsappCampaigns/config
getwhatsappeventreport get /whatsapp/statistics/events
getwhatsapptemplates get /whatsappCampaigns/template-list
importcontacts post /contacts/import - consentGroupIds (json), disableNotification (boolean), emailBlacklist (boolean), emptyContactsAttributes (boolean), fileBody (string), fileUrl (string), jsonBody (json), listIds (json), newList (json), notifyUrl (string), smsBlacklist (boolean), updateExistingContacts (boolean) - corps requis
inviteadminuser post /corporate/user/invitation/send - all_features_access * (string) [true, false], email * (string), privileges * (json), groupIds (json) - corps requis
inviteuser post /organization/user/invitation/send - all_features_access * (string) [true, false], email * (string), privileges * (json) - corps requis
partiallyupdateloyaltyprogram patch /loyalty/config/programs/{pid} - pathParams: pid - description (string), meta (json), name (string) - corps requis
patch_companies_by_param patch /companies/{id} - pathParams: id - attributes (json), countryCode (number), linkedContactsIds (json), linkedDealsIds (json), name (string) - corps requis
patch_companies_link_unlink_by_param patch /companies/link-unlink/{id} - pathParams: id - linkContactIds (json), linkDealsIds (json), unlinkContactIds (json), unlinkDealsIds (json) - corps requis
patch_crm_attributes_by_param patch /crm/attributes/{id} - pathParams: id - label (string), objectType (string) [companies, deals], optionsLabels (json) - corps requis
patch_crm_deals_by_param patch /crm/deals/{id} - pathParams: id - attributes (json), linkedCompaniesIds (json), linkedContactsIds (json), name (string) - corps requis
patch_crm_deals_link_unlink_by_param patch /crm/deals/link-unlink/{id} - pathParams: id - linkCompanyIds (json), linkContactIds (json), unlinkCompanyIds (json), unlinkContactIds (json) - corps requis
patch_crm_notes_by_param patch /crm/notes/{id} - pathParams: id - text * (string), companyIds (json), contactIds (json), dealIds (json) - corps requis
patch_crm_tasks_by_param patch /crm/tasks/{id} - pathParams: id - assignToId (string), companiesIds (json), contactsIds (json), date (string), dealsIds (json), done (boolean), duration (number), name (string), notes (string), reminder (json), taskTypeId (string) - corps requis
post_companies post /companies - name * (string), attributes (json), countryCode (number), linkedContactsIds (json), linkedDealsIds (json) - corps requis
post_companies_import post /companies/import - file (string), mapping (json) - corps requis
post_conversations_agentonlineping post /conversations/agentOnlinePing - agentEmail (string), agentId (string), agentName (string), receivedFrom (string) - corps requis
post_conversations_messages post /conversations/messages - text * (string), visitorId * (string), agentEmail (string), agentId (string), agentName (string), receivedFrom (string) - corps requis
post_conversations_pushedmessages post /conversations/pushedMessages - text * (string), visitorId * (string), agentId (string), groupId (string) - corps requis
post_corporate_group post /corporate/group - groupName * (string), subAccountIds (json) - corps requis
post_corporate_ssotoken post /corporate/ssoToken - email * (string) - corps requis
post_corporate_subaccount post /corporate/subAccount - companyName * (string), email * (string), groupIds (json), language (string) [en, fr, it, es, pt, de], timezone (string) - corps requis
post_corporate_subaccount_ip_associate post /corporate/subAccount/ip/associate - ids * (json), ip * (string) - corps requis
post_corporate_subaccount_key post /corporate/subAccount/key - id * (number), name * (string) - corps requis
post_corporate_subaccount_ssotoken post /corporate/subAccount/ssoToken - id * (number), email (string), target (string) [automation, email_campaign, contacts, landing_pages, email_transactional, senders, sms_campaign, sms_transactional], url (string) - corps requis
post_crm_attributes post /crm/attributes - attributeType * (string) [text, user, number, single-select, date, boolean, multi-choice], label * (string), objectType * (string) [companies, deals], description (string), optionsLabels (json) - corps requis
post_crm_deals post /crm/deals - name * (string), attributes (json), linkedCompaniesIds (json), linkedContactsIds (json) - corps requis
post_crm_deals_import post /crm/deals/import - file (string), mapping (json) - corps requis
post_crm_files post /crm/files - file * (string), companyId (string), contactId (number), dealId (string) - corps requis
post_crm_notes post /crm/notes - text * (string), companyIds (json), contactIds (json), dealIds (json) - corps requis
post_crm_tasks post /crm/tasks - date * (string), name * (string), taskTypeId * (string), assignToId (string), companiesIds (json), contactsIds (json), dealsIds (json), done (boolean), duration (number), notes (string), reminder (json) - corps requis
post_ecommerce_activate post /ecommerce/activate - corps requis
post_loyalty_balance_programs_by_param_balance_definitions post /loyalty/balance/programs/{pid}/balance-definitions - pathParams: pid - name * (string), unit * (string) [POINTS, EUR, USD, MXN, GBP, INR, CAD, SGD, RON, JPY, MYR, CLP, PEN, MAD, AUD, CHF, BRL], balanceAvailabilityDurationModifier (string) [noModification, startOfPeriod, endOfPeriod], balanceAvailabilityDurationUnit (string) [day, week, month, year], balanceAvailabilityDurationValue (number), balanceExpirationDate (string), balanceOptionAmountOvertakingStrategy (string) [strict, partial], balanceOptionCreditRounding (string) [lower, upper, natural], balanceOptionDebitRounding (string) [lower, upper, natural], description (string), imageRef (string), maxAmount (number), maxCreditAmountLimit (number), maxDebitAmountLimit (number), meta (json), minAmount (number) - corps requis
post_loyalty_balance_programs_by_param_subscriptions_by_param_balances post /loyalty/balance/programs/{pid}/subscriptions/{cid}/balances - pathParams: pid, cid - balanceDefinitionId * (string) - corps requis
postpreviewsmtpemailtemplates post /smtp/template/preview - templateId * (number), email (string), params (json) - corps requis
publishloyaltyprogram post /loyalty/config/programs/{pid}/publish - pathParams: pid - corps requis
put_conversations_messages_by_param put /conversations/messages/{id} - pathParams: id - text * (string) - corps requis
put_conversations_pushedmessages_by_param put /conversations/pushedMessages/{id} - pathParams: id - text * (string) - corps requis
put_conversations_visitorgroup put /conversations/visitorGroup - groupId * (string) - corps requis
put_corporate_group_by_param put /corporate/group/{id} - pathParams: id - groupName (string), subAccountIds (json) - corps requis
put_corporate_group_unlink_by_param_subaccounts put /corporate/group/unlink/{groupId}/subAccounts - pathParams: groupId - subAccountIds * (json) - corps requis
put_corporate_subaccount_by_param_applications_toggle put /corporate/subAccount/{id}/applications/toggle - pathParams: id - analytics (boolean), automation (boolean), conversations (boolean), crm (boolean), email-campaigns (boolean), facebook-ads (boolean), inbox (boolean), landing-pages (boolean), meetings (boolean), sms-campaigns (boolean), transactional-emails (boolean), transactional-sms (boolean), web-push (boolean), whatsapp (boolean) - corps requis
put_corporate_subaccount_by_param_plan put /corporate/subAccount/{id}/plan - pathParams: id - credits (json), features (json) - corps requis
put_corporate_subaccount_ip_dissociate put /corporate/subAccount/ip/dissociate - ids * (json), ip * (string) - corps requis
put_corporate_subaccounts_plan put /corporate/subAccounts/plan - credits (json), features (json), subAccountIds (json) - corps requis
put_corporate_user_by_param_permissions put /corporate/user/{email}/permissions - pathParams: email - all_features_access * (string) [true, false], privileges * (json) - corps requis
put_corporate_user_invitation_by_param_by_param put /corporate/user/invitation/{action}/{email} - pathParams: action, email - corps requis
putresendcancelinvitation put /organization/user/invitation/{action}/{email} - pathParams: action, email - corps requis
putrevokeuserpermission put /organization/user/invitation/revoke/{email} - pathParams: email - corps requis
redeemvoucher post /loyalty/offer/programs/{pid}/rewards/redeem - pathParams: pid - attributedRewardId (string), autoComplete (boolean), code (string), contactId (number), loyaltySubscriptionId (string), meta (json), order (json), rewardId (string), ttl (number) - corps requis
removecontactfromlist post /contacts/lists/{listId}/contacts/remove - pathParams: listId - corps requis
requestcontactexport post /contacts/export - customContactFilter * (json), disableNotification (boolean), exportAttributes (json), exportDateInUTC (boolean), exportMandatoryAttributes (boolean), exportMetadata (json), exportSubscriptionStatus (json), notifyUrl (string) - corps requis
requestsmsrecipientexport post /smsCampaigns/{campaignId}/exportRecipients - pathParams: campaignId - recipientsType * (string) [all, delivered, answered, softBounces, hardBounces, unsubscribed], notifyURL (string) - corps requis
revokevouchers delete /loyalty/offer/programs/{pid}/rewards/revoke - pathParams: pid
sendasynctransactionalsms post /transactionalSMS/send - recipient * (string), sender * (string), organisationPrefix (string), params (json), tag (json), type (string) [transactional, marketing], unicodeEnabled (boolean), webUrl (string) - corps requis
sendemailcampaignnow post /emailCampaigns/{campaignId}/sendNow - pathParams: campaignId - corps requis
sendreport post /emailCampaigns/{campaignId}/sendReport - pathParams: campaignId - email * (json), language (string) [fr, es, pt, it, de, en] - corps requis
sendsmscampaignnow post /smsCampaigns/{campaignId}/sendNow - pathParams: campaignId - corps requis
sendsmsreport post /smsCampaigns/{campaignId}/sendReport - pathParams: campaignId - email * (json), language (string) [fr, es, pt, it, de, en] - corps requis
sendtestemail post /emailCampaigns/{campaignId}/sendTest - pathParams: campaignId - emailTo (json) - corps requis
sendtestsms post /smsCampaigns/{campaignId}/sendTest - pathParams: campaignId - phoneNumber (string) - corps requis
sendtesttemplate post /smtp/templates/{templateId}/sendTest - pathParams: templateId - emailTo (json) - corps requis
sendtransacemail post /smtp/email - attachment (json), batchId (string), bcc (json), cc (json), headers (json), htmlContent (string), messageVersions (json), params (json), replyTo (json), scheduledAt (string), sender (json), subject (string), tags (json), templateId (number), textContent (string), to (json) - corps requis
sendtransacsms post /transactionalSMS/sms - recipient * (string), sender * (string), organisationPrefix (string), params (json), tag (json), type (string) [transactional, marketing], unicodeEnabled (boolean), webUrl (string) - corps requis
sendwhatsappmessage post /whatsapp/sendMessage - corps requis
sendwhatsapptemplateapproval post /whatsappCampaigns/template/approval/{templateId} - pathParams: templateId - corps requis
setconfigdisplaycurrency post /ecommerce/config/displayCurrency - code * (string) - corps requis
subscribemembertoasubscription post /loyalty/config/programs/{pid}/subscription-members - pathParams: pid - memberContactIds * (json), contactId (number), loyaltySubscriptionId (string) - corps requis
subscribetoloyaltyprogram post /loyalty/config/programs/{pid}/subscriptions - pathParams: pid - contactId * (number), creationDate (string), loyaltySubscriptionId (string), meta (json) - corps requis
updateattribute put /contacts/attributes/{attributeCategory}/{attributeName} - pathParams: attributeCategory, attributeName - enumeration (json), multiCategoryOptions (json), value (string) - corps requis
updatebalancedefinition put /loyalty/balance/programs/{pid}/balance-definitions/{bdid} - pathParams: pid, bdid - name * (string), unit * (string) [POINTS, EUR, USD, MXN, GBP, INR, CAD, SGD, RON, JPY, MYR, CLP, PEN, MAD, AUD, CHF, BRL], balanceAvailabilityDurationModifier (string) [noModification, startOfPeriod, endOfPeriod], balanceAvailabilityDurationUnit (string) [day, week, month, year], balanceAvailabilityDurationValue (number), balanceExpirationDate (string), balanceOptionAmountOvertakingStrategy (string) [strict, partial], balanceOptionCreditRounding (string) [lower, upper, natural], balanceOptionDebitRounding (string) [lower, upper, natural], description (string), imageRef (string), maxAmount (number), maxCreditAmountLimit (number), maxDebitAmountLimit (number), meta (json), minAmount (number) - corps requis
updatebalancelimit put /loyalty/balance/programs/{pid}/balance-definitions/{bdid}/limits/{blid} - pathParams: pid, bdid, blid - constraintType * (string) [transaction, amount], durationUnit * (string) [day, week, month, year], durationValue * (number), transactionType * (string) [credit, debit], value * (number), slidingSchedule (boolean) - corps requis
updatebatchcontacts post /contacts/batch - contacts (json) - corps requis
updatecampaignstatus put /emailCampaigns/{campaignId}/status - pathParams: campaignId - status (string) [suspended, archive, darchive, sent, queued, replicate, replicateTemplate, cancel, draft] - corps requis
updateconsentgroup put /contacts/consent-groups/{id} - pathParams: id - description (string), name (string), signupMode (string) [manual, automatic] - corps requis
updatecontact put /contacts/{identifier} - pathParams: identifier - attributes (json), emailBlacklisted (boolean), ext_id (string), forceMerge (boolean), listIds (json), smsBlacklisted (boolean), smtpBlacklistSender (json), unlinkListIds (json) - corps requis
updatecouponcollection patch /couponCollections/{id} - pathParams: id - defaultCoupon (string), expirationDate (string), remainingCouponsAlert (number), remainingDaysAlert (number) - corps requis
updateemailcampaign put /emailCampaigns/{campaignId} - pathParams: campaignId - abTesting (boolean), attachmentUrl (string), emailExpirationDate (json), footer (string), header (string), htmlContent (string), htmlUrl (string), increaseRate (number), initialQuota (number), inlineImageActivation (boolean), ipWarmupEnable (boolean), mirrorActive (boolean), name (string), params (json), previewText (string), recipients (json), recurring (boolean), replyTo (string), scheduledAt (string), sendAtBestTime (boolean), sender (json), splitRule (number), subject (string), subjectA (string) - corps requis
updateexternalfeed put /feeds/{uuid} - pathParams: uuid - authType (string) [basic, token, noAuth], cache (boolean), headers (json), maxRetries (number), name (string), password (string), token (string), url (string), username (string) - corps requis
updatefolder put /contacts/folders/{folderId} - pathParams: folderId - name (string) - corps requis
updatelist put /contacts/lists/{listId} - pathParams: listId - folderId (number), name (string) - corps requis
updateloyaltyprogram put /loyalty/config/programs/{pid} - pathParams: pid - name * (string), description (string), meta (json) - corps requis
updatesender put /senders/{senderId} - pathParams: senderId - email (string), ips (json), name (string) - corps requis
updatesmscampaign put /smsCampaigns/{campaignId} - pathParams: campaignId - content (string), name (string), organisationPrefix (string), recipients (json), scheduledAt (string), sender (string), unicodeEnabled (boolean), unsubscribeInstruction (string) - corps requis
updatesmscampaignstatus put /smsCampaigns/{campaignId}/status - pathParams: campaignId - status (string) [suspended, archive, darchive, sent, queued, replicate, replicateTemplate, cancel, draft] - corps requis
updatesmtptemplate put /smtp/templates/{templateId} - pathParams: templateId - attachmentUrl (string), htmlContent (string), htmlUrl (string), isActive (boolean), replyTo (string), sender (json), subject (string), tag (string), templateName (string), toField (string) - corps requis
updatetier put /loyalty/tier/programs/{pid}/tiers/{tid} - pathParams: pid, tid - accessConditions * (json), name * (string), tierRewards * (json), imageRef (string) - corps requis
updatetiergroup put /loyalty/tier/programs/{pid}/tier-groups/{gid} - pathParams: pid, gid - downgradeStrategy * (string) [real_time, membership_anniversary, tier_anniversary], name * (string), tierOrder * (json), upgradeStrategy * (string) [real_time, membership_anniversary, tier_anniversary], meta (json) - corps requis
updatewebhook put /webhooks/{webhookId} - pathParams: webhookId - auth (json), batched (boolean), description (string), domain (string), events (json), headers (json), url (string) - corps requis
updatewhatsappcampaign put /whatsappCampaigns/{campaignId} - pathParams: campaignId - campaignName (string), campaignStatus (string) [scheduled, suspended], recipients (json), rescheduleFor (string) - corps requis
uploadimagetogallery post /emailCampaigns/images - imageUrl * (string), name (string) - corps requis
upsertrecords post /objects/{object_type}/batch/upsert - pathParams: object_type - records * (json) - corps requis
validatereward post /loyalty/offer/programs/{pid}/rewards/validate - pathParams: pid - attributedRewardId (string), code (string), contactId (number), loyaltySubscriptionId (string), pointOfSellId (string), rewardId (string) - corps requis
validatesenderbyotp put /senders/{senderId}/validate - pathParams: senderId - otp * (number) - corps requis
custom_request post {customPath} - pathParams: customPath

L’astérisque signale un paramètre requis par cette opération. Les champs du corps et les droits nécessaires dépendent de l’opération choisie ; utilisez le formulaire guidé et la référence officielle du fournisseur.

Configuration initiale

Exemple de configuration initiale du catalogue, à adapter avant exécution. Les secrets doivent rester dans les identifiants.

json
{
  "credentialId": "",
  "operation": "sendtransacemail",
  "pathParams": "{}",
  "queryParams": "{}",
  "body": "",
  "bodyFieldValues": "{}",
  "customMethod": "post",
  "customPath": "",
  "requestMode": "curated"
}

Vérification

Testez le nœud avec des données représentatives. Contrôlez sa sortie dans l’inspecteur et les logs, puis utilisez le mapping de l’éditeur pour les champs des nœuds suivants. Un test de déclencheur avec payload simulé ne valide pas la livraison du service externe.

Voir aussi : Expressions et données, Exécutions, Catalogue des nœuds.