PUT /instant-response

PUT

/api/v1/instant-response

curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/instant-response \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "is_active": true, "email_enabled": true, "email_subject": "example", "email_body_html": "example", "sms_enabled": true, "sms_body": "example", "source_filter": [ "example" ] }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

is_active

boolean

email_enabled

boolean

email_subject

string

>= 1 characters <= 300 characters

email_body_html

string

>= 1 characters <= 20000 characters

sms_enabled

boolean

sms_body

string

>= 1 characters <= 1000 characters

source_filter

Array<string>

<= 50 items

Example^generated

{
  "is_active": true,
  "email_enabled": true,
  "email_subject": "example",
  "email_body_html": "example",
  "sms_enabled": true,
  "sms_body": "example",
  "source_filter": [
    "example"
  ]
}

Responses

200

OK

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

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

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}