Update project settings

Changes the settings in the body; settings left out keep their values.

Returns every setting. Paid access sharing and store sandbox changes apply to purchases and requests from then on; the ads key conversion applies to past report ranges too.

Guide: Teams, projects and environments

Errors

This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Projects

Something wrong or missing on this page? Tell us by email or on Discord.

Path parameters

projectId*string

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.

paidAccessSharing?|

How a purchase reported by another account is handled, per store environment.

storeSandbox?|

Purchases made in a store's sandbox.

ads?|

How the project's ad spend is measured.

Examples

curl -X PATCH "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/settings" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "ads": {      "keyConversion": "payer"    }  }'

{  "paidAccessSharing": {    "production": "shared",    "sandbox": "shared"  },  "storeSandbox": {    "isUnlockingProduction": false  },  "ads": {    "keyConversion": "payer",    "attributionWindowDays": 7  }}

{  "error": {    "type": "invalid_request",    "code": "invalid_body",    "message": "The request body is invalid: Expected object"  }}

{  "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."  }}

Update project settings

Errors

More in Projects

Update project settings

Errors

More in Projects

Authorization

Path parameters

Request body

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Update project settings

Update project settings

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`