Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Question

createCampaignQuestion

Create a new question for a specific campaign. Questions marked as required will automatically be treated as pre-conversion (where supported).

post/campaigns/{campaign}/questions

Path parameters

campaigninteger required
Example:227362

The ID of the campaign to which the question will be added

Request body

campaign_idinteger

Primary identifier of Campaign

created_atstring date-time

Date/time of when record created

deleted_atstring date-time nullable

Date/time of when record deleted

idinteger

Primary identifier of record

is_deletedboolean

Question deleted or not

is_requiredboolean

Whether the Question is required or not. If is_required is true, the question will be treated as pre-conversion (shown before donation), otherwise it will be treated as post-conversion (shown after donation) for supported workflows.

is_pre_conversionboolean

Whether the Question should be shown before donation (pre-conversion) or after donation (post-conversion). When true, the question is displayed before the donation is processed.

labelstring required

Question label

location'donation_page' | 'team_creation' | 'page_creation' | 'campaign_registration' required

Question location

product_idinteger nullable

Identifier of associated product, such as a ticket

tag'address' | 'address2' | 'address_type' | 'birthdate' | 'blog' | 'cellphone' | 'city' | 'company_name' | 'country' | 'email_address' | 'email_type' | 'emergency_first_name' | 'emergency_last_name' | 'emergency_phone' | 'event_waiver' | 'first_name' | 'gender' | 'pronoun' | 'homephone' | 'last_name' | 'middle_name' | 'postal_code' | 'prefix' | 'run_walk' | 'shirt_size' | 'state' | 'suffix' | 'text_opt_in' | 'website' nullable

Question tag, unique for a location on a campaign

type'boolean' | 'integer' | 'currency' | 'enum' | 'text' | 'string' | 'date' | 'yes_no' required

Type of the Question

updated_atstring date-time nullable

Date/time of last record update

weightinteger nullable

Weight of the Question, used for display order

Example request

{
  "campaign_id": 227362,
  "created_at": "2021-04-23T10:25:03Z",
  "deleted_at": "2021-04-23T10:25:03Z",
  "id": 45678,
  "is_required": true,
  "label": "Do you require accommodations due to a medical condition or disability?",
  "location": "donation_page",
  "product_id": 73647,
  "tag": "email_address",
  "type": "boolean",
  "updated_at": "2021-04-23T10:25:03Z"
}

Response

Success

campaign_idinteger

Primary identifier of Campaign

created_atstring date-time

Date/time of when record created

deleted_atstring date-time nullable

Date/time of when record deleted

idinteger

Primary identifier of record

is_deletedboolean

Question deleted or not

is_requiredboolean

Whether the Question is required or not. If is_required is true, the question will be treated as pre-conversion (shown before donation), otherwise it will be treated as post-conversion (shown after donation) for supported workflows.

is_pre_conversionboolean

Whether the Question should be shown before donation (pre-conversion) or after donation (post-conversion). When true, the question is displayed before the donation is processed.

labelstring required

Question label

location'donation_page' | 'team_creation' | 'page_creation' | 'campaign_registration' required

Question location

product_idinteger nullable

Identifier of associated product, such as a ticket

tag'address' | 'address2' | 'address_type' | 'birthdate' | 'blog' | 'cellphone' | 'city' | 'company_name' | 'country' | 'email_address' | 'email_type' | 'emergency_first_name' | 'emergency_last_name' | 'emergency_phone' | 'event_waiver' | 'first_name' | 'gender' | 'pronoun' | 'homephone' | 'last_name' | 'middle_name' | 'postal_code' | 'prefix' | 'run_walk' | 'shirt_size' | 'state' | 'suffix' | 'text_opt_in' | 'website' nullable

Question tag, unique for a location on a campaign

type'boolean' | 'integer' | 'currency' | 'enum' | 'text' | 'string' | 'date' | 'yes_no' required

Type of the Question

updated_atstring date-time nullable

Date/time of last record update

weightinteger nullable

Weight of the Question, used for display order

Example response

{
  "campaign_id": 227362,
  "created_at": "2021-04-23T10:25:03Z",
  "deleted_at": "2021-04-23T10:25:03Z",
  "id": 45678,
  "is_required": true,
  "label": "Do you require accommodations due to a medical condition or disability?",
  "location": "donation_page",
  "product_id": 73647,
  "tag": "email_address",
  "type": "boolean",
  "updated_at": "2021-04-23T10:25:03Z",
  "enum_options": [
    {
      "label": "Text label",
      "question_id": 45678
    }
  ]
}