Modifier une entreprise

Ce point d'accès permet de modifier les informations d'une entreprise. Seuls les paramètres fournis seront mis à jour, les autres seront ignorés.

Point d'accès

POST https://canadamotorjobs.com/api/v1/{locale}/businesses/edit

Paramètres

Paramètre	Type	Description	Obligatoire
id	string	L'identifiant de l'entreprise	Requis ou ref_id
ref_id	string	L'identifiant de l'entreprise dans votre système	Requis ou id
api_token	string	Votre clé d'API, si vous n'utilisez pas le bearer token	Requis si vous n'utilisez pas le bearer token
with_data	boolean	Si vous souhaitez recevoir les données de l'entreprise en plus de la réponse	Non
name	string	Le nom de l'entreprise	Non
category	string	La catégorie de l'entreprise	Non
logo	base64	Le logo de l'entreprise	Non
street_address	string	L'adresse de l'entreprise	Non
city	string	La ville de l'entreprise	Non
province	string	La province de l'entreprise	Non
country	string	Le pays de l'entreprise	Non
postal_code	string	Le code postal de l'entreprise	Non
latitude	float	La latitude de l'entreprise	Non
longitude	float	La longitude de l'entreprise	Non
phone	string	Le numéro de téléphone de l'entreprise	Non
email_facturation	string	L'adresse email de facturation de l'entreprise	Non
a_propos	markdown	Texte de description de l'entreprise	Non
why_work_with_us	markdown	Texte de pourquoi travailler avec cette entreprise	Non
working_conditions_custom	markdown	Texte des conditions de travail, idéalement en liste a puces	Non

Veuillez fournir que les paramètres qui doivent être mis à jour, les autres seront ignorés. Afin déviter de supprimer une donnée par inadvertance, veuillez utiliser une chaîne vide "" pour les paramètres qui doivent être mis à null.

Réponse

Retourne le statut de la requête ainsi que toutes les informations de l'entreprise avec les nouvelles informations mises à jour si le paramètre with_data est true.

Codes de réponse

Code	Message	Description
BUSINESS_UPDATED	L'entreprise a été mise à jour avec succès	Retourne les informations de l'entreprise mise à jour
NOT_FOUND	L'entreprise n'a pas été trouvée	Retourne une erreur si l'entreprise n'existe pas
INVALID_PARAMETERS	Les paramètres fournis sont invalides	Retourne une erreur si les paramètres fournis sont invalides
NOT_AUTHORIZED	Vous n'êtes pas autorisé à effectuer cette action	Retourne une erreur si vous n'êtes pas autorisé à effectuer cette action
ERROR_SERVER	Une erreur est survenue lors de la mise à jour de l'entreprise	Retourne une erreur si une erreur est survenue lors de la mise à jour de l'entreprise

Exemple d'une réponse avec des paramètres invalides

{
  "success": false,
  "code": "INVALID_PARAMETERS",
  "message": "Les paramètres fournis sont invalides",
  "errors": {
    "name": "Le nom ne peut pas être vide",
    "logo": "Impossible de traiter l'image fournie",
    "etc...": "Le reste des paramètres qui ont fait échouer la mise à jour"
  }
}

Exemple de code

Changement de l'adresse de l'entreprise et suppression du texte de pourquoi travailler avec cette entreprise

// Laravel PHP
use Illuminate\Support\Facades\Http;

$response = Http::withHeaders([
  "Authorization" => "Bearer your_api_token"
])->post("https://canadamotorjobs.com/api/v1/fr/businesses/edit", [
  "ref_id" => "1234567890", // L'identifiant de l'entreprise dans votre système
  "api_token" => "your_api_token" ?? null // Votre clé d'API, si vous n'utilisez pas le bearer token
  "street_address" => "123 Rue Saint-Catherine",
  "city" => "Montreal",
  "postal_code" => "H3Z 2Y7",
  "latitude" => 45.5017,
  "longitude" => -73.5673,
  "why_work_with_us" => "",//<= retire le texte de pourquoi travailler avec cette entreprise
]);