---
title: "Queue Company Invitation"
method: POST
path: "/merchant/invitation"
tags: ["Legacy", "Company Review Invitations"]
deprecated: true
---

# Queue Company Invitation

`POST /merchant/invitation`

> **Deprecated.**

## Query parameters

- `store` string, required
- `apikey` string, required

## Request body

- CompanyInvitation — Company Review Invitation
  - `name` string — Customer Name
  - `email` string — Customer Email Address
  - `order_id` string — Customer Order Reference
  - `template_id` string — Invitation email template id

## Response `200`

OK

- object
  - `success` string — If the request succeeded
  - `id` integer — The ID of the Invitation (if queued)
  - `invitation` InvitationResponse — Review Invitation
    - `id` string — Invitation ID
    - `name` string — Customer Name
    - `email` string — Customer Email Address
    - `order_id` string — Customer Order Reference
    - `date_send` string — Date that the Invitation will be sent to the customer
    - `email_sent` string — Has the Invitation been sent.
    - `status` string — Is the Invitation active. An inactive status means the Invitation has been paused and wont be sent.
    - `template` object — Invitation Email Template
      - `id` string — ID of the email template
      - `name` string — name of the email template
  - `message` string — Plaintext information on whether an Invitation was queued or not.

---

[API](https://skmtc.net/reviews/apis/reviews-io-api.md) · [All operations](https://skmtc.net/reviews/apis/reviews-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/reviews/reviews-io-api/versions/ea87e0d855cc/schema)