Podium Workflows

List of all the locations that the caller has access to. If the cursor parameter is used then all other parameters will be ignored. This is to avoid confusion if passing both a cursor and other parameters which would change what data is being returned. Required scope: read_locations. Mocked via Mockzilla.

Gets a single location by its uid. Required scope: read_locations.

Update a single location by its uid. Required scope: write_locations. Be aware: The addressDetails property follows the ISO convention. You might see errors if trying to update a location's address with an invalid address.

Gets a single organization by its uid. Required scope: read_organizations.

List of all the users that belong to any of the locations that the caller has access to. If the cursor parameter is used then all other parameters will be ignored. This is to avoid confusion if passing both a cursor and other parameters which would change what data is being returned. Required scope: read_users.

Gets a user. Required scope: read_users. Available as a Mockzilla mock endpoint.

Create an appointment. Required scope: write_appointments.

List the campaign interactions that the caller has access to. If the cursor parameter is used then all other parameters will be ignored. This is to avoid confusion if passing both a cursor and other parameters which would change what data is being returned. Interactions can be filtered by type, uid of the associated resource, or timestamp. Required scope: read_campaigns.

List of all the campaigns that the caller has access to. The campaigns are sorted by the updatedAt date, in descending order Campaigns can be filtered by their status using the status query parameter Required scope: read_campaigns.

Create a campaign. Required scope: write_campaigns.

Delete an existing campaign. Required scope: write_campaigns. Mockzilla mock: no signup, no API key.

Get a single campaign for the given uid. Required scope: read_campaigns.

update a campaign. Required scope: write_campaigns.

Send a message through a campaign. Required scope: write_campaign_messages.

List contact attributes that are tied to the ownerResource on the token. Required scope: read_contacts.

Create an application or organization level attribute to be used on contacts. Required scope: write_contacts. Served by the Mockzilla mock runtime.

Delete a contact attribute with its uid. Required scope: write_contacts.

Gets an application or organization level attribute by its uid, to be used on contacts. Required scope: read_contacts.

Update an application or organization level attribute to be used on contacts. Required scope: write_contacts.

List all tags for the organization. Required scope: read_contacts.

Create an organization level tag for a contact. Required scope: write_contacts. Mocked via Mockzilla.

Get a organization level tag given the provided uid. Required scope: read_contacts.

Update an organization level tag to be used on contacts. Required scope: write_contacts.

List all contacts. Required scope: read_contacts.

Create a contact. If a contact with the same phone number, email, or conversation uid is found it will update the contact. Required scope: write_contacts.

Opt in a contact into receiving campaign messages. Note: this endpoint requires your application to be whitelisted. Please contact our support team to get your application whitelisted. Required scope: write_contacts. Available as a Mockzilla mock endpoint.

Opt out a contact from receiving campaign messages. Note: this endpoint requires your application to be whitelisted. Please contact our support team to get your application whitelisted. Required scope: write_contacts

Delete a contact with a conversation uid, email, or phone number. Required scope: write_contacts.

Get a contact with a conversation uid, email, or phone number. Required scope: read_contacts.

Update a contact with using a conversation uid, email, or phone number as an identifier. Required scope: write_contacts.

Remove an attribute from a contact. Required scope: write_contacts. Mockzilla mock: no signup, no API key.

Update the value of an existing attribute inside an existing contact. Required scope: write_contacts.

Add an existing attribute to an existing contact. Required scope: write_contacts.

Remove an existing tag from an existing contact. Required scope: write_contacts.

Add an existing tag to an existing contact. Required scope: write_contacts.

List all conversations. If the cursor parameter is used then all other parameters will be ignored. This is to avoid confusion if passing both a cursor and other parameters which would change what data is being returned. Required scope: read_messages. Served by the Mockzilla mock runtime.

Gets a conversation that has previously been created. Required scope: read_messages.

Update a conversation. Required scope: write_messages.

Writeback lead to the connected CRM. Required scope: write_writebacks.

Creates a note for the given conversation. Required scope: write_messages.

List of all the feedback surveys that the caller has access to. The surveys are sorted by createdAt date, with the most recent appearing first. If the cursor parameter is used then all other parameters will be ignored. This is to avoid confusion if passing both a cursor and other parameters which would change what data is being returned. Required scope: read_feedback. Mocked via Mockzilla.

Create a feedback survey. The survey is created asynchronously, so only the UID is returned. Required scope: write_feedback.

Retrieve a message from a conversation. Required scope: read_messages.

Import a message from a different system. NOTE: This does not send a message to number, just imports it into a conversation on Podium's system. Required scope: write_messages.

Send a message. A message can only be sent on behalf of a user if they have the necessary permissions to send messages in: conversations assigned to them, conversations assigned to others, and unassigned conversations. Required scope: write_messages.

