API Reference

Create poll

post
https://voting.fansunitedapi.com/v1/polls

Create poll for your users to interact with.

Authentication: Staff member's JWT.

Query Params
string
required

Client ID parameter.

string
required

Client API key

Body Params
string
required

Title of poll

string

Description of poll

string

Poll type

images
object

Images of poll

string
enum
required

Status of poll

Allowed:
boolean
string
enum

Define default authentication requirement

Allowed:
string

External activity SKU for paid polls

flags
array of strings

Flags in poll

flags
custom_fields
object

Custom fields in poll

labels
object

Labels in poll

string

This property contains the language key, e.g. fr, de, en-US, etc.

string

This property can store an alternative title for the Poll

string

Rules in public poll

string

AD content in public poll

context
object

The context of the poll

string

An additional HTML code.

branding
object

Branding configuration for the poll.

related
array of objects

Related entities.

related
boolean
Defaults to false

Whether the poll allows multiple choice

int32
≥ 1
Defaults to 1

The maximum number of options that can be selected in a multiple choice poll

int32
Defaults to 1

How many times the user is allowed to vote.

options
array of objects
required
length ≥ 2

Options for the poll

options*
string
required
string
string
preferences_mapping
array of objects
preferences_mapping
images
object
string
required
string
string
preferences_mapping
array of objects
preferences_mapping
images
object
Responses

400

Bad request

401

Unauthorized

403

Forbidden

404

Resource not found

500

Internal server error

Updated over 1 year ago

Language
Credentials
Bearer
jwt
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago