API voor Developers: Invitations

Let op: call alleen beschikbaar wanneer merchant én product reviews worden verzameld

Feedback Company avatar
Geschreven door Feedback Company
Meer dan een week geleden bijgewerkt

Lijst

Retourneert een lijst met uitnodigingen.

Request

Headers

De "Authorization" header voor deze API methode bevat een <access_token> plaatshouder. Vervang deze met de waarde van de echte access token.

Name

Value

Authorization

Bearer <access_token>

URL

Parameters

Name

Allowed values

Required

page

(An integer greater than 0, default: 1)

No

page_size

(An integer between 1 and 1000, default: 25)

No

sort

(A valid sort value, see table below, default: "-created_at")

No

Toegestane waarden

Value

Description

created_at

Sorts on created datetime, ascending.

-created_at

Sorts on created datetime, descending.

Response

Headers

Name

Value

Status code

200

Status message

OK

Voorbeeld

{
"meta": {
"count": 22
},
"success": true,
"invitations": [
{
"is_sent": true,
"order_id": 1234,
"send_at": "2018-04-01T00:00:00Z",
"send_reminder_at": "2018-04-08T00:00:00Z",
"created_at": "2018-04-01T00:00:00Z",
"id": 5678,
"is_reminder_sent": true
}
]
}

Get

Returns an invitation.

Request

Headers

The "Authorization" header for this API method contains an <access_token> placeholder. Replace it with the value of an actual access token.

Name

Value

Authorization

Bearer <access_token>

URL

The endpoint for this API method contains an <id> placeholder. Replace it with the value of an actual invitation id.

Response

Headers

Name

Value

Status code

200

Status message

OK

Voorbeeld

{
"success": true,
"invitation": {
"is_sent": true,
"order_id": 1234,
"send_at": "2018-04-01T00:00:00Z",
"send_reminder_at": "2018-04-08T00:00:00Z",
"created_at": "2018-04-01T00:00:00Z",
"id": 5678,
"is_reminder_sent": true
}
}

Was dit een antwoord op uw vraag?