Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

Update your user preferences

PATCH
/api/v1/users/preferences
curl --request PATCH \
  --url https://api.pitch2sale.com/api/v1/users/preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "inbox_primary_types": [ "tasks" ], "meetings_sidebar_open": true, "goal_notifications": { "approaching": true, "completed": true, "missed": true, "via_email": true }, "tour_state": { "additionalProperty": "seen" }, "briefing_email": true }'

Partial update.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
inbox_primary_types
Array<string>
Allowed values: tasks emails calls messages reminders potential_contacts
meetings_sidebar_open
boolean
goal_notifications
object
approaching
boolean
completed
boolean
missed
boolean
via_email
boolean
tour_state
object
key
additional properties
string
Allowed values: seen dismissed
briefing_email
boolean

Responses

Section titled “Responses”

200

Section titled “200”

OK

400

Section titled “400”

Validation failed

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Section titled “401”

Authentication required or token invalid

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}