Vouch has exposed specific resources via a REST API to perform certain functions of the platform externally. These endpoints are available to customers who are on the Enterprise tier.
The following guide outlines the various REST API endpoints available around the Vouch Request feature within the Platform.
Create a Vouch
Create a new Vouch Request within your entity.
Notes
A Vouch Request must have at least one question in order for the API request to be sucessful.
If account is not supplied / email is not recognised, the Vouch will be associated with the Account Owner
The Vouch will be created in a PUBLISHED status, with the generated URL accessible immediately after.
Endpoint
POST https://api.vouchfor.com/api/v1/vouches
Response
{
"vouch" : {
"note" : {
"text": "thanks for Vouching for us!"
},
"questions" : [
{
"text": "this is question 1",
"type": "VIDEO",
"optional": false,
"maxduration": 0
}, {
"text": "this is question 2",
"type": "VIDEO",
"optional": false,
"maxduration": 0
}
]
},
"account" : {
"email" : "[email protected]"
},
"customer" : {
"name" : "Responder Org",
"url" : "https://responderorg.com"
},
"contact" : {
"name" : "Responder",
"email" : "[email protected]"
}
}
Retrieve a Vouch
Retrieve a specific Vouch from within your Vouch entity.
Notes
The
status
of the Vouch will determine whether the providedurl
is the Request URL or the Play Link URL.If the Vouch request was created by a Campaign, the
Campaign ID
andCampaign Name
will be provided within the response.If a
Custom ID
has been attached to the Vouch, you can retrieve the Vouch using that ID instead of the Vouch issued ID.
Endpoint
GET https://api.vouchfor.com/api/v1/vouches/:id
Response
{
"vouch" : {
"id" : "vvvvvvvvvv",
"status" : "DRAFT | SENT | PUBLISHED | VIEWED | SUBMITTED",
"url" : "https://app.vouchfor.com/request/vvvvvvvvvv",
"note" : {
"text": "thanks for Vouching for us!"
},
"questions" : [
{
"text": "this is question 1",
"type": "VIDEO",
"optional": false,
"maxduration": 0
}, {
"text": "this is question 2",
"type": "VIDEO",
"optional": false,
"maxduration": 0
}
]
},
"entity" : {
"id" : "eeeeeeeeee",
"name" : "Request Org",
"url" : "https://requestor.com"
},
"account" : {
"name" : "Requestor",
"email" : "[email protected]"
},
"customer" : {
"name" : "Responder Org",
"url" : "https://responderorg.com"
},
"contact" : {
"name" : "Responder",
"email" : "[email protected]"
}
}
Retrieve Metrics for a Vouch
Retrieve metrics relating to a specific Vouch
Endpoint
GET https://api.vouchfor.com/api/v1/vouches/:id/counts
Response
{
"counts": {
"plays": 84
}
}
Delete a Vouch
Remove a specific Vouch.
Endpoint
POST https://api.vouchfor.com/api/v1/vouches/:id/delete
Retrieve a list of Vouches
Retrieve a list of all Vouch Requests from within your Vouch entity.
Notes
The
status
of the Vouch will determine whether the providedurl
is the Request URL or the Play Link URL. Draft Requests will not have a URL.
Endpoint
GET https://api.vouchfor.com/api/v1/vouches
Response
{
"vouches" : [
{
"id" : "vvvvvvvvv1",
"status" : "DRAFT"
}, {
"id" : "vvvvvvvvv2",
"status" : "SENT",
"url" : "https://app.vouchfor.com/request/vvvvvvvvv2"
}, {
"id" : "vvvvvvvvv3",
"status" : "PUBLISHED",
"url" : "https://app.vouchfor.com/request/vvvvvvvvv3"
}, {
"id" : "vvvvvvvvv4",
"status" : "VIEWED",
"url" : "https://app.vouchfor.com/request/vvvvvvvvv4"
}, {
"id" : "vvvvvvvvv5",
"status" : "SUBMITTED",
"url" : "https://app.vouchfor.com/request/vvvvvvvvv5"
}, {
"id" : "vvvvvvvvv6",
"status" : "RESPONDED",
"url" : "https://app.vouchfor.com/vvvvvvvvv6"
}
]
}