Skip to main content

Update company config

Endpoint que permite modificar los datos de la configuraci贸n de una compa帽铆a. El endpoint recibe como par谩metro el company_id de la compa帽铆a a modificar y un body con la informaci贸n a modificar.

Es necesario ingresar el siguiente par谩metro por URL para hacer uso de este endpoint:

KeyData TypeExampleDescription
company_idString3identificador de lac compa帽铆a

Endpoint#

Headers

KeyValueDescription
Content-Typeapplication/json
AuthorizationBearer {{access_token}}access_token obtained in Atenea

Url

Method: PUT
URL: https://api.trust.lat/config-company/api/companies/{{company_id}}
caution

Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea

Como obtener un access token

Body#

Para ingresar los datos se har谩 body en formato JSON.

KeyValueTypeDescription
primary_color"#DADDFC"String (Hexadecimal color)C贸digo hexadecimal del color primario de la compa帽铆a
secondary_color"#FC997C"String (Hexadecimal color)C贸digo hexadecimal del color secundario de la compa帽铆a
image_urlhttps://picsum.photos/300/200String (URL)URL de la imagen de la compa帽铆a a usarse en emails y apps
verification_primary_color"#092A35"String (Hexadecimal color)C贸digo hexadecimal del color primario para el servicio de mailing
verification_secondary_color"#FC997C"String (Hexadecimal color)C贸digo hexadecimal del color secundario para el servicio de mailing
verification_body"Inserte su c贸digo de verificaci贸n en la aplicaci贸n"StringTexto a mostrar en el correo de verificaci贸n
option_1falseBooleanValor por defecto para la opci贸n 1 de las aplicaciones de la compa帽铆a
option_2falseBooleanValor por defecto para las opci贸n 2 aplicaciones de la compa帽铆a
option_3falseBooleanValor por defecto para las opci贸n 3 aplicaciones de la compa帽铆a

Code Examples#

curl --location --request PUT 'https://api.trust.lat/config-company/api/companies/3' \
--header 'Authorization: Bearer {{access_token}}' \
--data-raw '{
"verification_body" : "Inserte su c贸digo de verificaci贸n en la aplicaci贸n",
"verification_primary_color": "#092A35",
"verification_secondary_color": "#658525",
"image_url": "https://picsum.photos/300/200"
}'

Responses#

HTTP Code: 200 OK - Saved#

{
"status": true,
"message": "The registry configuration has been updated with company id '3'.",
"data": {
"id": 1,
"company_id": "3",
"primary_color": null,
"secondary_color": null,
"verification_primary_color": "#052B70",
"verification_secondary_color": "#2FCD9D",
"option_1": false,
"option_2": true,
"option_3": false,
"created_at": "2021-11-25T20:52:14.265Z",
"updated_at": "2021-12-02T21:15:57.753Z",
"image_url": "https://picsum.photos/300/200",
"verification_body": "Inserte su c贸digo de verificaci贸n en la aplicaci贸n"
}
}

HTTP Code: 200 Company not found#

{
"status": false,
"message": "Company not found",
"data": null
}
Last updated on by joaquin philippi