Place a review card

PATCH

/api/v1/cards/{id}

curl --request PATCH \
  --url https://digize.com/api/v1/cards/example \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: 5f1c2a8e-3b7d-4c55-9a0e-1f2d3c4b5a69' \
  --header 'x-api-key: <x-api-key>' \
  --data '{ "label": "example", "assigneeId": "example" }'

• Digize

Says where a card is and which team member hands it out, so its taps can be told apart.

Needs the reviews:write permission.

Authorizations

• apiKey
• bearer

Parameters

Path Parameters

id

required

string

>= 1 characters <= 64 characters

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

label

required

string

<= 60 characters

assigneeId

required

Any of:

string

string

<= 64 characters

null

null

Example ^generated

{
  "label": "example",
  "assigneeId": "example"
}

Responses

200

Done

Media typeapplication/json

object

id

required

string

code

required

string

label

required

string

assignee

required

Any of:

object

object

id

required

string

name

required

string

null

null

design

required

string

Allowed values: printed plain

format

required

string

Allowed values: card stand sticker

status

required

string

Allowed values: shipping active disabled

orderId

required

string

hostname

required

string

deliveredAt

required

Any of:

string

string format: date-time

null

null

disabledAt

required

Any of:

string

string format: date-time

null

null

taps

required

Over the last 90 days, like the rest.

number

lastTapAt

required

Any of:

string

string format: date-time

null

null

ratings

required

number

sentToGoogle

required

number

feedback

required

number

average

required

number | null

Example

{
  "design": "printed",
  "format": "card",
  "status": "shipping"
}

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"
  }
}