Skip to content
FeitPayFeitPayFeitPay Docs

Replace a store's checkout branding

PUT
/v1/stores/{store_id}/branding
curl --request PUT \
  --url https://api.feitpay.com/v1/stores/example/branding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "example", "logo_url": "https://example.com", "accent_color": "example", "support_email": "hello@example.com", "support_url": "https://example.com", "website_domain": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
store_id
required
string

Header Parameters

Section titled “Header Parameters”
FeitPay-Organization
string

Active organization for dashboard sessions. Ignored for API keys (the key determines the organization).

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
display_name
required
string
>= 1 characters <= 80 characters
logo_url
string format: uri
/^https:///
accent_color
string
/^#[0-9A-Fa-f]{6}$/
support_email
string format: email
support_url
string format: uri
/^https:///
website_domain
string
<= 253 characters

Example generated

{
  "display_name": "example",
  "logo_url": "https://example.com",
  "accent_color": "example",
  "support_email": "hello@example.com",
  "support_url": "https://example.com",
  "website_domain": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Saved. Changing the website domain resets domain verification.

Media typeapplication/json
object
id
required
string
object
required
string
Allowed value: store
organization_id
required
string
name
required
string
website_url
required
string | null
default_currency
required
string
status
required
string
Allowed values: active disabled
sandbox_fixture
required
boolean
branding
required
object
display_name
required
string
logo_url
required
string | null
accent_color
required
string | null
support_email
required
string | null
support_url
required
string | null
website_domain
required
string | null
domain_verified
required
boolean
created_at
required
string format: date-time
updated_at
required
string format: date-time

Example 

{
  "object": "store",
  "status": "active"
}

401

Section titled “401”

Missing or invalid credentials.

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error
code
required
string
message
required
string
param
string
request_id
required
string

Example 

{
  "error": {
    "type": "invalid_request_error"
  }
}

403

Section titled “403”

Authenticated but not permitted.

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error
code
required
string
message
required
string
param
string
request_id
required
string

Example 

{
  "error": {
    "type": "invalid_request_error"
  }
}

404

Section titled “404”

Resource not found (or not visible to this tenant).

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error
code
required
string
message
required
string
param
string
request_id
required
string

Example 

{
  "error": {
    "type": "invalid_request_error"
  }
}

422

Section titled “422”

Validation failed.

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error
code
required
string
message
required
string
param
string
request_id
required
string

Example 

{
  "error": {
    "type": "invalid_request_error"
  }
}

429

Section titled “429”

Too many requests. See Retry-After.

Media typeapplication/json
object
error
required
object
type
required
string
Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error idempotency_error rate_limit_error feature_unavailable_error api_error
code
required
string
message
required
string
param
string
request_id
required
string

Example 

{
  "error": {
    "type": "invalid_request_error"
  }
}

Headers

Section titled “Headers”
Retry-After
integer