components: responses: {} schemas: Error: properties: code: description: Podium code for the error. type: integer message: description: Specific details about the error. nullable: true type: string moreInfo: description: URL providing more information about the error. type: string title: Error type: object conversation: description: Messenger conversation. properties: assignedUserUid: description: Podium unique identifier for user. example: 00000000-0000-0000-0000-000000000000 format: uuid nullable: true type: string assigneeUids: description: List of assignee user UIDs items: description: Podium unique identifier for assignee user. example: 00000000-0000-0000-0000-000000000000 format: uuid type: string type: array channel: description: Channel that the conversation is in. properties: identifier: description: Identifies the Messenger channel. Must be a valid email address or a phone number. Non-US/Canada numbers must include the country code (e.g. +61 for AUS) example: email@email.com nullable: true type: string type: description: Messenger channel for the conversation. enum: - apple - car_wars - email - facebook - fallback_email - google - google_brand - iframe - instagram - phone - secure - sms - text - whatsapp example: email nullable: true type: string type: object closed: description: Whether the conversation has been closed nullable: true type: boolean contactName: description: Name of the contact. nullable: true type: string createdAt: description: When the conversation was started. example: '2015-01-23T23:50:07Z' format: date-time nullable: true type: string lastItemAt: description: When the last conversation item was added. example: '2015-01-23T23:50:07Z' format: date-time nullable: true type: string locationUid: description: Podium unique identifier for location. example: 00000000-0000-0000-0000-000000000000 format: uuid nullable: true type: string uid: description: Podium unique identifier for conversation. example: 00000000-0000-0000-0000-000000000000 format: uuid nullable: true type: string updatedAt: description: When the conversation was last updated. example: '2015-01-23T23:50:07Z' format: date-time nullable: true type: string title: conversation type: object conversation_assignee: description: Messenger conversation assignees. properties: assignedUserUid: description: Podium unique identifier for user. example: 00000000-0000-0000-0000-000000000000 format: uuid nullable: true type: string assigneeType: description: Type of assignee enum: - user nullable: true type: string assigneeUid: description: Podium unique identifier for user. example: 00000000-0000-0000-0000-000000000000 format: uuid nullable: true type: string assignees: description: List of conversation assignees items: properties: uid: description: Podium unique identifier for assignee user. example: 00000000-0000-0000-0000-000000000000 format: uuid type: string type: object nullable: true type: array title: conversation_assignee type: object conversation_note: description: Conversation note. properties: body: description: Body of the note. nullable: false type: string conversation: description: Conversation that the conversation note belongs to. properties: uid: description: Podium unique identifier for conversation. example: 00000000-0000-0000-0000-000000000000 format: uuid nullable: true type: string type: object createdAt: description: Time at which the resource was created. Date time is in Coordinated Universal Time (UTC). example: '2015-01-23T23:50:07Z' format: date-time nullable: true type: string location: description: Location that the conversation note belongs to. properties: uid: description: Podium unique identifier for location. example: 00000000-0000-0000-0000-000000000000 format: uuid nullable: true type: string type: object organization: description: Organization that the conversation note belongs to. properties: uid: description: Podium unique identifier for organization. example: 00000000-0000-0000-0000-000000000000 format: uuid nullable: true type: string type: object senderName: description: Name of the person who created the note. nullable: false type: string uid: description: Podium unique identifier for note. example: 00000000-0000-0000-0000-000000000000 format: uuid nullable: true type: string updatedAt: description: Time at which the resource was updated. Date time is in Coordinated Universal Time (UTC). example: '2015-01-23T23:50:07Z' format: date-time nullable: true type: string title: conversation_note type: object lead_writeback: description: 'A lead that has been writtenback to a connected CRM. The lead is passed to the CRM and no other action is possible from the Podium so is no `uid` or other identifers assigned to the lead. ' properties: conversation: description: Conversation that the conversation note belongs to. properties: uid: description: Podium unique identifier for conversation. example: 00000000-0000-0000-0000-000000000000 format: uuid nullable: true type: string type: object title: lead_writeback type: object info: title: Conversations version: 2021.04.01 openapi: 3.0.0 paths: /v4/conversations: get: callbacks: {} description: "List all conversations. \n\nIf 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.\n\nRequired scope: `read_messages`." operationId: conversation.index parameters: - description: Retrieves the page of items that comes after the `cursor`. in: query name: cursor required: false schema: description: Cursor used to access next or previous page in pagination. example: MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw type: string - description: Max number of items to return per request. Defaults to `10`. in: query name: limit required: false schema: default: 10 example: 10 maximum: 100 minimum: 0 type: integer - description: Podium unique identifier for location. in: query name: locationUid required: false schema: example: 00000000-0000-0000-0000-000000000000 format: uuid type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/conversation' metadata: description: Additional response data. properties: url: description: The resource URL. example: https://www.podium.com/ type: string type: object type: object description: Successful response. default: content: application/json: schema: properties: code: description: Podium code for the error. type: integer message: description: Specific details about the error. nullable: true type: string moreInfo: description: URL providing more information about the error. type: string title: Error type: object description: Error response. summary: List conversations. tags: - Conversation /v4/conversations/{uid}: get: callbacks: {} description: 'Gets a conversation that has previously been created. Required scope: `read_messages`.' operationId: conversation.get parameters: - description: Podium unique identifier for conversation. in: path name: uid required: true schema: example: 00000000-0000-0000-0000-000000000000 format: uuid type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/conversation' metadata: description: Additional response data. properties: url: description: The resource URL. example: https://www.podium.com/ type: string type: object type: object description: Successful response. default: content: application/json: schema: properties: code: description: Podium code for the error. type: integer message: description: Specific details about the error. nullable: true type: string moreInfo: description: URL providing more information about the error. type: string title: Error type: object description: Error response. summary: Get a conversation. tags: - Conversation put: callbacks: {} description: 'Update a conversation. Required scope: `write_messages`.' operationId: conversation.update parameters: - description: Podium unique identifier for conversation. in: path name: uid required: true schema: example: 00000000-0000-0000-0000-000000000000 format: uuid type: string requestBody: content: application/json: schema: properties: assignedByName: description: The name used in conversation assignment managerial items nullable: true type: string assignedUserUid: description: Podium unique identifier for user. example: 00000000-0000-0000-0000-000000000000 format: uuid nullable: true type: string closed: description: Whether the conversation is open or closed. example: false type: boolean conversationAssigneeUids: description: List of assignee user UIDs items: description: Podium unique identifier for assignee user. example: 00000000-0000-0000-0000-000000000000 format: uuid type: string nullable: true type: array type: object description: Update conversation params required: false responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/conversation' metadata: description: Additional response data. properties: url: description: The resource URL. example: https://www.podium.com/ type: string type: object type: object description: Successful response. default: content: application/json: schema: properties: code: description: Podium code for the error. type: integer message: description: Specific details about the error. nullable: true type: string moreInfo: description: URL providing more information about the error. type: string title: Error type: object description: Error response. summary: Update a conversation. tags: - Conversation /v4/conversations/{uid}/assignees: get: callbacks: {} description: 'Get conversation assignees. Required scope: `read_messages`.' operationId: conversation_assignee.get parameters: - description: Podium unique identifier for conversation. in: path name: uid required: true schema: example: 00000000-0000-0000-0000-000000000000 format: uuid type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/conversation_assignee' metadata: description: Additional response data. properties: url: description: The resource URL. example: https://www.podium.com/ type: string type: object type: object description: Successful response. default: content: application/json: schema: properties: code: description: Podium code for the error. type: integer message: description: Specific details about the error. nullable: true type: string moreInfo: description: URL providing more information about the error. type: string title: Error type: object description: Error response. summary: Get conversation assignees. tags: - Conversation Assignee put: callbacks: {} description: 'Update a conversation assignee. Required scope: `write_messages`.' operationId: conversation_assignee.update parameters: - description: Podium unique identifier for conversation. in: path name: uid required: true schema: example: 00000000-0000-0000-0000-000000000000 format: uuid type: string requestBody: content: application/json: schema: description: Messenger conversation assignee. properties: assigneeUids: description: List of assignee user UIDs items: description: Podium unique identifier for assignee user. example: 00000000-0000-0000-0000-000000000000 format: uuid type: string type: array keepAiAssignment: description: Keep AI assignment - defaults to false nullable: true type: boolean name: description: User assigning the conversation (to be shown in the notification) nullable: true type: string type: object description: Update conversation assignee params required: false responses: '200': content: application/json: schema: properties: data: items: $ref: '#/components/schemas/conversation_assignee' type: array metadata: description: Additional response data. properties: url: description: The resource URL. example: https://www.podium.com/ type: string type: object type: object description: Successful response. default: content: application/json: schema: properties: code: description: Podium code for the error. type: integer message: description: Specific details about the error. nullable: true type: string moreInfo: description: URL providing more information about the error. type: string title: Error type: object description: Error response. summary: Update a conversation assignee. tags: - Conversation Assignee /v4/conversations/{uid}/lead_writeback: post: callbacks: {} description: 'Writeback lead to the connected CRM. Required scope: `write_writebacks`.' operationId: lead_writeback.get parameters: - description: Conversation uid of the lead. in: path name: uid required: true schema: example: 00000000-0000-0000-0000-000000000000 format: uuid type: string responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/lead_writeback' metadata: description: Additional response data. properties: url: description: The resource URL. example: https://www.podium.com/ type: string type: object type: object description: Successful response. default: content: application/json: schema: properties: code: description: Podium code for the error. type: integer message: description: Specific details about the error. nullable: true type: string moreInfo: description: URL providing more information about the error. type: string title: Error type: object description: Error response. summary: Writeback lead tags: - Conversation /v4/conversations/{uid}/notes: post: callbacks: {} description: 'Creates a note for the given conversation. Required scope: `write_messages`.' operationId: conversation_note.create_conversation_note parameters: - description: Podium unique identifier for conversation. in: path name: uid required: true schema: example: 00000000-0000-0000-0000-000000000000 format: uuid type: string requestBody: content: application/json: schema: properties: body: description: Body of the note. example: This is a note nullable: false type: string senderName: description: Name of the person who created the note. example: John Doe nullable: false type: string required: - body - senderName type: object description: Create conversation note body params required: true responses: '200': content: application/json: schema: properties: data: $ref: '#/components/schemas/conversation_note' metadata: description: Additional response data. properties: url: description: The resource URL. example: https://www.podium.com/ type: string type: object type: object description: Successful response. default: content: application/json: schema: properties: code: description: Podium code for the error. type: integer message: description: Specific details about the error. nullable: true type: string moreInfo: description: URL providing more information about the error. type: string title: Error type: object description: Error response. summary: Create a note for given conversation. tags: - Conversation security: [] servers: - url: https://api.podium.com variables: {} tags: []