Bird
App · 30 actions
Work with your Bird workspace: manage contacts, custom properties and audiences, send, schedule and follow email, look up SMS templates, senders and numbers, and manage webhooks.
Actions
| Action | What it does |
|---|---|
| Add contacts to audience | Add contacts to an audience. |
| Archive contact property | Archive a property: it leaves the pickers and can no longer be set on contacts. |
| Cancel scheduled email | Cancel an email that is scheduled to send later, before it goes out. |
| Create audience | Create a static audience: a named list of contacts you add to and remove from yourself. |
| Create contact | Add a contact with an email address, a phone number or both, plus a name and any custom properties. |
| Create contact property | Register a custom field that contacts can carry, such as plan_tier. |
| Create webhook | Send chosen events, such as email delivered or SMS received, to an https address. |
| Delete audience | Delete an audience. |
| Delete contact | Delete a contact. |
| Delete webhook | Delete a webhook so Bird stops sending to it. |
| Get audience | Get one audience by id. |
| Get contact | Get one contact with its details, custom properties and audiences. |
| Get email | Get one email with its delivery status and how many recipients it was delivered to, bounced for, opened and clicked. |
| Get workspace | Get the Bird workspace the connection acts in: its name, organization and when it was created. |
| List audience contacts | List the contacts in an audience, most recently joined first, each with when it joined. |
| List audiences | List the audiences. |
| List contact properties | List the custom contact properties, archived ones included. |
| List contacts | List contacts, newest first, searched by text, exact email or your own id. |
| List email events | List what happened to an email, in order: accepted, processed, delivered, opened, clicked or bounced. |
| List emails | List emails sent from the workspace, newest first, filtered by status, category, address or date. |
| List numbers | List the phone numbers the workspace holds. |
| List SMS senders | List the numbers and sender names the workspace can send SMS from. |
| List SMS templates | List Bird's built-in SMS templates and your own. |
| List webhooks | List the webhooks. |
| Remove contacts from audience | Remove contacts from an audience. |
| Send email | Send an email, now or up to 30 days ahead. |
| Update audience | Rename an audience or change its description. |
| Update contact | Change a contact's email, phone, name, your own id or custom properties. |
| Update contact property | Change the fallback value templates use when a contact has none for the property. |
| Update webhook | Change a webhook's address, events or label, or pause and resume it. |
Add contacts to audience
Add contacts to an audience. A contact already in it is left alone.
Inputs
- Audience
audience_idtextRequired - The audience. Pick one, or give its id from an earlier step.
- Contacts
contact_idslistRequired - The ids of the contacts, one per row, from 'List contacts' or earlier steps.
Outputs
audience_idtext- The audience
contact_idslist- The contacts added
countnumber- How many contacts
Example output
{
"audience_id": "adn_01m7b5f467ftts1nbwy4636rew",
"contact_ids": [
"con_01m7b5f3vjesvr9mwvjs4c9ga4"
],
"count": 1
}Archive contact property
Archive a property: it leaves the pickers and can no longer be set on contacts. Bird has no way to delete one.
Inputs
- Contact property
property_idtextRequired - The property. Pick one, or give its id from an earlier step.
Outputs
propertyobject- The property, now archived
Example output
{
"property": {
"archived": true,
"created_at": "2026-11-13T19:17:05.010421Z",
"fallback_value": "free",
"id": "prp_01m7b5f3f8fftb6xyh5z579x6f",
"key": "plan_tier",
"type": "string",
"updated_at": "2026-11-13T19:17:05.010421Z"
}
}Cancel scheduled email
Cancel an email that is scheduled to send later, before it goes out.
Inputs
- Email ID
message_idtextRequired - The email's id (it starts with em_), from 'Send email', 'List emails' or an earlier step.
Outputs
canceledtrue/false- Always true once canceled
message_idtext- The id of the email canceled
Example output
{
"canceled": true,
"message_id": "em_01m7b5hcf9f9nryn4dmwetv0p9"
}Create audience
Create a static audience: a named list of contacts you add to and remove from yourself.
Inputs
- Name
nametextRequired - The audience's name.
- Description
descriptiontext - Who is in this audience.
Outputs
audienceobject- The audience
Example output
{
"audience": {
"created_at": "2026-11-13T19:17:05.010421Z",
"description": "Paying customers",
"id": "adn_01m7b5f467ftts1nbwy4636rew",
"name": "Customers",
"type": "static",
"updated_at": "2026-11-13T19:17:05.010421Z"
}
}Create contact
Add a contact with an email address, a phone number or both, plus a name and any custom properties.
Inputs
- Email address
emailtext - The contact's email address.
- First name
first_nametext - The contact's first name.
- Last name
last_nametext - The contact's last name.
- Phone number
phone_numbertext - With the country code, like +15555555555.
- Your own ID
external_idtext - Your own identifier for the contact, such as a user id in your system. Unique in the workspace.
- Custom properties
dataobject - Values for custom contact properties, by property name, such as {"plan_tier": "gold"}. Each name must exist (see 'Create contact property').
Outputs
contactobject- The contact
Example output
{
"contact": {
"audiences": [
{
"id": "adn_01m7b5f467ftts1nbwy4636rew",
"name": "Customers"
}
],
"created_at": "2026-11-13T19:17:05.010421Z",
"data": {
"plan_tier": "gold"
},
"email": "jo@example.com",
"external_id": "crm-1042",
"first_name": "Jo",
"id": "con_01m7b5f3vjesvr9mwvjs4c9ga4",
"last_name": "Bloggs",
"phone_number": "+15555550100",
"updated_at": "2026-11-13T19:17:05.010421Z"
}
}Create contact property
Register a custom field that contacts can carry, such as plan_tier. Its type cannot be changed later.
Inputs
- Key
keytextRequired - The property's name: letters, digits and underscores, starting with a letter, such as plan_tier.
- Type
typetextRequired - What kind of value the property holds.One of:
string(Text),number,boolean(Yes or no),datetime(Date and time). - Fallback value
fallback_valuetext - What templates use when a contact has no value for the property. Typed to the property.
Outputs
propertyobject- The property
Example output
{
"property": {
"archived": false,
"created_at": "2026-11-13T19:17:05.010421Z",
"fallback_value": "free",
"id": "prp_01m7b5f3f8fftb6xyh5z579x6f",
"key": "plan_tier",
"type": "string",
"updated_at": "2026-11-13T19:17:05.010421Z"
}
}Create webhook
Send chosen events, such as email delivered or SMS received, to an https address. Bird signs each delivery with the secret this returns.
Inputs
- Address
urltextRequired - A public https:// address Bird can reach. Bird signs each delivery with the webhook's secret.
- Events
eventslistRequired - The events to send to the address. Choose every one you want.One or more of:
email.accepted(Email accepted),email.processed(Email processed),email.delivered(Email delivered),email.deferred(Email deferred),email.bounced(Email bounced),email.rejected(Email rejected),email.opened(Email opened),email.clicked(Email link clicked),email.complained(Email marked as spam),email.unsubscribed(Email unsubscribed), and 16 more. - Label
descriptiontext - A name for the webhook, so you can tell it apart.
Outputs
webhookobject- The webhook, with its signing secret
Example output
{
"webhook": {
"created_at": "2026-11-13T19:17:05.010421Z",
"description": "Delivery events",
"events": [
"email.delivered",
"email.bounced"
],
"id": "whk_01m7b5hcf9f9nryn4dmwetv0p9",
"secret": "whsec_example",
"status": "active",
"updated_at": "2026-11-13T19:17:05.010421Z",
"url": "https://example.com/bird"
}
}Delete audience
Delete an audience. Its contacts are kept.
Inputs
- Audience
audience_idtextRequired - The audience. Pick one, or give its id from an earlier step.
Outputs
audience_idtext- The id of the audience deleted
deletedtrue/false- Always true once deleted
Example output
{
"audience_id": "adn_01m7b5f467ftts1nbwy4636rew",
"deleted": true
}Delete contact
Delete a contact. This cannot be undone.
Inputs
- Contact ID
contact_idtextRequired - The contact's id, from 'List contacts', 'Create contact' or an earlier step.
Outputs
contact_idtext- The id of the contact deleted
deletedtrue/false- Always true once deleted
Example output
{
"contact_id": "con_01m7b5f3vjesvr9mwvjs4c9ga4",
"deleted": true
}Delete webhook
Delete a webhook so Bird stops sending to it.
Inputs
- Webhook
webhook_idtextRequired - The webhook. Pick one, or give its id from an earlier step.
Outputs
deletedtrue/false- Always true once deleted
webhook_idtext- The id of the webhook deleted
Example output
{
"deleted": true,
"webhook_id": "whk_01m7b5hcf9f9nryn4dmwetv0p9"
}Get audience
Get one audience by id.
Inputs
- Audience
audience_idtextRequired - The audience. Pick one, or give its id from an earlier step.
Outputs
audienceobject- The audience
Example output
{
"audience": {
"created_at": "2026-11-13T19:17:05.010421Z",
"description": "Paying customers",
"id": "adn_01m7b5f467ftts1nbwy4636rew",
"name": "Customers",
"type": "static",
"updated_at": "2026-11-13T19:17:05.010421Z"
}
}Get contact
Get one contact with its details, custom properties and audiences.
Inputs
- Contact ID
contact_idtextRequired - The contact's id, from 'List contacts', 'Create contact' or an earlier step.
Outputs
contactobject- The contact
Example output
{
"contact": {
"audiences": [
{
"id": "adn_01m7b5f467ftts1nbwy4636rew",
"name": "Customers"
}
],
"created_at": "2026-11-13T19:17:05.010421Z",
"data": {
"plan_tier": "gold"
},
"email": "jo@example.com",
"external_id": "crm-1042",
"first_name": "Jo",
"id": "con_01m7b5f3vjesvr9mwvjs4c9ga4",
"last_name": "Bloggs",
"phone_number": "+15555550100",
"updated_at": "2026-11-13T19:17:05.010421Z"
}
}Get email
Get one email with its delivery status and how many recipients it was delivered to, bounced for, opened and clicked.
Inputs
- Email ID
message_idtextRequired - The email's id (it starts with em_), from 'Send email', 'List emails' or an earlier step.
Outputs
messageobject- The email
Example output
{
"message": {
"accepted_count": 0,
"bcc": [],
"bounced_count": 0,
"category": "transactional",
"cc": [],
"click_count": 0,
"complained_count": 0,
"created_at": "2026-11-13T19:17:05.010421Z",
"deferred_count": 0,
"delivered_at": "2026-11-13T19:17:05.010421Z",
"delivered_count": 1,
"from": {
"email": "onboarding@messagebird.dev",
"name": "Acme"
},
"id": "em_01m7b5hcf9f9nryn4dmwetv0p9",
"open_count": 0,
"processed_count": 0,
"rejected_count": 0,
"scheduled_at": "",
"status": "delivered",
"subject": "Welcome to Acme",
"to": [
{
"email": "delivered@messagebird.dev",
"name": ""
}
],
"track_clicks": true,
"track_opens": true
}
}Get workspace
Get the Bird workspace the connection acts in: its name, organization and when it was created.
Inputs
None.
Outputs
workspaceobject- The workspace
Example output
{
"workspace": {
"created_at": "2026-11-13T19:17:05.010421Z",
"id": "ws_01m7b12fsffqtv655vpsazdtf7",
"logo_url": "",
"name": "Acme",
"organization_id": "org_01m7b12fs8ejst3ssvz6fqg91s",
"suspended_at": "",
"updated_at": "2026-11-13T19:17:05.010421Z"
}
}List audience contacts
List the contacts in an audience, most recently joined first, each with when it joined. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Audience
audience_idtextRequired - The audience. Pick one, or give its id from an earlier step.
- Search
qtext - Only those whose details contain this text, ignoring case.
- Page size
limitnumber - How many to return, 1 to 100. Bird's default is 20.From 1 to 100.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many on this page
memberslist- The contacts and when each joined
next_cursortext- Pass as 'after' for the next page; empty on the last one
Example output
{
"count": 1,
"members": [
{
"audiences": [
{
"id": "adn_01m7b5f467ftts1nbwy4636rew",
"name": "Customers"
}
],
"contact": {
"audiences": [
{
"id": "adn_01m7b5f467ftts1nbwy4636rew",
"name": "Customers"
}
],
"created_at": "2026-11-13T19:17:05.010421Z",
"data": {
"plan_tier": "gold"
},
"email": "jo@example.com",
"external_id": "crm-1042",
"first_name": "Jo",
"id": "con_01m7b5f3vjesvr9mwvjs4c9ga4",
"last_name": "Bloggs",
"phone_number": "+15555550100",
"updated_at": "2026-11-13T19:17:05.010421Z"
},
"joined_at": "2026-11-13T19:17:05.010421Z"
}
],
"next_cursor": ""
}List audiences
List the audiences. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
limitnumber - How many to return, 1 to 100. Bird's default is 20.From 1 to 100.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
audienceslist- The audiences
countnumber- How many on this page
next_cursortext- Pass as 'after' for the next page; empty on the last one
Example output
{
"audiences": [
{
"created_at": "2026-11-13T19:17:05.010421Z",
"description": "Paying customers",
"id": "adn_01m7b5f467ftts1nbwy4636rew",
"name": "Customers",
"type": "static",
"updated_at": "2026-11-13T19:17:05.010421Z"
}
],
"count": 1,
"next_cursor": ""
}List contact properties
List the custom contact properties, archived ones included. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
limitnumber - How many to return, 1 to 100. Bird's default is 20.From 1 to 100.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many on this page
next_cursortext- Pass as 'after' for the next page; empty on the last one
propertieslist- The properties
Example output
{
"count": 1,
"next_cursor": "",
"properties": [
{
"archived": false,
"created_at": "2026-11-13T19:17:05.010421Z",
"fallback_value": "free",
"id": "prp_01m7b5f3f8fftb6xyh5z579x6f",
"key": "plan_tier",
"type": "string",
"updated_at": "2026-11-13T19:17:05.010421Z"
}
]
}List contacts
List contacts, newest first, searched by text, exact email or your own id. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Search
qtext - Only those whose details contain this text, ignoring case.
- Exact email address
emailtext - Only the contact with exactly this email.
- Your own ID
external_idtext - Only the contact with exactly this id of yours.
- Page size
limitnumber - How many to return, 1 to 100. Bird's default is 20.From 1 to 100.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
contactslist- The contacts
countnumber- How many on this page
next_cursortext- Pass as 'after' for the next page; empty on the last one
Example output
{
"contacts": [
{
"audiences": [
{
"id": "adn_01m7b5f467ftts1nbwy4636rew",
"name": "Customers"
}
],
"created_at": "2026-11-13T19:17:05.010421Z",
"data": {
"plan_tier": "gold"
},
"email": "jo@example.com",
"external_id": "crm-1042",
"first_name": "Jo",
"id": "con_01m7b5f3vjesvr9mwvjs4c9ga4",
"last_name": "Bloggs",
"phone_number": "+15555550100",
"updated_at": "2026-11-13T19:17:05.010421Z"
}
],
"count": 1,
"next_cursor": ""
}List email events
List what happened to an email, in order: accepted, processed, delivered, opened, clicked or bounced. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Email ID
message_idtextRequired - The email's id (it starts with em_), from 'Send email', 'List emails' or an earlier step.
- Page size
limitnumber - How many to return, 1 to 100. Bird's default is 20.From 1 to 100.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many on this page
eventslist- The events
next_cursortext- Pass as 'after' for the next page; empty on the last one
Example output
{
"count": 1,
"events": [
{
"id": "ev_01m7b5hckffvstq905k6drcw68",
"occurred_at": "2026-11-13T19:17:05.010421Z",
"recipient_id": "er_01m7b5hcf9f9ktcxgwntesfza0",
"type": "email.delivered"
}
],
"next_cursor": ""
}List emails
List emails sent from the workspace, newest first, filtered by status, category, address or date. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Status
statustext - Only emails in this delivery status.One of:
scheduled,accepted,processed,deferred,delivered,partial_failure(Partly failed),bounced,complained(Marked as spam),rejected,canceled. - Category
categorytext - Only emails of this category.One of:
marketing(Marketing (default): skips people who unsubscribed),transactional(Transactional: receipts, alerts, one-to-one). - To address
totext - Only emails sent to exactly this address.
- From address
from_emailtext - Only emails sent from exactly this address.
- Sent on or after
created_afterdate and time - Only emails created at or after this date and time.
- Page size
limitnumber - How many to return, 1 to 100. Bird's default is 20.From 1 to 100.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many on this page
messageslist- The emails
next_cursortext- Pass as 'after' for the next page; empty on the last one
Example output
{
"count": 1,
"messages": [
{
"accepted_count": 0,
"bcc": [],
"bounced_count": 0,
"category": "transactional",
"cc": [],
"click_count": 0,
"complained_count": 0,
"created_at": "2026-11-13T19:17:05.010421Z",
"deferred_count": 0,
"delivered_at": "2026-11-13T19:17:05.010421Z",
"delivered_count": 1,
"from": {
"email": "onboarding@messagebird.dev",
"name": "Acme"
},
"id": "em_01m7b5hcf9f9nryn4dmwetv0p9",
"open_count": 0,
"processed_count": 0,
"rejected_count": 0,
"scheduled_at": "",
"status": "delivered",
"subject": "Welcome to Acme",
"to": [
{
"email": "delivered@messagebird.dev",
"name": ""
}
],
"track_clicks": true,
"track_opens": true
}
],
"next_cursor": ""
}List numbers
List the phone numbers the workspace holds. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Search
searchtext - Only numbers whose digits or name contain this text.
- Page size
limitnumber - How many to return, 1 to 100. Bird's default is 20.From 1 to 100.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many on this page
next_cursortext- Pass as 'after' for the next page; empty on the last one
numberslist- The numbers
Example output
{
"count": 1,
"next_cursor": "",
"numbers": [
{
"capabilities": [
"sms",
"voice"
],
"country_code": "US",
"created_at": "2026-11-13T19:17:05.010421Z",
"id": "num_01m7b5hcf9f9nryn4dmwetv0p9",
"number": "+15555550100",
"number_type": "local"
}
]
}List SMS senders
List the numbers and sender names the workspace can send SMS from.
Inputs
- Page size
limitnumber - How many to return, 1 to 100. Bird's default is 20.From 1 to 100.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many on this page
next_cursortext- Pass as 'after' for the next page; empty on the last one
senderslist- The senders
Example output
{
"count": 1,
"next_cursor": "",
"senders": [
{
"created_at": "2026-11-13T19:17:05.010421Z",
"id": "snd_01m7b5hcf9f9nryn4dmwetv0p9",
"sender": "Acme",
"type": "alphanumeric"
}
]
}List SMS templates
List Bird's built-in SMS templates and your own. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Search
qtext - Only those whose details contain this text, ignoring case.
- Page size
limitnumber - How many to return, 1 to 100. Bird's default is 20.From 1 to 100.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many on this page
next_cursortext- Pass as 'after' for the next page; empty on the last one
templateslist- The templates
Example output
{
"count": 1,
"next_cursor": "",
"templates": [
{
"available_languages": [
"en"
],
"category": "transactional",
"default_language": "en",
"description": "",
"id": "smt_2gbx9e7gwkae1rmvjmve9ht19d",
"name": "Appointment reminder",
"scope": "system",
"slug": "bird_appointment_reminder",
"status": "active"
}
]
}List webhooks
List the webhooks. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Page size
limitnumber - How many to return, 1 to 100. Bird's default is 20.From 1 to 100.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many on this page
next_cursortext- Pass as 'after' for the next page; empty on the last one
webhookslist- The webhooks
Example output
{
"count": 1,
"next_cursor": "",
"webhooks": [
{
"created_at": "2026-11-13T19:17:05.010421Z",
"description": "Delivery events",
"events": [
"email.delivered",
"email.bounced"
],
"id": "whk_01m7b5hcf9f9nryn4dmwetv0p9",
"secret": "",
"status": "active",
"updated_at": "2026-11-13T19:17:05.010421Z",
"url": "https://example.com/bird"
}
]
}Remove contacts from audience
Remove contacts from an audience. The contacts themselves are kept.
Inputs
- Audience
audience_idtextRequired - The audience. Pick one, or give its id from an earlier step.
- Contacts
contact_idslistRequired - The ids of the contacts, one per row, from 'List contacts' or earlier steps.
Outputs
audience_idtext- The audience
contact_idslist- The contacts removed
countnumber- How many contacts
Example output
{
"audience_id": "adn_01m7b5f467ftts1nbwy4636rew",
"contact_ids": [
"con_01m7b5f3vjesvr9mwvjs4c9ga4"
],
"count": 1
}Send email
Send an email, now or up to 30 days ahead. Bird accepts it at once and delivers it in the background; read it back with 'Get email'.
Inputs
- From address
from_emailtextRequired - The sender. Use an address on a domain you verified in Bird, or onboarding@messagebird.dev, Bird's shared test domain.
- From name
from_nametext - The sender's display name.
- To
tolistRequired - The recipients, one email address per row. To test safely, use delivered@messagebird.dev.
- Cc
cclist - Copy recipients, one email address per row.
- Bcc
bcclist - Hidden copy recipients, one email address per row.
- Subject
subjecttextRequired - The subject line.
- Plain text body
texttext - The message as plain text. Give this, the HTML body, or both.
- HTML body
htmltext - The message as HTML.
- Reply-to address
reply_totext - Where replies go, if not the sender.
- Category
categorytext - Marketing (the default) skips people who unsubscribed; transactional is for one-to-one messages such as receipts.One of:
marketing(Marketing (default): skips people who unsubscribed),transactional(Transactional: receipts, alerts, one-to-one). - Send at
scheduled_atdate and time - Send later, between 30 seconds and 30 days from now. Leave empty to send now.
Outputs
messageobject- The email, as accepted
Example output
{
"message": {
"accepted_count": 1,
"bcc": [],
"bounced_count": 0,
"category": "transactional",
"cc": [],
"click_count": 0,
"complained_count": 0,
"created_at": "2026-11-13T19:17:05.010421Z",
"deferred_count": 0,
"delivered_at": "2026-11-13T19:17:05.010421Z",
"delivered_count": 0,
"from": {
"email": "onboarding@messagebird.dev",
"name": "Acme"
},
"id": "em_01m7b5hcf9f9nryn4dmwetv0p9",
"open_count": 0,
"processed_count": 0,
"rejected_count": 0,
"scheduled_at": "",
"status": "accepted",
"subject": "Welcome to Acme",
"to": [
{
"email": "delivered@messagebird.dev",
"name": ""
}
],
"track_clicks": true,
"track_opens": true
}
}Update audience
Rename an audience or change its description.
Inputs
- Audience
audience_idtextRequired - The audience. Pick one, or give its id from an earlier step.
- New name
nametext - Replace the audience's name.
- New description
descriptiontext - Replace the description.
Outputs
audienceobject- The audience, as updated
Example output
{
"audience": {
"created_at": "2026-11-13T19:17:05.010421Z",
"description": "Paying customers",
"id": "adn_01m7b5f467ftts1nbwy4636rew",
"name": "Customers",
"type": "static",
"updated_at": "2026-11-13T19:17:05.010421Z"
}
}Update contact
Change a contact's email, phone, name, your own id or custom properties. Fields left empty keep their values.
Inputs
- Contact ID
contact_idtextRequired - The contact's id, from 'List contacts', 'Create contact' or an earlier step.
- New email address
emailtext - Replace the contact's email address.
- First name
first_nametext - The contact's first name.
- Last name
last_nametext - The contact's last name.
- Phone number
phone_numbertext - With the country code, like +15555555555.
- Your own ID
external_idtext - Your own identifier for the contact, such as a user id in your system. Unique in the workspace.
- Custom properties
dataobject - Values for custom contact properties, by property name, such as {"plan_tier": "gold"}. Each name must exist (see 'Create contact property').
Outputs
contactobject- The contact, as updated
Example output
{
"contact": {
"audiences": [
{
"id": "adn_01m7b5f467ftts1nbwy4636rew",
"name": "Customers"
}
],
"created_at": "2026-11-13T19:17:05.010421Z",
"data": {
"plan_tier": "gold"
},
"email": "jo@example.com",
"external_id": "crm-1042",
"first_name": "Jo",
"id": "con_01m7b5f3vjesvr9mwvjs4c9ga4",
"last_name": "Bloggs",
"phone_number": "+15555550100",
"updated_at": "2026-11-13T19:17:05.010421Z"
}
}Update contact property
Change the fallback value templates use when a contact has none for the property.
Inputs
- Contact property
property_idtextRequired - The property. Pick one, or give its id from an earlier step.
- Fallback value
fallback_valuetextRequired - What templates use when a contact has no value for the property. Typed to the property.
Outputs
propertyobject- The property, as updated
Example output
{
"property": {
"archived": false,
"created_at": "2026-11-13T19:17:05.010421Z",
"fallback_value": "free",
"id": "prp_01m7b5f3f8fftb6xyh5z579x6f",
"key": "plan_tier",
"type": "string",
"updated_at": "2026-11-13T19:17:05.010421Z"
}
}Update webhook
Change a webhook's address, events or label, or pause and resume it.
Inputs
- Webhook
webhook_idtextRequired - The webhook. Pick one, or give its id from an earlier step.
- New address
urltext - Replace the https:// address.
- Events
eventslist - Replace the events sent. Leave empty to keep them.One or more of:
email.accepted(Email accepted),email.processed(Email processed),email.delivered(Email delivered),email.deferred(Email deferred),email.bounced(Email bounced),email.rejected(Email rejected),email.opened(Email opened),email.clicked(Email link clicked),email.complained(Email marked as spam),email.unsubscribed(Email unsubscribed), and 16 more. - Label
descriptiontext - A name for the webhook, so you can tell it apart.
- Status
statustext - Pause stops all deliveries; active resumes them.One of:
active(Active: deliver events),paused(Paused: stop delivering).
Outputs
webhookobject- The webhook, as updated
Example output
{
"webhook": {
"created_at": "2026-11-13T19:17:05.010421Z",
"description": "Delivery events",
"events": [
"email.delivered",
"email.bounced"
],
"id": "whk_01m7b5hcf9f9nryn4dmwetv0p9",
"secret": "whsec_example",
"status": "active",
"updated_at": "2026-11-13T19:17:05.010421Z",
"url": "https://example.com/bird"
}
}