Add Program Feature
Set up or update program features for the specified payment program.
This endpoint sets up feature types for the specified program by providing values for the available features in the request body - either all features types or any subset. The response of this endpoint is identical to the one from the GET endpoint and reflects the changes to the specified payment program if successful. If a feature_type key is passed to a program that does not support the requested feature type, an error message is returned.
LINK_TRACKING
| Parameter | Type | Required | Description |
|---|
| website | string or null | Yes | Tracking URL or parameter(s) for the website link |
| menu | string or null | Yes | Tracking URL or parameter(s) for the menu link |
| url | string or null | Yes | Tracking URL or parameter(s) for the CTA link |
NEGATIVE_KEYWORD_TARGETING
| Parameter | Type | Required | Description |
|---|
| suggested_keywords | list of string | No | List of search terms for which your biz ad might be shown. Please note: This list consists of up to 25 possible keywords where your ad may appear. Those suggestions are based on common searches associated with the business category. The 25 suggestions are not exhaustive, your ad will also appear on searches not shown in the list of suggestions. |
| blocked_keywords | list of string | Yes | List of currently blocked keywords. You can use this field to update the list of terms you would like to block. Please note: You are allowed to add custom search terms outside of the suggested keywords list. Suggested keywords list is for guidance purposes. |
STRICT_CATEGORY_TARGETING
| Parameter | Type | Required | Description |
|---|
| enabled | bool | Yes | |
AD_SCHEDULING
| Parameter | Type | Required | Description |
|---|
| uses_opening_hours | bool | Yes | Should the ad only be delivered while the business is open? <br /> i.e. if {'uses_opening_hours': true } and the business's hours are 8-5pm, a 6pm search wouldn't be eligible for this ad. |
CUSTOM_LOCATION_TARGETING
| Parameter | Type | Required | Description |
|---|
| businesses | list[object] | Yes | List of all businesses that are part of the ad campaign. |
| businesses[].business_id | string | Yes | Business ID |
| businesses[].locations | list[string] | Yes | List of 0 up to 25 locations. These locations can be zip codes, cities, neighbourhoods, counties or state names but must be within the US. |
AD_GOAL
| Parameter | Type | Required | Description |
|---|
| ad_goal | bool | Yes | Must be one of DEFAULT, CALLS, or WEBSITE_CLICKS |
CALL_TRACKING
| Parameter | Type | Required | Description |
|---|
| enabled | bool | Yes | Indicates whether call tracking is enabled or disabled on a campaign level. |
| businesses | list[object] | Yes | List of all businesses that are part of the ad campaign. |
| businesses[].business_id | string | Yes | Business ID |
| businesses[].metered_phone_number | string or null | Yes | Phone number which will be used as a call tracking number for the provided business in the ad campaign. |
SERVICE_OFFERINGS_TARGETING
Note: This feature was deprecated and removed, please use Negative Keyword Targeting instead.
BUSINESS_HIGHLIGHTS
| Parameter | Type | Required | Description |
|---|
| active_business_highlights | list[string] | Yes | List of desired business highlights to set |
Business Highlights with parameters and examples of the format they must be sent to the POST endpoint. This is also the format that the GET endpoint returns these Business Highlights in:
X_EMPLOYEES: (e.g. 10_EMPLOYEES)
XX_YEARS_IN_BUSINESS (eg. 15_YEARS_IN_BUSINESS)
ESTABLISHED_IN_XXXX (e.g. ESTABLISHED_IN_1990)
VERIFIED_LICENSE
| Parameter | Type | Required | Description |
|---|
| licenses[].license_number | string | Yes | License number provided by issuing agency/authority |
| licenses[].license_expiry_date | string | No | License expiry date (format YYYY-MM-DD) |
| licenses[].license_trade | string | No | Business or trade for which a license was issued |
| licenses[].license_issuing_agency | string | No | Agency/authority that issued the license |
Note
- Each POST VERIFIED_LICENSE appends to the existing licenses stored
- If you need to edit a license use the same license_number and the other fields will be overwritten for that license
- You can send multiple licenses in one request
CUSTOM_RADIUS_TARGETING
| Parameter | Type | Required | Description |
|---|
| custom_radius | float | No | Radius in miles (1 to 60) <br /> By default, custom_radius is null which means this feature is inactive. |
CUSTOM_AD_TEXT
| Parameter | Type | Required | Description |
|---|
| custom_review_id | string | No | Identifier of the review from which to extract the text. |
| custom_text | string | No | Custom text to be shown. |
*Note: Only one field can be set
By default, this is set to null, which means the ad text is set by Yelp.
CUSTOM_AD_PHOTO
| Parameter | Type | Required | Description |
|---|
| custom_photo_id | string | No | Identifier of the photo to show on the custom ad. |
BUSINESS_LOGO
| Parameter | Type | Required | Description |
|---|
| business_logo_url | string | No | URL to the business's brand logo if in use. <br />In POST, URL must be publicly accessible image file of type: jpeg / png / gif / tiff |
YELP_PORTFOLIO
| Parameter | Type | Required | Description |
|---|
| projects[].project_id | string | Yes | Identifier of a project |
| projects[].published | boolean | Yes | Whether the project is published |