# Podium

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

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/podium

## Actions

### Create appointment

Create an appointment.

**Inputs**

- Assigned user uid (`assigned_user_uid`, text): Podium unique identifier for user.
- Contact name (`contact_name`, text, required): Name of the contact.
- Contact phone number (`contact_phone_number`, text, required): Phone number of the contact. Phone number should be formatted as '+15555555555'
- Datetime (`datetime`, date and time, required): Date and time of the appointment.
- Duration min (`duration_min`, number): How many minutes long the appointment is.
- Location uid (`location_uid`, text, required): Podium unique identifier for location.
- Note (`note`, text): Note that is attached to the appointment.
- Status (`status`, text): Status of the appointment. One of: `cancelled`, `completed`, `confirmed`, `no_show` (No show), `unconfirmed`. Default: `unconfirmed`.
- Type (`type`, text): Type of appointment. One of: `in_person` (In person), `virtual`. Default: `in_person`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`address`, object): The address of the resource
- Attributes (`attributes`, list): List of attribute objects
- Contact status (`contact_status`, object): A contact status, you need either the name or uid
- Email (`email`, text): The email address of the resource
- Locations (`locations`, list, required): List of location UIDs
- Name (`name`, text, required): The name of the resource
- Phone number (`phone_number`, text): The phone number of the resource
- Tags (`tags`, list): List of tag UIDs

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`email`, text): The customer email. Required if phoneNumber not present
- Location uid (`location_uid`, text, required): Podium location identifier that review invite link will be created for
- Phone number (`phone_number`, text): The customer phone number.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`identifier`, text, required): Conversation uid, phone number, or email to identify the contact. Phone number should be formatted as '+15555555555'

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": {
      "identifier": "example"
    },
    "metadata": {
      "url": "example"
    }
  }
}
```

### Get appointment

Get one appointment by its ID.

**Inputs**

- Uid (`uid`, text, required): Podium unique identifier for appointment.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`identifier`, text, required): Conversation uid, phone number, or email to identify the contact. Phone number should be formatted as '+15555555555'

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`uid`, text, required): Podium unique identifier for conversation.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`uid`, text, required): Podium unique identifier for invoice.
- Location uid (`location_uid`, text, required): Podium unique identifier for location.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`uid`, text, required): Podium unique identifier for location.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`uid`, text, required): Podium unique identifier for message.
- Conversation uid (`conversation_uid`, text, required): Podium unique identifier for conversation.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`uid`, text, required): Podium unique identifier for review.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`uid`, text, required): Podium unique identifier for user.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`cursor`, text): Cursor used to access next or previous page in pagination.
- Limit (`limit`, number): Max number of items to return per request. Defaults to 10. From 0 to 100. Default: `10`.
- Location uid (`location_uid`, text): Podium unique identifier for location.
- Order (`order`, text): 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 (`since`, date and time): Date time in Coordinated Universal Time (UTC).

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "nextCursor": "example",
      "url": "example"
    }
  }
}
```

### List contacts

List all contacts.

**Inputs**

