Met à jour la ressource Inbox.
const url = 'https://api.facteur.local/inboxes/example';const options = { method: 'PATCH', headers: { Authorization: 'Bearer <token>', 'Content-Type': 'application/merge-patch+json' }, body: '{ "description": "Codes for the pipeline", "name": "example", "quota": { "daily": 1, "monthly": { "percent": 1 }, "onExceed": "reject" }, "tags": [ "example" ], "workspace": "example" }'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.facteur.local/inboxes/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/merge-patch+json' \ --data '{ "description": "Codes for the pipeline", "name": "example", "quota": { "daily": 1, "monthly": { "percent": 1 }, "onExceed": "reject" }, "tags": [ "example" ], "workspace": "example" }'Met à jour la ressource Inbox.
Authorizations
Section intitulée « Authorizations »- bearerAuthws:write
Parameters
Section intitulée « Parameters »Path Parameters
Section intitulée « Path Parameters »Identifiant Inbox
Request Bodyrequired
Section intitulée « Request Bodyrequired »La ressource Inbox mise à jour
Une inbox : ce qu’un client ouvre pour recevoir des e-mails ou des SMS, dans un espace de travail.
object
La nouvelle description, 140 caractères au plus tels qu’un lecteur les compte ; une description vide la retire.
Example
Codes for the pipelineLe nouveau nom, 120 caractères au plus.
Les plafonds : daily et monthly sont un nombre de messages (monthly peut être {"percent": n}, n de 1 à 100, une part du volume mensuel inclus dans le plan ; le jour ne le peut pas), ou null pour les retirer ; onExceed vaut reject ou alert. Fixer un plafond demande un plan qui l’inclut ; en retirer un ne le demande jamais.
Les étiquettes, qui remplacent les actuelles : 12 au plus, de 32 caractères au plus, dédoublonnées sans tenir compte de la casse, la première graphie étant gardée. Une liste vide les efface.
L’adresse (slug) de l’espace de travail vers lequel déplacer l’inbox, un espace que l’appelant atteint. L’identifiant et l’adresse de l’inbox ne changent pas.
Responses
Section intitulée « Responses »Ressource Inbox mise à jour
Une inbox : ce qu’un client ouvre pour recevoir des e-mails ou des SMS, dans un espace de travail.
object
Ce que l’inbox reçoit ; cela ne change jamais.
Une ligne de texte libre ; vide quand il n’y en a pas, jamais null.
Combien d’extracteurs l’inbox a.
L’identifiant de l’inbox, 8 caractères en minuscules et chiffres : le premier label de son adresse, et la clé de chaque route. Il ne change jamais.
Combien de messages l’inbox contient, quel que soit leur statut.
Ce que l’inbox a reçu pendant le mois civil UTC, lu dans le registre : la rétention ne l’érode pas, contrairement à messageCount.
Vrai quand l’inbox ne garde aucun contenu et n’a pas de durée de conservation : retentionDays ne dit alors rien de ce qu’elle garde.
Les plafonds que l’inbox se fixe. Présents sur tous les plans, y compris ceux qui ne permettent pas d’en fixer : lire un plafond est la façon dont un client qui a quitté le plan trouve celui qu’il doit retirer. La somme des plafonds d’une organisation n’est jamais comparée au volume inclus dans son plan.
object
Le plafond d’un jour calendaire, en messages, ou null s’il n’y en a pas.
Le plafond mensuel, ou null s’il n’y en a pas.
object
Le plafond en messages, toujours le chiffre en vigueur ; null quand c’est un pourcentage d’un plan qui ne vend aucun volume inclus, ce qui ne retient rien.
La part du volume mensuel inclus dans le plan, de 1 à 100, quand le plafond a été écrit ainsi ; null sinon.
Ce que l’ingesteur fait quand un plafond est atteint : refuser le message, ou l’accepter et alerter.
Combien de jours les messages sont gardés, selon le plan qu’avait l’organisation à l’ouverture de l’inbox.
12 étiquettes au plus, de 32 caractères au plus, dédoublonnées sans tenir compte de la casse.
L’espace de travail où vit l’inbox, pour qu’un client qui détient une inbox puisse construire son adresse sans seconde requête.
object
Example
{ "channel": "email", "quota": { "onExceed": "reject" }, "smsNumber": "+447700900123"}Entrée invalide
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}Aucune clé, ou une clé refusée. WWW-Authenticate dit où lire comment en présenter une.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}L’offre de l’organisation ne comprend pas ce que l’appel demande, ou son abonnement est suspendu. currentPlan et requiredPlan nomment les offres quand une offre est en cause.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}La clé n’a pas la permission de l’opération, ou l’opération refuse toutes les clés.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}Il n’y a rien avec cet identifiant à la portée de la clé. La réponse est la même pour une autre organisation ou un espace de travail que la clé ne nomme pas.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}Plus d’appels que la clé n’en peut faire en une minute. Retry-After dit quand réessayer.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}Any refusal: an application/problem+json body whose code says which.
Un refus, en application/problem+json (RFC 9457) avec le code du registre. Un code ajoute les membres que sa règle demande (retryAfter, permission…), donc d’autres membres que ceux-ci peuvent arriver.
object
Le code stable du refus. Il ne change jamais une fois publié.
Du texte en anglais pour la personne qui lit la réponse. Il peut être reformulé : branchez-vous sur code.
Le statut HTTP.
Le nom du statut HTTP.
L’adresse du problème : /errors/<code>.
Sur un corps qui échoue à la validation, une entrée par champ.
object
Example
{ "code": "BAD_REQUEST", "status": 404, "title": "Not Found", "type": "/errors/INBOX_NOT_FOUND", "violations": [ { "code": "BAD_REQUEST" } ]}