Create a review

POST

https://v1.api.partnerpage.io/api/directory/private/v1alpha/reviews/directory/:directoryId/

POST

/api/directory/private/v1alpha/reviews/directory/:directoryId/

curl -X POST https://v1.api.partnerpage.io/api/directory/private/v1alpha/reviews/directory/directoryId/ \
     -H "Authorization: Token  <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "entryId": "string",
  "title": "string",
  "company": "string",
  "summary": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "rating": 1
}'

{
  "id": "string",
  "entry": {
    "id": "string",
    "owner": "string",
    "title": "string"
  },
  "entryType": "string",
  "title": "string",
  "company": "string",
  "summary": "string",
  "shortSummary": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "rating": 1,
  "created": "2024-01-15T09:30:00Z",
  "status": "string",
  "statusDisplay": "string",
  "approvedBy": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string"
  },
  "declinedBy": {
    "id": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string"
  },
  "partnerReply": {
    "id": "string",
    "contents": "string",
    "created": "2024-01-15T09:30:00Z",
    "modified": "2024-01-15T09:30:00Z"
  }
}

Create a review for an entry in this directory (directory owner only).

Authentication

AuthorizationToken

Your API key, sent as Authorization: Token <your API key>

Path parameters

directoryIdstringRequiredformat: "uuid"

Request

This endpoint expects an object.

entryIdstringRequiredformat: "uuid"

titlestringRequired1-80 characters

companystringRequired<=60 characters

summarystringRequired1-1000 characters

firstNamestringRequired1-30 characters

lastNamestringRequired1-30 characters

emailstringRequiredformat: "email"1-80 characters

ratingintegerRequired1-5

createddatetime or nullOptional

Response

Review created successfully

idstringformat: "uuid"

entryobject

entryTypestring

titlestring

companystring or null

summarystring

shortSummarystring

firstNamestring

lastNamestring

emailstring or nullformat: "email"

ratinginteger

createddatetime

statusstring

statusDisplaystring

approvedByobject or null

declinedByobject or null

partnerReplyobject or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error