/

Update Status Queue

Update Status Queue

Owned by Tony Erskine

Last updated: Nov 30, 2023

1 min read

Requires ADMIN privileges.

URI: https://api.cloudcard.us/status-queue/{id}

HTTP Method: PUT

Required Headers:

X-Auth-Token (see: Authentication)
Accept: application/json

Request Body: (omitted fields will not be changed)

organization: id of organization (see example)
messageType: FULL or ID
name: name of status queue; max size 32 characters
photoStatus: the photo status that will trigger messages to be sent to the queue
PENDING, APPROVED, DENIED, DISCARDED, READY_FOR_DOWNLOAD, DOWNLOADED, DONE, ENROUTE, ON_HOLD

Example HTTP Request 1 (Omitted fields are unchanged)

    {
        "name": "random name 1234"
    }

Example Response 2

201 CREATED
{
    "id": 10,
    "dateCreated": "2023-06-06T15:14:48Z",
    "lastUpdated": "2023-06-06T15:14:48Z",
    "organization": {
        "id": 2
    },
    "messageType": "FULL",
    "photoStatus": "DOWNLOADED",
    "name": "random name 1234"
}

Example HTTP Request 2

    {
        "messageType": "FULL",
        "name": "random name 123",
        "photoStatus": "DOWNLOADED"
    }

Example Response 2

Related content

Create Status Queue

Create Status Queue

More like this

Photo Status Queues (via AWS SQS or SNS)

Photo Status Queues (via AWS SQS or SNS)

More like this

List Status Queues

List Status Queues

More like this

Get Photo List

More like this

Update Photo

More like this

Use Case: Upload a Photo for a Cardholder

Use Case: Upload a Photo for a Cardholder

More like this