Skip to content
BoostMail Docs

Update a subscriber

PATCH
/subscribers/{id}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”
object
address1
string
address2
string
birthdate
string format: date-time
city
string
country_code
string
created_at
string format: date-time
custom_fields
object
key
additional properties
any
email
string format: email
first_name
string
gender
string
Allowed values: female male other
id
string
income_level
string
Allowed values: +150 -25 100-150 25-50 50-75 75-100
interests
Array<string>
last_name
string
membership_status
string
phone
string
social_media
Array<object>
object
platform
required
string
profile_id
required
string
state
string
statistics
object
key
additional properties
any
status
string
tags
Array<string>
timezone
string
updated_at
string format: date-time
zip
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”
object
address1
required
string
address2
required
string
birthdate
required
string format: date-time
city
required
string
country_code
required
string
created_at
required
string format: date-time
custom_fields
required
object
key
additional properties
any
email
required
string format: email
first_name
required
string
gender
required
string
id
required
string
income_level
required
string
interests
required
Array<string>
last_name
required
string
membership_status
required
string
phone
required
string
social_media
required
Array<object>
object
platform
required
string
profile_id
required
string
state
required
string
statistics
required
object
clicks
required
integer
delivered
required
integer
hard_bounces
required
integer
last_click_at
required
string format: date-time
last_open_at
required
string format: date-time
last_sent_at
required
string format: date-time
opens
required
integer
revenue_cents
required
integer
sent
required
integer
soft_bounces
required
integer
status
required
string
tags
required
Array<string>
timezone
required
string
updated_at
required
string format: date-time
zip
required
string

400

Section titled “400 ”

Invalid_request

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string

401

Section titled “401 ”

Invalid_credential

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string

403

Section titled “403 ”

Insufficient_scope

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string

404

Section titled “404 ”

Not_found

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string

409

Section titled “409 ”

Conflict

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string

422

Section titled “422 ”

Validation_failed

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string

429

Section titled “429 ”

Rate_limited

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string

500

Section titled “500 ”

Internal_error

object
error
required
object
code
required
string
details
required
Array<object>
object
code
required
string
field
required
string
message
required
string
message
required
string