Skip to content

Create or update a respondent

POST
/put-respondent

Warning

Do not pass values into attributes with display_mode: none, display_mode: geo or display_mode: zip. These are derived and will not accept any value you send in. No errors will be surfaced.

Learn more here.

Respondents

dynata-expiration
required
string format: date-time

RFC3339 timestamp indicating request expiration

dynata-access-key
required
string

Dynata provided access key

Example
ABCD1234
dynata-signature
required
string

Signature created using the dynata methodology

Example
c156e91013eb715edb2b07df5491497a807206b1796bb7d031505107a9dbdcdf
object
respondent_id
required

Partner’s respondent identifier. Accepts 100 characters, 3-byte chars.

string
language
required
string
/^[a-z]{2}$/
country
required
string
/^[A-Z]{2}$/
gender

Case insensitive value for gender

Allowed values: male m 1 female f 2
birth_date
string format: YYYY-MM-DD
postal_code
string
attributes
Array<object>
object
id
required
integer format: int64
answers
required
Array<integer>

Respondent created or updated successfully

Bad request

object
message
required
string

Invalid credentials

object
message
required
string

Unauthorized

object
message
required
string

Unprocessable Entity

object
message
required
string

Too many requests

object
message
required
string
retry-after
string
Example
300

The number of seconds a client must wait before making a new request.

Internal server error

object
message
required
string