Actualizar perfil de marca

PATCH

/v1/branding-profiles/{id}

curl --request PATCH \
  --url https://api.chaski.ec/v1/branding-profiles/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "logo": "example", "primary_color": "example", "sender_name": "example", "sender_email": "[email protected]", "reply_to_email": "[email protected]" }'

Los campos en null se quitan (logo: null quita el logo).

Authorizations

• apiKey

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 100 characters /^[^\r\n"<>]*$/

logo

Any of:

string

string format: base64

>= 1 characters /^$|^(?:[0-9a-zA-Z+/]{4})*(?:(?:[0-9a-zA-Z+/]{2}==)|(?:[0-9a-zA-Z+/]{3}=))?$/

null

null

primary_color

Any of:

string

string

/^#[0-9a-fA-F]{6}$/

null

null

sender_name

Any of:

string

string

>= 1 characters <= 60 characters /^[^\r\n"<>]*$/

null

null

sender_email

Any of:

string

string format: email

<= 254 characters /^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

null

null

reply_to_email

Any of:

string

string format: email

/^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

null

null

Example ^generated

{
  "name": "example",
  "logo": "example",
  "primary_color": "example",
  "sender_name": "example",
  "sender_email": "[email protected]",
  "reply_to_email": "[email protected]"
}

Responses

200

OK

Media typeapplication/json

object

id

required

string

name

required

string

has_logo

required

El logo se descarga en /logo

boolean

primary_color

required

string | null

sender_name

required

El comprador ve “<sender_name> vía Chaski” como remitente

string | null

sender_email

required

Dirección del remitente en un dominio de envío verificado. Con null, o si el dominio deja de estar verificado, el correo sale desde el dominio de Chaski.

string | null

reply_to_email

required

string | null

emission_points

required

Puntos de emisión que usan este perfil

Array<object>

object

issuer

required

string

id

required

string

created_at

required

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

updated_at

required

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

Example

{
  "id": "brd_01jbx3k9q2f8m4tn6vwz0yh5ce",
  "primary_color": "#0f766e",
  "sender_email": "[email protected]",
  "emission_points": [
    {
      "id": "001-001"
    }
  ]
}

400

Petición inválida

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}

401

Falta la API key o no es válida

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}

404

No existe

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}

429

Demasiadas peticiones

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}