Podium

App · 25 actions

Manage Podium contacts and appointments, send messages, create review invites, and read conversations, reviews and invoices.

Actions

ActionWhat it does
Create appointmentCreate an appointment.
Create contactCreate a contact.
Create review inviteCreate a review invite link for a customer, sent by email or phone number.
Delete contactDelete a contact, found by conversation ID, email or phone number.
Get appointmentGet one appointment by its ID.
Get contactGet a contact by conversation ID, email or phone number.
Get conversationGet one conversation by its ID.
Get invoiceGet one invoice by its ID.
Get locationGet one location by its ID.
Get messageGet one message from a conversation.
Get reviewGet one review by its ID.
Get userGet one user by their ID.
List appointmentsList appointments for the locations you can access, oldest change first by default.
List contactsList all contacts.
List conversationsList conversations, both open and closed.
List invoicesList invoices that match your filters.
List locationsList the Podium locations you have access to.
List messagesList messages in a conversation, a limited number at a time.
List payment accountsList the Payments accounts for your locations, or for one location.
List reviewsList the reviews you have access to, newest first.
List templatesList all message templates.
List usersList the users who belong to the locations you have access to.
Send messageSend a message to a contact from a location.
Update contactUpdate a contact, found by conversation ID, email or phone number.
Update conversationUpdate a conversation.

Create appointment

Create an appointment.

Inputs

Assigned user uidassigned_user_uidtext
Podium unique identifier for user.
Contact namecontact_nametextRequired
Name of the contact.
Contact phone numbercontact_phone_numbertextRequired
Phone number of the contact. Phone number should be formatted as '+15555555555'
Datetimedatetimedate and timeRequired
Date and time of the appointment.
Duration minduration_minnumber
How many minutes long the appointment is.
Location uidlocation_uidtextRequired
Podium unique identifier for location.
Notenotetext
Note that is attached to the appointment.
Statusstatustext
Status of the appointment.One of: cancelled, completed, confirmed, no_show (No show), unconfirmed. Default: unconfirmed.
Typetypetext
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

Addressaddressobject
The address of the resource
Attributesattributeslist
List of attribute objects
Contact statuscontact_statusobject
A contact status, you need either the name or uid
Emailemailtext
The email address of the resource
LocationslocationslistRequired
List of location UIDs
NamenametextRequired
The name of the resource
Phone numberphone_numbertext
The phone number of the resource
Tagstagslist
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

Emailemailtext
The customer email. Required if phoneNumber not present
Location uidlocation_uidtextRequired
Podium location identifier that review invite link will be created for
Phone numberphone_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

IdentifieridentifiertextRequired
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

UiduidtextRequired
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

IdentifieridentifiertextRequired
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

UiduidtextRequired
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

UiduidtextRequired
Podium unique identifier for invoice.
Location uidlocation_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

UiduidtextRequired
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

UiduidtextRequired
Podium unique identifier for message.
Conversation uidconversation_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

UiduidtextRequired
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

UiduidtextRequired
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

Cursorcursortext
Cursor used to access next or previous page in pagination.
Limitlimitnumber
Max number of items to return per request. Defaults to 10.From 0 to 100. Default: 10.
Location uidlocation_uidtext
Podium unique identifier for location.
Orderordertext
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.
Sincesincedate 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

Cursorcursortext
Cursor used to access next or previous page in pagination.
Limitlimitnumber
Max number of items to return per request. Defaults to 10.From 1 to 100. Default: 10.
Updated atupdated_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

Cursorcursortext
Cursor used to access next or previous page in pagination.
Limitlimitnumber
Max number of items to return per request. Defaults to 10.From 0 to 100. Default: 10.
Location uidlocation_uidtext
Podium unique identifier for location.
Orderordertext
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.
Sincesincedate 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 uidlocation_uidtext
Podium unique identifier for location.
Date paiddate_paiddate and time
Date time in Coordinated Universal Time (UTC).
Date refundeddate_refundeddate and time
Date time in Coordinated Universal Time (UTC).
Date createddate_createddate and time
Date time in Coordinated Universal Time (UTC).
Limitlimitnumber
Max number of items to return per request. Defaults to 10.From 0 to 100. Default: 10.
Cursorcursortext
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

Searchsearchtext
String you would like to search for in the searchFields parameter.
Search fieldssearch_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"].
Limitlimitnumber
Max number of items to return per request. Defaults to 10.From 0 to 100. Default: 10.
Created aftercreated_afterdate and time
Date time in Coordinated Universal Time (UTC).
Created beforecreated_beforedate and time
Date time in Coordinated Universal Time (UTC).
Updated afterupdated_afterdate and time
Date time in Coordinated Universal Time (UTC).
Cursorcursortext
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 uidconversation_uidtextRequired
Podium unique identifier for conversation.
Cursorcursortext
Cursor used to access next or previous page in pagination.
Orderordertext
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.
Sincesincedate 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 uidlocation_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 atcreated_atobject
Filter on the createdAt date.
Cursorcursortext
Cursor used to access next or previous page in pagination.
Limitlimitnumber
Max number of items to return per request. Defaults to 10.From 0 to 100. Default: 10.
Updated atupdated_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

Typestypeslist
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 uidlocation_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

Searchsearchtext
String you would like to search for in the searchFields parameter.
Created atcreated_atobject
Filter on the createdAt date.
Search fieldssearch_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"].
Limitlimitnumber
Max number of items to return per request. Defaults to 10.From 0 to 100. Default: 10.
Cursorcursortext
Cursor used to access next or previous page in pagination.
Include agentsinclude_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

BodybodytextRequired
Text of the message.
Contact namecontact_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 uidlocation_uidtextRequired
Podium unique identifier for location.
Sender namesender_nametext
The name that will be credited with sending the message. This will appear under the sent message in the Podium app.
Set open inboxset_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.
Subjectsubjecttext
Subject of the message.
Channel typechannel_typetextRequired
Channel type.One of: email, phone.
RecipientrecipienttextRequired
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

IdentifieridentifiertextRequired
Conversation uid, phone number, or email to identify the contact. Phone number should be formatted as '+15555555555'
Addressaddressobject
The address of the resource
Contact statuscontact_statusobject
A contact status, you need either the name or uid
Conversation uidconversation_uidtext
Podium unique identifier for conversation.
Emailemailtext
The email address of the resource
Locationslocationslist
List of location UIDs
Namenametext
The name of the resource
Phone numberphone_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

UiduidtextRequired
Podium unique identifier for conversation.
Assigned by nameassigned_by_nametext
The name used in conversation assignment managerial items
Assigned user uidassigned_user_uidtext
Podium unique identifier for user.
Closedclosedtrue/false
Whether the conversation is open or closed.
Conversation assignee uidsconversation_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"
    }
  }
}

On this page