Send a message with an attachment. A message can only be sent on behalf of a user if they have the necessary permissions to send messages in: conversations assigned to them, conversations assigned to others, and unassigned conversations. Required scope: write_messages. Available as a Mockzilla mock endpoint.

List all templates. Required scope: read_templates.

Create a message template. Required scope: write_templates.

Deletes a template by the given uid. Required scope: write_templates

update a message template. Required scope: write_templates.

List of all invoices that match the query parameters. Required scope: read_payments. Mockzilla mock: no signup, no API key.

Creates an invoice which is either a card_present or a card_not_present invoice. Providing the reader_uid property will create a card_present invoice, but if no reader_uid is provided a card_not_present invoice will be created. Card Present Invoice A card-present-invoice is used to process an invoice through a card reader. After the invoice is created, there is a callback to the card reader to complete the transaction. If no accountUid is given, the card reader's default account is used. Card Not Present Invoice A card-not-present-invoice is used to process an invoice asynchronously. After the invoice is created, a payment link is sent to the customer from the merchants Podium account. The customer can click on the link to complete the transaction. If no accountUid is given, the most recently created account is used. Required scope: write_payments.

Gets an invoice that has previously been created. Required scope: read_payments.

Cancels an invoice. The seller cannot collect payments for the canceled invoice. Required scope: write_payments.

Refunds an invoice. The invoice must currently have a status of paid.If an invoice has a status of created it cannot be refunded, but can be canceled. An invoice can have multiple refunds. The total refunded amount cannot exceed the invoice's amount. Required scope: write_payments.

Gets a single payment by its uid. Required scope: read_payments. Served by the Mockzilla mock runtime.

Gets a single card reader by its uid. Required scope: read_payments.

Creates a refund. (see note) Use with caution. This action creates an Unlinked Refund that is not associated with an Podium Invoice or Payment. This current implementation only works with a Podium Payment Card Reader, reading the customer's credit card data before debiting the refunded amount. Balance requirements. This action requires that your account have on hand an amount equal to or greater than the amount of the refund. The amount for this refund will be deducted from the amount still to pay out from the account. If the account does not have sufficient funds, the refund will fail. Upcoming change: When this resource supports refunding a Podium Invoice, /invoices/uid/refund is planned to be deprecated. Required scope: write_payments.

Gets a refund that has previously been created. Required scope: read_payments.

List of all the reviews that you have access to. The reviews are sorted by createdAt date, with the most recent appearing first. If the cursor parameter is used then all other parameters will be ignored. This is to avoid confusion if passing both a cursor and other parameters which would change what data is being returned. Required scope: read_reviews.

List of all the review invites that you have access to. The review invites are sorted by createdAt date, with the most recent appearing first. If the cursor parameter is used then all other parameters will be ignored. This is to avoid confusion if passing both a cursor and other parameters which would change what data is being returned. Required scope: read_reviews. Mocked via Mockzilla.

Create a review invite link. Required scope: write_reviews.

Get a single review invite by its uid. Required scope: read_reviews.

Returns a summary of reviews grouped by the site they are from. NOTE: Our docs provider has a bug that doesn't show the correct usage of the locationUids parameter.In order for the request to succeed, for each locationUid you are querying for add a &locationUids[] parameter to the url.For example: https://api.podium.com/v4/reviews/sites/summary?locationUids[]=00000000-0000-0000-0000-000000000000&locationUids[]=00000000-0000-0000-0000-000000000001 If no locationUids parameter is used then the data will be based on all locations that the caller has access to. Required scope: read_reviews.

Returns a summary of reviews for each location. If thelocationUids parameter is not used then the data will be based on all locations that the caller has access to. Required scope: read_reviews.

Update a review response. Required scope: write_reviews. Available as a Mockzilla mock endpoint.

Gets a single review by its uid. Required scope: read_reviews.

Remove a user attribution from a review. Required scope: write_reviews.

Attributes a user to a review. Required scope: write_reviews.

List the responses of a given review. Required scope: read_reviews.

Create a response for a given review. Required scope: write_reviews. Mockzilla mock: no signup, no API key.

List webhooks that are tied to user who has authorized the application. Required scope: none.

Create a new webhook to receive events from a location or an organization. One of locationUid or organizationUid is required. If both are given the organizationUid will be used. Required scope: The required scope(s) will depend on the event type(s) you are subscribing too. See the WEBHOOK EVENT TYPES section.

Deletes an existing webhook. Required scope: none.

Get a webhook based on its uid. Required scope: none.

Updates an existing webhook. The location uid and organization uid cannot be updated. All other parameters not provided will be left unchanged. Required scope: The required scope(s) will depend on the event type(s) you are subscribing too. See the WEBHOOK EVENT TYPES section. Served by the Mockzilla mock runtime.

Process an event through a data feed. The request body will be different depending on your data feed setup. Accepts either a single event or a list of events. Required scope: write_data_feed_event.

Send third party integration payloads to Podium. Required scope: write_contacts.