---
agentTools:
projectIndex: https://docs.developer.yelp.com/llms.txt
---
# Delete Portfolio Project
Delete a portfolio project.
[block:callout]
{
"type": "info",
"body": "This endpoint is part of the Program Feature API, visit [Program Feature API](https://docs.developer.yelp.com/docs/program-feature-api) to learn more."
}
[/block]
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Program Feature",
"version": "1.0"
},
"servers": [
{
"url": "https://partner-api.yelp.com/program"
}
],
"security": [
{
"basic": []
}
],
"components": {
"securitySchemes": {
"basic": {
"type": "http",
"scheme": "basic"
}
}
},
"paths": {
"/{program_id}/features/v1": {
"get": {
"tags": [
"Program Feature"
],
"summary": "Retrieve Program Feature",
"operationId": "retrieve_program_feature",
"description": "Retrieve available and active features for the specified payment program.\n\nThis endpoint returns the program features that are available for the specified program. For each available feature type, the `features` object will contain the corresponding `feature` object as described below. If the program does not support any of the available feature types the `features` object will be empty.\n\n### LINK_TRACKING\n| Parameter | Type | Required | Description\n| --------- | ------------- | ------------- | -------------\n| `website`\t| string or null | Yes\t | Tracking URL or parameter(s) for the website link\n| `menu`\t| string or null | Yes\t | Tracking URL or parameter(s) for the menu link\n| `url`\t | string or null | Yes\t | Tracking URL or parameter(s) for the CTA link\n\n### NEGATIVE_KEYWORD_TARGETING\n| Parameter | Type | Required | Description\n| -------------------- | ---------------- | ----------- | -------------\n| `suggested_keywords` | list of string | No\t | 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.\n| `blocked_keywords` | list of string | Yes\t | 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.\n\n### STRICT_CATEGORY_TARGETING\n| Parameter | Type | Required | Description\n| --------- | ------------- | ------------- | -------------\n| `enabled` |\tbool |\tYes\n\n### AD_SCHEDULING\n| Parameter | Type | Required | Description\n| -------------------- | -------- | ----------- | -------------\n| `uses_opening_hours` | bool | Yes | Should the ad only be delivered while the business is open?
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.\n\n### CUSTOM_LOCATION_TARGETING\n| Parameter | Type | Required | Description\n| --------------------------- | ------------- | ------------| -------------\n| `businesses` |\tlist[object] |\tYes | List of all businesses that are part of the ad campaign.\n| `businesses[].business_id` | string\t | Yes | Business ID\n| `businesses[].locations` |\tlist[string] |\tYes | 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.\n\n### AD_GOAL\n| Parameter | Type | Required | Description\n| --------- | ------------- | ------------- | -------------\n| `ad_goal` |\tbool |\tYes | Must be one of `DEFAULT`, `CALLS`, or `WEBSITE_CLICKS`\n\n\n### CALL_TRACKING\n| Parameter | Type | Required | Description\n| ----------------------------------- | -------------- | ------------- | -------------\n| `enabled` |\tbool | Yes | Indicates whether call tracking is enabled or disabled on a campaign level.\n| `businesses` |\tlist[object] | Yes | List of all businesses that are part of the ad campaign.\n| `businesses[].business_id` | string | Yes | Business ID\n| `businesses[].metered_phone_number` |\tstring or null | Yes | Phone number which will be used as a call tracking number for the provided business in the ad campaign.\n\n### SERVICE_OFFERINGS_TARGETING\n\n**Note:** This feature was **deprecated** and removed, please use Negative Keyword Targeting instead.\n\n### BUSINESS_HIGHLIGHTS\n| Parameter | Type | Required | Description\n| ---------------------------------------- | ------------------ | ----------- | -------------\n| `active_business_highlights` | list[string] | Yes\t | Currently active business highlights enabled\n| `available_business_highlights` | list[string] | Yes\t | Valid business highlights available to select from\n| `mutually_exclusive_business_highlights` | list[list[string]] | Yes |\tPairs of business highlights that can't be enabled together\n\n### VERIFIED_LICENSE\n| Parameter | Type | Required | Description\n| ------------------------------------------------ | ----------- | ------------- | -------------\n| `licenses[].license_number` | string |\tYes |\tLicense number provided by issuing agency/authority\n| `licenses[].license_expiry_date` | string | \tNo | \tLicense expiry date (format YYYY-MM-DD)\n| `licenses[].license_trade` | string | \tNo |\tBusiness or trade for which a license was issued\n| `licenses[].license_issuing_agency` | string |\tNo |\tAgency/authority that issued the license\n| `licenses[].license_verification_status` | string | \tYes |\tLicense verification status, one of PENDING, VERIFIED or REJECTED\n| `licenses[].license_verification_failure_reason` | string | \tNo |\tLicense verification failure reason\n\n### CUSTOM_RADIUS_TARGETING\n| Parameter | Type | Required | Description\n| --------------- | ------------- | ------------- | -------------\n| `custom_radius` |\tfloat |\tNo |\tRadius in miles (1 to 60)
By default, custom_radius is null which means this feature is inactive.\n\n### CUSTOM_AD_TEXT\n| Parameter | Type | Required | Description\n| ------------------ | ---------- | ----------- | -------------\n| `custom_review_id` |\tstring |\tNo | Identifier of the review from which to extract the text.\n| `custom_text` |\tstring |\tNo | Custom text to be shown.\n\n*Note: Only one field can be set\nBy default, this is set to null, which means the ad text is set by Yelp.\n\n### CUSTOM_AD_PHOTO\n| Parameter | Type | Required | Description\n| ----------------- | ---------- | ------------- | -------------\n| `custom_photo_id` | string | No |\tIdentifier of the photo to show on the custom ad.\n\n### BUSINESS_LOGO\n| Parameter | Type | Required | Description\n| ------------------- | ---------- | ----------- | -------------\n| `business_logo_url` |\tstring | No | URL to the business's brand logo if in use.
In POST, URL must be publicly accessible image file of type: jpeg / png / gif / tiff\n\n### YELP_PORTFOLIO\n| Parameter | Type | Required | Description\n| ----------------------- | ------------- | ------------- | -------------\n| `projects[].project_id` |\tstring |\tYes |\tIdentifier of a project\n| `projects[].published` |\tboolean |\tYes |\tWhether the project is published\n",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved a payment program's features",
"content": {
"application/json": {
"examples": {
"Result": {
"value": {
"features": {
"LINK_TRACKING": {
"website": "utm_source=yelp",
"menu": null,
"call_to_action": "http://tracking.example/campaigns/42"
},
"NEGATIVE_KEYWORD_TARGETING": {
"suggested_keywords": [
"24 hour coffee shops",
"bagels",
"bakery",
"breakfast & brunch",
"bubble tea",
"cafe",
"cake",
"coffee",
"coffee shops free wifi",
"desserts",
"donuts",
"dunkin donuts",
"espresso",
"healthy food",
"ice cream",
"late night coffee shops",
"lunch",
"pastry",
"restaurants",
"smoothie",
"starbucks",
"starbucks drive thru",
"study spots",
"tea",
"vegan"
],
"blocked_keywords": [
"desserts",
"donuts",
"dunkin donuts"
]
},
"STRICT_CATEGORY_TARGETING": {
"enabled": false
},
"CUSTOM_LOCATION_TARGETING": {
"businesses": [
{
"business_id": "wKgam7fyKFRPWVS6MzVOUA",
"locations": [
"94134, San Francisco, CA",
"94143, San Francisco, CA",
"94158, San Francisco, CA",
"94188, San Francisco, CA"
]
}
]
},
"AD_SCHEDULING": {
"uses_opening_hours": false
}
},
"program_id": "hmPSQN_57dtcE9fUJvWTDw",
"program_type": "CPC"
}
}
},
"schema": {
"type": "object",
"properties": {
"features": {
"type": "object",
"properties": {
"LINK_TRACKING": {
"type": "object",
"properties": {
"website": {
"type": "string"
},
"menu": {
"type": "string"
},
"call_to_action": {
"type": "string"
}
}
},
"NEGATIVE_KEYWORD_TARGETING": {
"type": "object",
"properties": {
"suggested_keywords": {
"type": "array",
"items": {
"type": "string"
}
},
"blocked_keywords": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"STRICT_CATEGORY_TARGETING": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean"
}
}
},
"CUSTOM_LOCATION_TARGETING": {
"type": "object",
"properties": {
"businesses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"business_id": {
"type": "string"
},
"locations": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"AD_SCHEDULING": {
"type": "object",
"properties": {
"uses_opening_hours": {
"type": "boolean"
}
}
}
}
},
"program_id": {
"type": "string"
},
"program_type": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Bad Request.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": []
}
}
}
}
}
}
},
"/{program_id}/portfolio/{project_id}/v1": {
"get": {
"tags": [
"Portfolio Project"
],
"summary": "Retrieve Portfolio Project Info",
"operationId": "retrieve_portfolio_project_info",
"description": "Get information about a portfolio project.\n",
"parameters": [
{
"$ref": "#/paths/~1program~1{program_id}~1portfolio~1v1/post/parameters/0"
},
{
"name": "project_id",
"description": "The project identifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successfully retrieved the portfolio project info.",
"content": {
"application/json": {
"examples": {
"Result": {
"value": {
"name": "Test Project",
"call_to_action": "WEBSITE",
"description": "",
"service_offerings": [
"oil_change",
"bike_repair"
],
"cost": "100_TO_300",
"duration": "1_TO_2_MONTHS",
"completion_year": 2021,
"completion_month": 4,
"id": "LBl7uYzs39w_2w8sZoxGFw",
"published": false
}
}
},
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"call_to_action": {
"type": "string"
},
"description": {
"type": "string"
},
"service_offerings": {
"type": "array",
"items": {
"type": "string"
}
},
"cost": {
"type": "string"
},
"duration": {
"type": "string"
},
"completion_year": {
"type": "integer"
},
"completion_month": {
"type": "integer"
},
"id": {
"type": "string"
},
"published": {
"type": "boolean"
}
}
}
}
}
},
"400": {
"$ref": "#/paths/~1{program_id}~1features~1v1/get/responses/400"
}
}
},
"delete": {
"tags": [
"Portfolio Project"
],
"summary": "Delete Portfolio Project",
"operationId": "delete_portfolio_project",
"description": "Delete a portfolio project.\n",
"parameters": [
{
"$ref": "#/paths/~1program~1{program_id}~1portfolio~1v1/post/parameters/0"
},
{
"$ref": "#/paths/~1{program_id}~1portfolio~1{project_id}~1v1/get/parameters/1"
}
],
"responses": {
"204": {
"description": "Successfully deleted the given portfolio project.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": []
}
}
}
},
"400": {
"$ref": "#/paths/~1{program_id}~1features~1v1/get/responses/400"
}
}
}
},
"/program/{program_id}/portfolio/v1": {
"post": {
"tags": [
"Portfolio Project"
],
"summary": "Create a portfolio project draft",
"operationId": "create_portfolio_project_draft",
"description": "Create a new project draft.\n",
"parameters": [
{
"name": "program_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Successfully created a new portfolio project draft.",
"content": {
"application/json": {
"examples": {
"Result": {
"value": {
"project_id": "442pYCJeVzpxovoa7kx-bQ"
}
}
},
"schema": {
"type": "object",
"properties": {
"project_id": {
"type": "string"
}
}
}
}
}
},
"400": {
"$ref": "#/paths/~1{program_id}~1features~1v1/get/responses/400"
}
}
}
}
},
"x-readme": {
"headers": [],
"explorer-enabled": true,
"proxy-enabled": false,
"samples-enabled": true
},
"_id": {
"buffer": {
"0": 99,
"1": 190,
"2": 198,
"3": 116,
"4": 143,
"5": 115,
"6": 230,
"7": 0,
"8": 29,
"9": 186,
"10": 141,
"11": 231
}
}
}
```