The status of a review invitation

This endpoint allows to get the status about an invitation sent through the Review Booster. Your access token must be for a user subscribed to the Review Booster. The invitation id must be for a business for which the user has access to.

get/review_booster/invitation_status

Request

Base URL
https://api.partoo.co/v2
Auth
API key in header x-APIKey
TypeScript
https://skmtc.dev/partoo/apis/partoo-rest-api/docs/review_booster/invitation_status/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

invitation_idstring

invitation id

Example:d3d8c966-0356-4ec0-baae-13ec3622ebc2

Response

invitation_idstring

invitation id

status'CREATED' | 'SENT' | 'FAILED_SEND' | 'DELIVERED' | 'FAILED_DELIVERY'

the current state of the SMS

Example response

{
  "invitation_id": "d3d8c966-0356-4ec0-baae-13ec3622ebc2"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.