Ask customers for a review

POST

/api/v1/reviews/requests

curl --request POST \
  --url https://digize.com/api/v1/reviews/requests \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "contactIds": [ "example" ], "channel": "email" }'

• Digize

Sends review requests now to these contacts, by email or text, about their latest order. One already waiting to go out to them goes now instead.

Needs the reviews:write permission. It can’t be undone.

Authorizations

• apiKey
• bearer

Parameters

Header Parameters

Idempotency-Key

string

>= 1 characters <= 255 characters

Makes the request safe to send again: for 24 hours the same key and request answer the first response without repeating the change.

Example

5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69

Request Body^required

Media typeapplication/json

object

contactIds

required

Array<string>

>= 1 items <= 100 items

channel

required

string

Allowed values: email sms

Responses

201

Done

Media typeapplication/json

object

rows

required

Array<object>

object

id

required

string

number

required

number

contact

required

object

id

required

string

name

required

string

email

required

string

phone

required

string

channel

required

string

Allowed values: email sms

reason

required

string

Allowed values: order class manual

about

required

Order #1042, or the class’s name.

string

subject

required

string

destination

required

string

Allowed values: google site

status

required

string

Allowed values: scheduled sent opened clicked reviewed bounced cancelled

scheduledFor

required

string format: date-time

sentAt

required

Any of:

string

string format: date-time

null

null

openedAt

required

Any of:

string

string format: date-time

null

null

clickedAt

required

Any of:

string

string format: date-time

null

null

reviewedAt

required

Any of:

string

string format: date-time

null

null

review

required

Any of:

object

object

id

required

string

rating

required

number

body

required

string

null

null

message

required

string | null

error

required

Why it didn’t go out.

string | null

total

required

number

Example

{
  "rows": [
    {
      "channel": "email",
      "reason": "order",
      "destination": "google",
      "status": "scheduled"
    }
  ]
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

409

A request with the same Idempotency-Key is still running (conflict).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

422

The Idempotency-Key was used with a different request.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}