--- title: "Schedule new invites" method: POST path: "/invites" tags: ["invites"] --- # Schedule new invites `POST /invites` This endpoint allows clients to schedule new review invites in eTrusted. ## Request body - InvitesRequest — The request, that contains all the needed information to schedule new invites. - `channel` object, required — The channel which will be associated with the invites. - `id` string, required — The unique identifier of the channel. - `type` 'user_defined' | 'etrusted' — The type of the id used to refer to the channel. - `system` string, required — Name of the customer's system - `systemVersion` string, required — Version of the customer's system - `invites` Invite[], required — The invites to be scheduled. - `questionnaireTemplate` object, required — The questionnaire template which will be used to render the actual questionnaire for this invite. - `id` string, required — The eTrusted unique identifier of the questionnaire template. - `template` object, required — The invite template which will be used for sending the invite. - `id` string, required — The eTrusted unique identifier of the invite template. - `customer` object, required — The customer invited to leave a review. - `firstName` string — The customer's first name. - `lastName` string — The customer's last name. - `email` string, required — The customer's email address. - `locale` string — The locale in which the customer will get the invite and questionnaire. - `transaction` object, required — The transaction to be reviewed. - `reference` string, required — An external reference to the transaction. - `date` string, date-time — The date when the transaction occurred, given in the ISO8601 & RFC3339 valid format yyyy-MM-dd'T'HH:mm:ss.SSSZ. - `products` object[] — This is a list of products. It contains the products that are associated with the event. It includes all data needed for product reviews for these products. - `gtin` string — The GTIN identifies the product globally. A GTIN can be an ISBN, an EAN, and much more. Refer to [gtin.info](https://www.gtin.info/) - `imageUrl` string — A link to a product image. *eTrusted* can display an image of the product to the customer who is writing a review. This makes it easier for customers to remember and recognize the product. - `name` string, required — The product name contains information about a product that is associated with the event (e.g. `Specialbrand T-Shirt White M`). - `mpn` string — The Manufacturer Part Number is an identifier for a product by the manufacturer if applicable. In some cases it can serve as a substitute for the GTIN. - `sku` string, required — The Stock Keeping Unit is a specific article number of the product, most often assigned by a specific retail shop as a scannable bar code. It lets the shops track movement of inventory. The SKU must be unique and usually consists of about 8 characters (e.g. `1234-TS-WH-M`). - `brand` string — The brand of the product (e.g. `specialbrand`). A product can only have one brand. - `url` string, required — A link to the product detail page in your online shop or public catalog (e.g. `http://www.specialbrandshop.com/article123-TS-WH-M/`). - `preferredSendTime` string, date-time — The date and time when the invite should be sent. It is in the ISO 8601 & RFC3339 valid format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. If it is not set or the date is in the past, the invite will be scheduled immediately. - `metadata` object — Key-value pairs of metadata associated with the invite. ## Response `207` Multi-Status - InvitesResponse — The response, if something went wrong. - `batchId` string — The eTrusted unique identifier of the request with invites. It will be returned only if some invites were successfully scheduled (successfulInvites>0). - `successfulInvites` integer, required — The number of successfully scheduled invites. - `failedInvites` FailedInvite[] — The invites that were not scheduled. - `initialInvite` Invite, required — The invite to be scheduled for later sendout. - `questionnaireTemplate` object, required — The questionnaire template which will be used to render the actual questionnaire for this invite. - `id` string, required — The eTrusted unique identifier of the questionnaire template. - `template` object, required — The invite template which will be used for sending the invite. - `id` string, required — The eTrusted unique identifier of the invite template. - `customer` object, required — The customer invited to leave a review. - `firstName` string — The customer's first name. - `lastName` string — The customer's last name. - `email` string, required — The customer's email address. - `locale` string — The locale in which the customer will get the invite and questionnaire. - `transaction` object, required — The transaction to be reviewed. - `reference` string, required — An external reference to the transaction. - `date` string, date-time — The date when the transaction occurred, given in the ISO8601 & RFC3339 valid format yyyy-MM-dd'T'HH:mm:ss.SSSZ. - `products` object[] — This is a list of products. It contains the products that are associated with the event. It includes all data needed for product reviews for these products. - `gtin` string — The GTIN identifies the product globally. A GTIN can be an ISBN, an EAN, and much more. Refer to [gtin.info](https://www.gtin.info/) - `imageUrl` string — A link to a product image. *eTrusted* can display an image of the product to the customer who is writing a review. This makes it easier for customers to remember and recognize the product. - `name` string, required — The product name contains information about a product that is associated with the event (e.g. `Specialbrand T-Shirt White M`). - `mpn` string — The Manufacturer Part Number is an identifier for a product by the manufacturer if applicable. In some cases it can serve as a substitute for the GTIN. - `sku` string, required — The Stock Keeping Unit is a specific article number of the product, most often assigned by a specific retail shop as a scannable bar code. It lets the shops track movement of inventory. The SKU must be unique and usually consists of about 8 characters (e.g. `1234-TS-WH-M`). - `brand` string — The brand of the product (e.g. `specialbrand`). A product can only have one brand. - `url` string, required — A link to the product detail page in your online shop or public catalog (e.g. `http://www.specialbrandshop.com/article123-TS-WH-M/`). - `preferredSendTime` string, date-time — The date and time when the invite should be sent. It is in the ISO 8601 & RFC3339 valid format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. If it is not set or the date is in the past, the invite will be scheduled immediately. - `metadata` object — Key-value pairs of metadata associated with the invite. - `status` integer, required — The HTTP status code of the error. - `reasons` string[], required — The reasons, why the invite was not scheduled. ## Other responses - `400` — Bad Request - `401` — Unauthorized --- [API](https://skmtc.net/etrusted/apis/accounts-api.md) · [All operations](https://skmtc.net/etrusted/apis/accounts-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/etrusted/accounts-api/revisions/649ef7dac98c/schema)