Custom Fields
Returns a list of custom fields for the program. Supports searching by name or ID and filtering by display type.
The Account SID.
The program ID.
Search query to filter by custom field name or ID.
Filter by display types. See the DisplayType field for accepted values.
A list of custom fields.
Program not found.
Internal server error.
GET /Advertisers/{AccountSid}/Programs/{ProgramId}/CustomFields HTTP/1.1
Host: api.impact.com
Accept: */*
{
"CustomFields": [
{
"Id": 42,
"Name": "Company website",
"Description": "The partner's primary website URL",
"DisplayType": "Paragraph",
"Enumerations": []
},
{
"Id": 43,
"Name": "Primary region",
"Description": "The partner's main operating region",
"DisplayType": "Dropdown list",
"Enumerations": [
{
"Id": 100,
"Value": "Americas"
},
{
"Id": 101,
"Value": "EMEA"
},
{
"Id": 102,
"Value": "APAC"
}
]
},
{
"Id": 44,
"Name": "Content categories",
"Description": "Content types the partner produces",
"DisplayType": "Multi-select",
"Enumerations": [
{
"Id": 200,
"Value": "Fashion"
},
{
"Id": 201,
"Value": "Technology"
},
{
"Id": 202,
"Value": "Travel"
}
]
},
{
"Id": 45,
"Name": "Years in business",
"Description": "How long the partner has been operating",
"DisplayType": "Number",
"Enumerations": []
}
]
}Creates a custom field. For enumeration-based display types (dropdown list, single-select, and multi-select), provide the option values in Enumerations.
For more about custom fields and how they're used in surveys, see Create Custom Fields for Surveys.
The Account SID.
The program ID.
Name of the custom field.
Description of the custom field.
The display type for the custom field. Determines what kind of data the field collects:
- Paragraph — Open-ended questions that allow unique answers.
- Multi-select — Questions that may include multiple answers. Respondents can select one or more options. (enumeration-based)
- Dropdown list — Questions that require respondents to select one option from a dropdown menu. (enumeration-based)
- Single-select — Questions that require respondents to select only one option from a list. (enumeration-based)
- Date picker — Questions that require a date as an answer.
- Number — Questions that require a number as an answer.
- File — Questions that require an attachment from the partner.
Dropdown listPossible values: List of option values, required for enumeration-based display types (dropdown list, single-select, multi-select). Provide each option as a separate array item.
The created custom field.
Success envelope returned when a custom field is created.
SUCCESSBad request. This can occur when:
- The Account SID is invalid
DisplayTypeis missing or is not a recognized display type- A custom field with the same name and type already exists. The uniqueness check is on name and type combined, so two custom fields may share a name as long as their types differ.
Program not found.
Internal server error.
POST /Advertisers/{AccountSid}/Programs/{ProgramId}/CustomFields HTTP/1.1
Host: api.impact.com
Content-Type: application/json
Accept: */*
Content-Length: 149
{
"Name": "Primary region",
"Description": "The partner's main operating region",
"DisplayType": "Dropdown list",
"Enumerations": [
"Americas",
"EMEA",
"APAC"
]
}{
"Status": "SUCCESS",
"Body": {
"Id": 43,
"Name": "Primary region",
"Description": "The partner's main operating region",
"DisplayType": "Dropdown list",
"Enumerations": [
{
"Id": 100,
"Value": "Americas"
},
{
"Id": 101,
"Value": "EMEA"
},
{
"Id": 102,
"Value": "APAC"
}
]
}
}Returns the details of a single custom field.
The Account SID.
The program ID.
The custom field ID.
The requested custom field.
A custom field that defines the data collection type for a survey question.
The display type.
Invalid request.
Custom field not found.
Internal server error.
GET /Advertisers/{AccountSid}/Programs/{ProgramId}/CustomFields/{CustomFieldId} HTTP/1.1
Host: api.impact.com
Accept: */*
{
"Id": 43,
"Name": "Primary region",
"Description": "The partner's main operating region",
"DisplayType": "Dropdown list",
"Enumerations": [
{
"Id": 100,
"Value": "Americas"
},
{
"Id": 101,
"Value": "EMEA"
},
{
"Id": 102,
"Value": "APAC"
}
]
}Deletes a custom field.
Warning: Deleting a custom field also deletes all response data collected through it. Any survey that uses the field is no longer available to partners.
The Account SID.
The program ID.
The custom field ID.
The custom field was deleted.
Custom field not found.
Internal server error.
DELETE /Advertisers/{AccountSid}/Programs/{ProgramId}/CustomFields/{CustomFieldId} HTTP/1.1
Host: api.impact.com
Accept: */*
{
"Status": "SUCCESS"
}Updates the name and/or description of a custom field.
Note: A custom field's type (DisplayType) and its enumeration values cannot be changed after the field is created. Changing them would break surveys and responses that already use the field, so impact.com only allows the name and description to be updated for now. If a custom field needs to change in any other way, rename the existing field (for example, prefix its name with [archived] or [deprecated]) and create a new custom field.
The Account SID.
The program ID.
The custom field ID.
Only the fields provided are updated.
Updated name of the custom field.
Updated description of the custom field.
The custom field was updated.
Bad request.
Custom field not found.
Internal server error.
PATCH /Advertisers/{AccountSid}/Programs/{ProgramId}/CustomFields/{CustomFieldId} HTTP/1.1
Host: api.impact.com
Content-Type: application/json
Accept: */*
Content-Length: 65
{
"Name": "Updated Field Name",
"Description": "Updated description"
}{
"Status": "SUCCESS"
}Last updated