---
updatedAt: 2026-05-27T01:11:24.000Z
agentTools:
  projectIndex: https://developer.vouchfor.com/llms.txt
---

# Create Campaign

Create Campaign

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Vouch",
    "description": "test",
    "termsOfService": "https://vouchfor.com/terms",
    "contact": {
      "name": "Vouch API Support",
      "email": "support@vouchfor.com"
    },
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://{environment}.vouchfor.com/v1",
      "variables": {
        "environment": {
          "default": "api",
          "enum": [
            "api",
            "api-staging"
          ]
        }
      }
    },
    {
      "url": "https://{environment}.vouchfor.com/v1/entities/{entityId}",
      "variables": {
        "environment": {
          "default": "api",
          "enum": [
            "api",
            "api-staging"
          ]
        },
        "entityId": {
          "default": "demo",
          "description": "Entity ID"
        }
      }
    }
  ],
  "components": {
    "requestBodies": {
      "CreateCampaign": {
        "description": "Create Campaign",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "account": {
                  "$ref": "#/components/schemas/Account"
                },
                "campaign": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Campaign"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "settings": {
                          "$ref": "#/components/schemas/Settings"
                        },
                        "status": {
                          "type": "string",
                          "enum": [
                            "DRAFT",
                            "LIVE"
                          ],
                          "example": "DRAFT"
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "questions": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Question"
                          }
                        }
                      }
                    },
                    {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "name"
                      ]
                    }
                  ]
                }
              },
              "required": [
                "campaign"
              ]
            }
          }
        }
      }
    },
    "responses": {
      "Campaign": {
        "description": "Full Campaign Object",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "account": {
                  "$ref": "#/components/schemas/Account"
                },
                "entity": {
                  "$ref": "#/components/schemas/Entity"
                },
                "campaign": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/Campaign"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "questions": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Question"
                          }
                        },
                        "settings": {
                          "$ref": "#/components/schemas/Settings"
                        }
                      }
                    }
                  ]
                }
              }
            }
          }
        }
      },
      "BadRequestError": {
        "description": "Request content is invalid",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Bad Request."
            }
          }
        }
      },
      "UnauthorizedError": {
        "description": "Invalid API key",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Unauthorized."
            }
          }
        }
      },
      "InternalServerError": {
        "description": "Internal server error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Error"
            },
            "example": {
              "error": "Internal Server Error."
            }
          }
        }
      }
    },
    "schemas": {
      "Account": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "example": "david@vouchfor.com"
          },
          "name": {
            "type": "string",
            "example": "David Stirk"
          }
        }
      },
      "Answer": {
        "type": "object",
        "readOnly": true,
        "properties": {
          "customer": {
            "$ref": "#/components/schemas/Customer"
          },
          "contact": {
            "$ref": "#/components/schemas/Contact"
          },
          "duration": {
            "type": "number",
            "format": "float",
            "readOnly": true,
            "example": 6.18
          },
          "label": {
            "type": "string",
            "readOnly": true
          },
          "url": {
            "type": "string",
            "format": "uri",
            "readOnly": true,
            "example": "https://admin.vouchfor.com/vvvvvvvvvv/1"
          },
          "preview": {
            "type": "string",
            "format": "uri",
            "readOnly": true
          },
          "thumbnail": {
            "type": "string",
            "format": "uri",
            "readOnly": true
          },
          "video": {
            "type": "string",
            "format": "uri",
            "readOnly": true
          },
          "input": {
            "type": "string",
            "format": "uri",
            "readOnly": true
          },
          "sentiment": {
            "type": "string",
            "readOnly": true,
            "example": "NEUTRAL"
          },
          "text": {
            "type": "string",
            "readOnly": true,
            "example": "this is answer 1"
          },
          "summary": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "Branding": {
        "type": "object",
        "properties": {
          "color": {
            "type": "string"
          },
          "text": {
            "type": "string"
          }
        }
      },
      "Campaign": {
        "description": "A campaign is called a Request in the Vouch admin and documentation",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "externalid": {
                "type": "string",
                "minLength": 1,
                "maxLength": 50,
                "example": "my-application-id"
              },
              "createddate": {
                "type": "string",
                "format": "date-time",
                "readOnly": true,
                "example": "2021-01-01T12:00:00.000Z"
              },
              "updateddate": {
                "type": "string",
                "format": "date-time",
                "readOnly": true,
                "example": "2022-01-01T12:00:00.000Z"
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "note": {
                "$ref": "#/components/schemas/Note"
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "readOnly": true,
                "example": "cccccccccc"
              },
              "admin": {
                "type": "string",
                "format": "uri",
                "readOnly": true,
                "example": "https://admin.vouchfor.com/admin/c/cccccccccc"
              },
              "name": {
                "type": "string",
                "example": "Happy Customers"
              },
              "status": {
                "type": "string",
                "readOnly": true,
                "enum": [
                  "COMPLETE",
                  "DRAFT",
                  "LIVE",
                  "PAUSED"
                ],
                "example": "LIVE"
              },
              "url": {
                "type": "string",
                "format": "uri",
                "readOnly": true,
                "example": "https://app.vouchfor.com/c/cccccccccc"
              }
            }
          }
        ]
      },
      "Contact": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "example": "daniel@vouchfor.com"
          },
          "name": {
            "type": "string",
            "example": "Daniel Shein"
          }
        },
        "required": [
          "email"
        ]
      },
      "Customer": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Vouch"
          },
          "url": {
            "type": "string",
            "format": "uri",
            "example": "https://vouchfor.com"
          }
        }
      },
      "Entity": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "externalid": {
                "type": "string",
                "minLength": 1,
                "maxLength": 50,
                "example": "my-application-id"
              },
              "createddate": {
                "type": "string",
                "format": "date-time",
                "readOnly": true,
                "example": "2021-01-01T12:00:00.000Z"
              },
              "updateddate": {
                "type": "string",
                "format": "date-time",
                "readOnly": true,
                "example": "2022-01-01T12:00:00.000Z"
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "note": {
                "$ref": "#/components/schemas/Note"
              }
            }
          },
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "readOnly": true,
                "example": "eeeeeeeeee"
              },
              "name": {
                "type": "string",
                "example": "Vouch"
              },
              "logo": {
                "type": "string",
                "format": "uri",
                "example": "https://img.logo.dev/vouchfor.com?token=pk_XzHPPDjZTBikQbIi3iLD0A&size=260"
              },
              "url": {
                "type": "string",
                "format": "uri",
                "example": "https://vouchfor.com"
              }
            }
          }
        ]
      },
      "Error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string"
          }
        }
      },
      "Note": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "example": "thanks for Vouching for us!"
          }
        }
      },
      "Question": {
        "type": "object",
        "properties": {
          "answer": {
            "$ref": "#/components/schemas/Answer"
          },
          "maxduration": {
            "type": "integer",
            "example": 30
          },
          "optional": {
            "type": "boolean",
            "example": false
          },
          "orientation": {
            "type": "string",
            "enum": [
              "DEFAULT",
              "LANDSCAPE",
              "PORTRAIT",
              "SQUARE"
            ],
            "example": "DEFAULT"
          },
          "direction": {
            "type": "string",
            "enum": [
              "DEFAULT",
              "USER",
              "ENVIRONMENT"
            ],
            "example": "DEFAULT"
          },
          "script": {
            "type": "string"
          },
          "text": {
            "type": "string",
            "example": "this is question 1"
          },
          "type": {
            "type": "string",
            "enum": [
              "AUDIO",
              "SCREEN",
              "TEXT",
              "VIDEO"
            ],
            "example": "VIDEO"
          }
        }
      },
      "Settings": {
        "type": "object",
        "properties": {
          "branding": {
            "type": "object",
            "properties": {
              "base": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/Branding"
                  },
                  {
                    "type": "object",
                    "properties": {
                      "radius": {
                        "type": "string"
                      }
                    }
                  }
                ]
              },
              "button": {
                "$ref": "#/components/schemas/Branding"
              },
              "logo": {
                "type": "string",
                "format": "uri"
              }
            },
            "example": {
              "base": {
                "primary": {
                  "color": "#850231",
                  "text": "#FFFFFF"
                },
                "radius": "8px",
                "secondary": {
                  "color": "#850231",
                  "text": "#FFFFFF"
                }
              },
              "button": {
                "primary": {
                  "color": "#E84A4A",
                  "text": "#FFFFFF"
                },
                "secondary": {
                  "color": "#000000",
                  "text": "#FFFFFF"
                }
              },
              "logo": "https://img.logo.dev/vouchfor.com?token=pk_XzHPPDjZTBikQbIi3iLD0A&size=260"
            }
          },
          "cover": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "example": "vvvvvvvvvv"
              }
            }
          },
          "labels": {
            "type": "object",
            "properties": {
              "submission": {
                "type": "string",
                "example": "All done! Thanks for submitting a response."
              },
              "title": {
                "type": "string",
                "example": "Vouch Request"
              },
              "welcome": {
                "type": "string",
                "example": "Vouch has invited you to Vouch for them"
              }
            }
          },
          "options": {
            "type": "object",
            "properties": {
              "showAccountDetails": {
                "type": "boolean",
                "example": true
              },
              "sendReceiveEmail": {
                "type": "boolean",
                "example": true
              },
              "sendResponseEmail": {
                "type": "boolean",
                "example": true
              },
              "showCoverScreen": {
                "type": "boolean",
                "example": true
              },
              "allowAudioOnly": {
                "type": "boolean",
                "example": true
              },
              "showSummaryScreen": {
                "type": "boolean",
                "example": true
              },
              "showContactForm": {
                "type": "boolean",
                "example": true
              },
              "showEstimatedTime": {
                "type": "boolean",
                "example": true
              },
              "showQuestionList": {
                "type": "boolean",
                "example": true
              },
              "showCustomerFields": {
                "type": "boolean",
                "example": true
              },
              "showPrivacy": {
                "type": "boolean",
                "example": true
              },
              "showTerms": {
                "type": "boolean",
                "example": true
              }
            }
          },
          "urls": {
            "type": "object",
            "properties": {
              "privacy": {
                "type": "string",
                "format": "uri",
                "example": "https://vouchfor.com/privacy"
              },
              "terms": {
                "type": "string",
                "format": "uri",
                "example": "https://vouchfor.com/terms"
              }
            }
          },
          "watch": {
            "type": "object",
            "properties": {
              "questionPosition": {
                "type": "string",
                "enum": [
                  "BOTTOM",
                  "LEFT",
                  "RIGHT",
                  "TOP"
                ],
                "example": "LEFT"
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKey": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "ApiKey": []
    }
  ],
  "tags": [
    {
      "name": "Campaign",
      "description": "A campaign is called a Request in the Vouch admin and documentation"
    }
  ],
  "paths": {
    "/campaigns": {
      "post": {
        "summary": "Create Campaign",
        "description": "Create Campaign",
        "tags": [
          "Campaign"
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/CreateCampaign"
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/Campaign"
          },
          "400": {
            "$ref": "#/components/responses/BadRequestError"
          },
          "401": {
            "$ref": "#/components/responses/UnauthorizedError"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    }
  }
}
```