Podium
App · 25 actions
Manage Podium contacts and appointments, send messages, create review invites, and read conversations, reviews and invoices.
Actions
| Action | What it does |
|---|---|
| Create appointment | Create an appointment. |
| Create contact | Create a contact. |
| Create review invite | Create a review invite link for a customer, sent by email or phone number. |
| Delete contact | Delete a contact, found by conversation ID, email or phone number. |
| Get appointment | Get one appointment by its ID. |
| Get contact | Get a contact by conversation ID, email or phone number. |
| Get conversation | Get one conversation by its ID. |
| Get invoice | Get one invoice by its ID. |
| Get location | Get one location by its ID. |
| Get message | Get one message from a conversation. |
| Get review | Get one review by its ID. |
| Get user | Get one user by their ID. |
| List appointments | List appointments for the locations you can access, oldest change first by default. |
| List contacts | List all contacts. |
| List conversations | List conversations, both open and closed. |
| List invoices | List invoices that match your filters. |
| List locations | List the Podium locations you have access to. |
| List messages | List messages in a conversation, a limited number at a time. |
| List payment accounts | List the Payments accounts for your locations, or for one location. |
| List reviews | List the reviews you have access to, newest first. |
| List templates | List all message templates. |
| List users | List the users who belong to the locations you have access to. |
| Send message | Send a message to a contact from a location. |
| Update contact | Update a contact, found by conversation ID, email or phone number. |
| Update conversation | Update a conversation. |
Create appointment
Create an appointment.
Inputs
- Assigned user uid
assigned_user_uidtext - Podium unique identifier for user.
- Contact name
contact_nametextRequired - Name of the contact.
- Contact phone number
contact_phone_numbertextRequired - Phone number of the contact. Phone number should be formatted as '+15555555555'
- Datetime
datetimedate and timeRequired - Date and time of the appointment.
- Duration min
duration_minnumber - How many minutes long the appointment is.
- Location uid
location_uidtextRequired - Podium unique identifier for location.
- Note
notetext - Note that is attached to the appointment.
- Status
statustext - Status of the appointment.One of:
cancelled,completed,confirmed,no_show(No show),unconfirmed. Default:unconfirmed. - Type
typetext - Type of appointment.One of:
in_person(In person),virtual. Default:in_person.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"aiGenerated": false,
"appointmentType": "example",
"assignedUser": {
"uid": "example"
},
"confirmation": {
"status": "confirmed",
"updatedAt": "example"
},
"contact": {
"uid": "example"
},
"contactName": "example",
"contactPhoneNumber": "example",
"createdAt": "example",
"customFields": [],
"datetime": "example",
"description": "example",
"durationMin": 1,
"endAt": "example",
"externalId": "example",
"externalStatus": "example",
"integrationUid": "example",
"location": {
"uid": "example"
},
"note": "example",
"startAt": "example",
"status": "cancelled",
"title": "example",
"type": "in_person",
"uid": "example",
"updatedAt": "example"
},
"metadata": {
"url": "example"
}
}
}Create contact
Create a contact. If a contact with the same phone number, email or conversation ID already exists, that contact is updated instead.
Inputs
- Address
addressobject - The address of the resource
- Attributes
attributeslist - List of attribute objects
- Contact status
contact_statusobject - A contact status, you need either the name or uid
- Email
emailtext - The email address of the resource
- Locations
locationslistRequired - List of location UIDs
- Name
nametextRequired - The name of the resource
- Phone number
phone_numbertext - The phone number of the resource
- Tags
tagslist - List of tag UIDs
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"identifier": "example"
},
"metadata": {
"url": "example"
}
}
}Create review invite
Create a review invite link for a customer, sent by email or phone number.
Inputs
- Email
emailtext - The customer email. Required if phoneNumber not present
- Location uid
location_uidtextRequired - Podium location identifier that review invite link will be created for
- Phone number
phone_numbertext - The customer phone number.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"attributions": [],
"channel": {
"identifier": "example",
"type": "apple"
},
"conversationItemUid": "example",
"createdAt": "example",
"customerName": "example",
"deliveryStatus": "failed",
"languages": [],
"linkClicked": false,
"linkClickedAt": "example",
"location": {
"organizationUid": "example",
"uid": "example"
},
"sender": {
"name": "example",
"sentThrough": "client_app",
"type": "user",
"uid": "example"
},
"shortUrl": "example",
"test": false,
"uid": "example",
"updatedAt": "example",
"url": "example"
},
"metadata": {
"url": "example"
}
}
}Delete contact
Delete a contact, found by conversation ID, email or phone number.
Inputs
- Identifier
identifiertextRequired - Conversation uid, phone number, or email to identify the contact. Phone number should be formatted as '+15555555555'
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"identifier": "example"
},
"metadata": {
"url": "example"
}
}
}Get appointment
Get one appointment by its ID.
Inputs
- Uid
uidtextRequired - Podium unique identifier for appointment.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"aiGenerated": false,
"appointmentType": "example",
"assignedUser": {
"uid": "example"
},
"confirmation": {
"status": "confirmed",
"updatedAt": "example"
},
"contact": {
"uid": "example"
},
"contactName": "example",
"contactPhoneNumber": "example",
"createdAt": "example",
"customFields": [],
"datetime": "example",
"description": "example",
"durationMin": 1,
"endAt": "example",
"externalId": "example",
"externalStatus": "example",
"integrationUid": "example",
"location": {
"uid": "example"
},
"note": "example",
"startAt": "example",
"status": "cancelled",
"title": "example",
"type": "in_person",
"uid": "example",
"updatedAt": "example"
},
"metadata": {
"url": "example"
}
}
}Get contact
Get a contact by conversation ID, email or phone number.
Inputs
- Identifier
identifiertextRequired - Conversation uid, phone number, or email to identify the contact. Phone number should be formatted as '+15555555555'
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"address": {
"addressLine1": "example",
"addressLine2": "example",
"city": "example",
"country": "example",
"postalCode": "example",
"state": "example"
},
"attributes": [],
"channels": [],
"conversations": [],
"createdAt": "example",
"emails": [],
"locations": [],
"name": "example",
"organization": {
"uid": "example"
},
"phoneNumbers": [],
"tags": [],
"uid": "example",
"updatedAt": "example"
},
"metadata": {
"url": "example"
}
}
}Get conversation
Get one conversation by its ID.
Inputs
- Uid
uidtextRequired - Podium unique identifier for conversation.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"assignedUserUid": "example",
"assigneeUids": [],
"channel": {
"identifier": "example",
"type": "apple"
},
"closed": false,
"contactName": "example",
"createdAt": "example",
"lastItemAt": "example",
"locationUid": "example",
"uid": "example",
"updatedAt": "example"
},
"metadata": {
"url": "example"
}
}
}Get invoice
Get one invoice by its ID.
Inputs
- Uid
uidtextRequired - Podium unique identifier for invoice.
- Location uid
location_uidtextRequired - Podium unique identifier for location.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"allowedPaymentMethods": [],
"amount": 1,
"canceledAt": "example",
"canceledNote": "example",
"channel": {
"identifier": "example",
"type": "apple"
},
"conversationUid": "example",
"createdAt": "example",
"currencyRef": "example",
"customerName": "example",
"invoiceNumber": "example",
"invoiceServiceChargeItems": [],
"lineItems": [],
"location": {
"organizationUid": "example",
"uid": "example"
},
"paidAt": "example",
"paymentNet": 1,
"payments": [],
"readerUid": "example",
"requester": "example",
"status": "canceled",
"surchargeAmount": 1,
"surchargeRate": 1.0,
"tipAmount": 1,
"uid": "example"
},
"metadata": {
"url": "example"
}
}
}Get location
Get one location by its ID.
Inputs
- Uid
uidtextRequired - Podium unique identifier for location.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"address": "example",
"addressDetails": {
"city": "example",
"country": "example",
"countryLongName": "example",
"houseNumber": "example",
"postalCode": "example",
"road": "example",
"state": "example",
"stateLongName": "example",
"unit": "example"
},
"archived": false,
"archivedAt": "example",
"createdAt": "example",
"displayName": "example",
"name": "example",
"organizationUid": "example",
"phoneNumber": "example",
"podiumPhoneNumber": "example",
"uid": "example",
"updatedAt": "example"
},
"metadata": {
"url": "example"
}
}
}Get message
Get one message from a conversation.
Inputs
- Uid
uidtextRequired - Podium unique identifier for message.
- Conversation uid
conversation_uidtextRequired - Podium unique identifier for conversation.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"attachmentUrl": "example",
"body": "example",
"contact": {
"externalIdentifier": "example",
"name": "example",
"uid": "example"
},
"contactName": "example",
"conversation": {
"assignedUserUid": "example",
"channel": {
"identifier": "example",
"type": "apple"
},
"startedAt": "example",
"uid": "example"
},
"createdAt": "example",
"failureReason": "example",
"items": [],
"location": {
"organizationUid": "example",
"uid": "example"
},
"sender": {
"uid": "example"
},
"senderUid": "example",
"uid": "example",
"webchatUrl": "example"
},
"metadata": {
"url": "example"
}
}
}Get review
Get one review by its ID.
Inputs
- Uid
uidtextRequired - Podium unique identifier for review.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"attributions": [],
"author": {
"id": "example",
"name": "example"
},
"createdAt": "example",
"isRecommendation": false,
"locations": [],
"needsResponse": false,
"responses": [],
"review": {
"body": "example",
"rating": 1.0,
"siteName": "example",
"siteReviewId": "example",
"url": "example"
},
"uid": "example",
"updatedAt": "example"
},
"metadata": {
"url": "example"
}
}
}Get user
Get one user by their ID.
Inputs
- Uid
uidtextRequired - Podium unique identifier for user.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"archived": false,
"createdAt": "example",
"email": "example",
"firstName": "example",
"lastName": "example",
"locations": [],
"phone": "example",
"role": "example",
"uid": "example",
"updatedAt": "example"
},
"metadata": {
"url": "example"
}
}
}List appointments
List appointments for the locations you can access, oldest change first by default. Since keeps only appointments changed at or after that time. Pass a cursor from a previous page on its own to get the next page; it keeps the filters of the page it came from.
Inputs
- Cursor
cursortext - Cursor used to access next or previous page in pagination.
- Limit
limitnumber - Max number of items to return per request. Defaults to 10.From 0 to 100. Default:
10. - Location uid
location_uidtext - Podium unique identifier for location.
- Order
ordertext - Order by updatedAt: asc for oldest change first, desc for most recently updated first. Defaults to asc, the order to poll in: a poll interrupted partway resumes from where it stopped. desc suits a one-off look at the latest changes but is unsafe for incremental sync with since: a record updated during the traversal lands at the front and shifts every later page.One of:
asc,desc. - Since
sincedate and time - Date time in Coordinated Universal Time (UTC).
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"metadata": {
"nextCursor": "example",
"url": "example"
}
}
}List contacts
List all contacts.
Inputs
- Cursor
cursortext - Cursor used to access next or previous page in pagination.
- Limit
limitnumber - Max number of items to return per request. Defaults to 10.From 1 to 100. Default:
10. - Updated at
updated_attext - Filter contacts by updated_at. It will retrieve contacts updated after the provided date. Format: YYYY-MM-DDTHH:MM:SSZ
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"address": {
"addressLine1": "example",
"addressLine2": "example",
"city": "example",
"country": "example",
"postalCode": "example",
"state": "example"
},
"attributes": [],
"channels": [],
"conversations": [],
"createdAt": "example",
"emails": [],
"locations": [],
"name": "example",
"organization": {
"uid": "example"
},
"phoneNumbers": [],
"tags": [],
"uid": "example",
"updatedAt": "example"
},
"metadata": {
"url": "example"
}
}
}List conversations
List conversations, both open and closed. Since keeps only conversations with activity at or after that time. Pass a cursor from a previous page to get the next page; other filters are then ignored.
Inputs
- Cursor
cursortext - Cursor used to access next or previous page in pagination.
- Limit
limitnumber - Max number of items to return per request. Defaults to 10.From 0 to 100. Default:
10. - Location uid
location_uidtext - Podium unique identifier for location.
- Order
ordertext - Order by last activity: asc for oldest first, desc for most recent first. Defaults to desc when since is given, and to the historical creation order otherwise. Use asc when polling, so that a poll interrupted partway resumes from where it stopped rather than restarting. Follow nextCursor until it is null before advancing since: since is inclusive and last-activity timestamps are not unique, so moving the watermark mid-traversal skips any records left sharing the boundary timestamp, and leaving iOne of:
asc,desc. - Since
sincedate and time - Date time in Coordinated Universal Time (UTC).
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"assignedUserUid": "example",
"assigneeUids": [],
"channel": {
"identifier": "example",
"type": "apple"
},
"closed": false,
"contactName": "example",
"createdAt": "example",
"lastItemAt": "example",
"locationUid": "example",
"uid": "example",
"updatedAt": "example"
},
"metadata": {
"url": "example"
}
}
}List invoices
List invoices that match your filters.
Inputs
- Location uid
location_uidtext - Podium unique identifier for location.
- Date paid
date_paiddate and time - Date time in Coordinated Universal Time (UTC).
- Date refunded
date_refundeddate and time - Date time in Coordinated Universal Time (UTC).
- Date created
date_createddate and time - Date time in Coordinated Universal Time (UTC).
- Limit
limitnumber - Max number of items to return per request. Defaults to 10.From 0 to 100. Default:
10. - Cursor
cursortext - Cursor used to access next or previous page in pagination.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"metadata": {
"nextCursor": "example",
"previousCursor": "example",
"totalItems": 1,
"url": "example"
}
}
}List locations
List the Podium locations you have access to. You can filter by search text and by when locations were created or updated. Pass a cursor from a previous page to get the next page; it keeps that page's filters and any other filters are then ignored.
Inputs
- Search
searchtext - String you would like to search for in the searchFields parameter.
- Search fields
search_fieldslist - A list of the fields where you want to search for the search parameters. e.g. ?searchFields[]=name&searchFields[]=displaynameOne or more of:
address,displayName,name,podiumPhoneNumber. Default:["name"]. - Limit
limitnumber - Max number of items to return per request. Defaults to 10.From 0 to 100. Default:
10. - Created after
created_afterdate and time - Date time in Coordinated Universal Time (UTC).
- Created before
created_beforedate and time - Date time in Coordinated Universal Time (UTC).
- Updated after
updated_afterdate and time - Date time in Coordinated Universal Time (UTC).
- Cursor
cursortext - Cursor used to access next or previous page in pagination.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"metadata": {
"nextCursor": "example",
"previousCursor": "example",
"totalItems": 1,
"url": "example"
}
}
}List messages
List messages in a conversation, a limited number at a time. You can filter by time and choose the order. Pass a cursor from a previous page to get the next page; it keeps the filters of the page it came from.
Inputs
- Conversation uid
conversation_uidtextRequired - Podium unique identifier for conversation.
- Cursor
cursortext - Cursor used to access next or previous page in pagination.
- Order
ordertext - Order by publish date: asc for oldest first, desc for most recent first. Defaults to desc. Use asc when polling, so that a poll interrupted partway resumes from where it stopped rather than restarting. Follow nextCursor until it is null before advancing since: since is inclusive and publish dates are not unique, so moving the watermark mid-traversal skips any records left sharing the boundary timestamp, and leaving it in place repeats the whole page.One of:
asc,desc. - Since
sincedate and time - Date time in Coordinated Universal Time (UTC).
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"metadata": {
"nextCursor": "example",
"previousCursor": "example",
"totalItems": 1,
"url": "example"
}
}
}List payment accounts
List the Payments accounts for your locations, or for one location. Use an account's ID to tell which account an invoice was paid into. Podium must approve your app for this before it works.
Inputs
- Location uid
location_uidtext - Podium unique identifier for location.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"metadata": {
"url": "example"
}
}
}List reviews
List the reviews you have access to, newest first. Pass a cursor from a previous page to get the next page; other filters are then ignored.
Inputs
- Created at
created_atobject - Filter on the createdAt date.
- Cursor
cursortext - Cursor used to access next or previous page in pagination.
- Limit
limitnumber - Max number of items to return per request. Defaults to 10.From 0 to 100. Default:
10. - Updated at
updated_atobject - Filter on the updatedAt date.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"metadata": {
"nextCursor": "example",
"previousCursor": "example",
"totalItems": 1,
"url": "example"
}
}
}List templates
List all message templates.
Inputs
- Types
typeslist - Filter by types: "custom", "review_invite", or "review_invite_backup", defaults to "custom"One or more of:
custom,review_invite(Review invite),review_invite_backup(Review invite backup). - Location uid
location_uidtext - Podium unique identifier for location.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"metadata": {
"url": "example"
}
}
}List users
List the users who belong to the locations you have access to. Pass a cursor from a previous page to get the next page; other filters are then ignored.
Inputs
- Search
searchtext - String you would like to search for in the searchFields parameter.
- Created at
created_atobject - Filter on the createdAt date.
- Search fields
search_fieldslist - A list of the fields where you want to search for the search parameters. e.g. ?searchFields[]=name&searchFields[]=displaynameOne or more of:
address,phone,fullName. Default:["fullName"]. - Limit
limitnumber - Max number of items to return per request. Defaults to 10.From 0 to 100. Default:
10. - Cursor
cursortext - Cursor used to access next or previous page in pagination.
- Include agents
include_agentstrue/false - Include users with ai_agent role. Defaults to true if not specified.Default:
true.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"metadata": {
"nextCursor": "example",
"previousCursor": "example",
"totalItems": 1,
"url": "example"
}
}
}Send message
Send a message to a contact from a location. A message sent on behalf of a user only goes through if that user is allowed to send messages in the conversation.
Inputs
- Body
bodytextRequired - Text of the message.
- Contact name
contact_nametext - Name of the contact to send the message to. If a contact already exists for the channel then their name will be updated.
- Location uid
location_uidtextRequired - Podium unique identifier for location.
- Sender name
sender_nametext - The name that will be credited with sending the message. This will appear under the sent message in the Podium app.
- Set open inbox
set_open_inboxtrue/false - new conversations will be created in a 'closed' state by default. This will override that setting going to 'open' inbox.Default:
false. - Subject
subjecttext - Subject of the message.
- Channel type
channel_typetextRequired - Channel type.One of:
email,phone. - Recipient
recipienttextRequired - Destination email or phone number, including the country code.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"attachmentUrl": "example",
"body": "example",
"contact": {
"externalIdentifier": "example",
"name": "example",
"uid": "example"
},
"contactName": "example",
"conversation": {
"assignedUserUid": "example",
"channel": {
"identifier": "example",
"type": "apple"
},
"startedAt": "example",
"uid": "example"
},
"createdAt": "example",
"failureReason": "example",
"items": [],
"location": {
"organizationUid": "example",
"uid": "example"
},
"sender": {
"uid": "example"
},
"senderUid": "example",
"uid": "example",
"webchatUrl": "example"
},
"metadata": {
"url": "example"
}
}
}Update contact
Update a contact, found by conversation ID, email or phone number.
Inputs
- Identifier
identifiertextRequired - Conversation uid, phone number, or email to identify the contact. Phone number should be formatted as '+15555555555'
- Address
addressobject - The address of the resource
- Contact status
contact_statusobject - A contact status, you need either the name or uid
- Conversation uid
conversation_uidtext - Podium unique identifier for conversation.
- Email
emailtext - The email address of the resource
- Locations
locationslist - List of location UIDs
- Name
nametext - The name of the resource
- Phone number
phone_numbertext - The phone number of the resource
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"identifier": "example"
},
"metadata": {
"url": "example"
}
}
}Update conversation
Update a conversation.
Inputs
- Uid
uidtextRequired - Podium unique identifier for conversation.
- Assigned by name
assigned_by_nametext - The name used in conversation assignment managerial items
- Assigned user uid
assigned_user_uidtext - Podium unique identifier for user.
- Closed
closedtrue/false - Whether the conversation is open or closed.
- Conversation assignee uids
conversation_assignee_uidslist - List of assignee user UIDs
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"assignedUserUid": "example",
"assigneeUids": [],
"channel": {
"identifier": "example",
"type": "apple"
},
"closed": false,
"contactName": "example",
"createdAt": "example",
"lastItemAt": "example",
"locationUid": "example",
"uid": "example",
"updatedAt": "example"
},
"metadata": {
"url": "example"
}
}
}