- Cursor (`cursor`, text): Cursor used to access next or previous page in pagination.
- Limit (`limit`, number): Max number of items to return per request. Defaults to 10. From 1 to 100. Default: `10`.
- Updated at (`updated_at`, text): Filter contacts by updated_at. It will retrieve contacts updated after the provided date. Format: YYYY-MM-DDTHH:MM:SSZ

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`cursor`, text): Cursor used to access next or previous page in pagination.
- Limit (`limit`, number): Max number of items to return per request. Defaults to 10. From 0 to 100. Default: `10`.
- Location uid (`location_uid`, text): Podium unique identifier for location.
- Order (`order`, text): 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 i. One of: `asc`, `desc`.
- Since (`since`, date and time): Date time in Coordinated Universal Time (UTC).

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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_uid`, text): Podium unique identifier for location.
- Date paid (`date_paid`, date and time): Date time in Coordinated Universal Time (UTC).
- Date refunded (`date_refunded`, date and time): Date time in Coordinated Universal Time (UTC).
- Date created (`date_created`, date and time): Date time in Coordinated Universal Time (UTC).
- Limit (`limit`, number): Max number of items to return per request. Defaults to 10. From 0 to 100. Default: `10`.
- Cursor (`cursor`, text): Cursor used to access next or previous page in pagination.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`search`, text): String you would like to search for in the searchFields parameter.
- Search fields (`search_fields`, list): A list of the fields where you want to search for the search parameters. e.g. ?searchFields[]=name&searchFields[]=displayname. One or more of: `address`, `displayName`, `name`, `podiumPhoneNumber`. Default: `["name"]`.
- Limit (`limit`, number): Max number of items to return per request. Defaults to 10. From 0 to 100. Default: `10`.
- Created after (`created_after`, date and time): Date time in Coordinated Universal Time (UTC).
- Created before (`created_before`, date and time): Date time in Coordinated Universal Time (UTC).
- Updated after (`updated_after`, date and time): Date time in Coordinated Universal Time (UTC).
- Cursor (`cursor`, text): Cursor used to access next or previous page in pagination.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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_uid`, text, required): Podium unique identifier for conversation.
- Cursor (`cursor`, text): Cursor used to access next or previous page in pagination.
- Order (`order`, text): 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 (`since`, date and time): Date time in Coordinated Universal Time (UTC).

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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_uid`, text): Podium unique identifier for location.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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_at`, object): Filter on the createdAt date.
- Cursor (`cursor`, text): Cursor used to access next or previous page in pagination.
- Limit (`limit`, number): Max number of items to return per request. Defaults to 10. From 0 to 100. Default: `10`.
- Updated at (`updated_at`, object): Filter on the updatedAt date.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": [],
    "metadata": {
      "nextCursor": "example",
      "previousCursor": "example",
      "totalItems": 1,
      "url": "example"
    }
  }
}
```

### List templates

List all message templates.

**Inputs**

- Types (`types`, list): 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_uid`, text): Podium unique identifier for location.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`search`, text): String you would like to search for in the searchFields parameter.
- Created at (`created_at`, object): Filter on the createdAt date.
- Search fields (`search_fields`, list): A list of the fields where you want to search for the search parameters. e.g. ?searchFields[]=name&searchFields[]=displayname. One or more of: `address`, `phone`, `fullName`. Default: `["fullName"]`.
- Limit (`limit`, number): Max number of items to return per request. Defaults to 10. From 0 to 100. Default: `10`.
- Cursor (`cursor`, text): Cursor used to access next or previous page in pagination.
- Include agents (`include_agents`, true/false): Include users with ai_agent role. Defaults to true if not specified. Default: `true`.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`body`, text, required): Text of the message.
- Contact name (`contact_name`, text): 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_uid`, text, required): Podium unique identifier for location.
- Sender name (`sender_name`, text): 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_inbox`, true/false): new conversations will be created in a 'closed' state by default. This will override that setting going to 'open' inbox. Default: `false`.
- Subject (`subject`, text): Subject of the message.
- Channel type (`channel_type`, text, required): Channel type. One of: `email`, `phone`.
- Recipient (`recipient`, text, required): Destination email or phone number, including the country code.

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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 (`identifier`, text, required): Conversation uid, phone number, or email to identify the contact. Phone number should be formatted as '+15555555555'
- Address (`address`, object): The address of the resource
- Contact status (`contact_status`, object): A contact status, you need either the name or uid
- Conversation uid (`conversation_uid`, text): Podium unique identifier for conversation.
- Email (`email`, text): The email address of the resource
- Locations (`locations`, list): List of location UIDs
- Name (`name`, text): The name of the resource
- Phone number (`phone_number`, text): The phone number of the resource

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "data": {
    "data": {
      "identifier": "example"
    },
    "metadata": {
      "url": "example"
    }
  }
}
```

### Update conversation

Update a conversation.

**Inputs**

- Uid (`uid`, text, required): Podium unique identifier for conversation.
- Assigned by name (`assigned_by_name`, text): The name used in conversation assignment managerial items
- Assigned user uid (`assigned_user_uid`, text): Podium unique identifier for user.
- Closed (`closed`, true/false): Whether the conversation is open or closed.
- Conversation assignee uids (`conversation_assignee_uids`, list): List of assignee user UIDs

**Outputs**

- `data` (object): Response.

**Example output**

```json
{
  "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"
    }
  }
}
```
