Update ads settings
Replaces the web-to-app landing URL prefixes.
Each is a host with an optional path, such as example.app/start; a scheme, www. and a trailing slash are ignored. Synced ads' destinations change right away. Needs project:ads:manage.
Guide: Ads reports
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The project's id, proj_.... A secret key works only in the project it belongs to.
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
Replaces the list. At most 20 host-and-path prefixes of up to 255 characters, such as example.app/start; a scheme, www. and a trailing slash are ignored. Left out, the list stays as it is.
Examples
curl -X PATCH "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/ads/settings" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "webToAppLandingPrefixes": [ "example.app/start", "example.app/offer" ] }'{ "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "webToAppLandingPrefixes": [ "example.app/start", "example.app/offer" ]}{ "error": { "type": "invalid_request", "code": "invalid_landing_prefix", "message": "\"localhost/start\" is not a landing page prefix; use a host with an optional path, such as example.app/start.", "param": "webToAppLandingPrefixes" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "project_not_found", "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.", "param": "projectId" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request | invalid_landing_prefix | — |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Ads
- List campaigns
GET - Retrieve a campaign
GET - List ad groups
GET - Retrieve an ad group
GET - List ads
GET - Retrieve an ad
GET - Preview a creative
GET - Retrieve ads settings
GET - Report ad performance
POST - Report creatives
POST - Report ad cohorts
POST - Report ad changes
POST
Something wrong or missing on this page? Tell us by email or on Discord.