Missions

GET /client-companies

Lecture client-companies.index

Paramètres

cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/client-companies" \
  -H "Authorization: Bearer pat_…"

POST /client-companies

Écriture client-companies.store

Corps application/json

name string requis

longueur : au plus 255
industry string | null

longueur : au plus 255
headcount integer | null

au moins 1 au plus 10000000
country string | null

longueur : exactement 2
notes string | null

longueur : au plus 5000

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/client-companies" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

PATCH /client-companies/{company}

Écriture client-companies.update

Paramètres

company chemin: Identifiant (ULID).

Corps application/json

name string

longueur : au plus 255
industry string | null

longueur : au plus 255
headcount integer | null

au moins 1 au plus 10000000
country string | null

longueur : exactement 2
notes string | null

longueur : au plus 5000

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/client-companies/{company}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","industry":"…","headcount":1}'

DELETE /client-companies/{company}

Écriture client-companies.destroy

Paramètres

company chemin: Identifiant (ULID).

Réponses

204 Supprimé, sans contenu.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X DELETE "https://{votre-espace}.tellmehow.io/api/v1/client-companies/{company}" \
  -H "Authorization: Bearer pat_…"

GET /engagements

Lecture engagements.index

Paramètres

cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements" \
  -H "Authorization: Bearer pat_…"

POST /engagements

Écriture engagements.store

Corps application/json

name string requis

longueur : au plus 255
client_company_id string requis

longueur : exactement 26
method_id string requis

longueur : exactement 26
method_version_id string | null

longueur : exactement 26
locales array<string>

éléments : au moins 1
default_locale string | null

longueur : au plus 8
objectives string | null

longueur : au plus 10000
context string | null

longueur : au plus 20000
known_tools array<string>

éléments : au plus 60
vocabulary array<object>

éléments : au plus 100
vocabulary[].term string requis

longueur : au plus 120
vocabulary[].meaning string | null

longueur : au plus 500
deadline_at string | null

format date-time

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","client_company_id":"01JABCDEFGHJKMNPQRSTVWXYZ0","method_id":"01JABCDEFGHJKMNPQRSTVWXYZ0"}'

GET /engagements/enums/blur-categories

Lecture engagements.enums.blur-categories

Paramètres

cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/enums/blur-categories" \
  -H "Authorization: Bearer pat_…"

GET /engagements/enums/{name}

Lecture engagements.enums.show

Paramètres

name chemin: Valeur d’une liste fixe (type, langue, niveau…).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/enums/{name}" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}

Lecture engagements.show

Paramètres

engagement chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}" \
  -H "Authorization: Bearer pat_…"

PATCH /engagements/{engagement}

Écriture engagements.update

Paramètres

engagement chemin: Identifiant (ULID).

Corps application/json

name string

longueur : au plus 255
client_company_id string

longueur : exactement 26
method_id string

longueur : exactement 26
method_version_id string

longueur : exactement 26
context string | null

longueur : au plus 20000
objectives string | null

longueur : au plus 10000
vocabulary array<object>

éléments : au plus 100
vocabulary[].term string requis

longueur : au plus 120
vocabulary[].meaning string | null

longueur : au plus 500
known_tools array<string>

éléments : au plus 60
locales array<string>

éléments : au moins 1
default_locale string

longueur : au plus 8
sharing_mode object

une valeur parmi disabled anonymized by_role
naming_allowed boolean
deadline_at string | null

format date-time
retention_raw_days integer

au moins 1 au plus 3650
retention_deliverable_days integer

au moins 1 au plus 3650
video_mode object

une valeur parmi full keyframes
tacit_validation_days integer | null

au moins 1 au plus 60
blur_enabled boolean
blur_categories array<string>

une valeur parmi iban card nir email phone password custom mask
blur_custom_patterns array<object>

éléments : au plus 20
blur_custom_patterns[].label string requis

longueur : au plus 120
blur_custom_patterns[].regex string requis

longueur : au plus 500
posture_overrides array<object>
welcome_screen_overrides array<object>
reminder_schedule array<object>
reminder_schedule.enabled boolean
reminder_schedule.not_started_days array<integer>

éléments : au plus 6
reminder_schedule.unvalidated_days array<integer>

éléments : au plus 6
cse_informed_at string | null

format date-time
cse_consulted_at string | null

format date-time
budget_cap_session number | null

au moins 0 au plus 100000
budget_cap_total number | null

au moins 0 au plus 10000000
settings array<object>
settings.require_email_code boolean

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","client_company_id":"01JABCDEFGHJKMNPQRSTVWXYZ0","method_id":"01JABCDEFGHJKMNPQRSTVWXYZ0"}'

DELETE /engagements/{engagement}

Écriture engagements.destroy

Paramètres

engagement chemin: Identifiant (ULID).

Réponses

204 Supprimé, sans contenu.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X DELETE "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/archive

Écriture engagements.archive

Paramètres

engagement chemin: Identifiant (ULID).

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/archive" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/blur-preview

Écriture engagements.blur-preview

Paramètres

engagement chemin: Identifiant (ULID).

Corps application/json

text string requis

longueur : au plus 5000
blur_categories array<string>
blur_custom_patterns array<object>

éléments : au plus 20
blur_custom_patterns[].label string requis

longueur : au plus 120
blur_custom_patterns[].regex string requis

longueur : au plus 500

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/blur-preview" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"text":"…"}'

POST /engagements/{engagement}/invite-all

Écriture engagements.invite-all

Paramètres

engagement chemin: Identifiant (ULID).

Corps application/json

only_not_invited boolean
participant_ids array<string>

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/invite-all" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"only_not_invited":true,"participant_ids":[]}'

POST /engagements/{engagement}/launch

Écriture engagements.launch

Paramètres

engagement chemin: Identifiant (ULID).

Corps application/json

send_invitations boolean

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/launch" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"send_invitations":true}'

GET /engagements/{engagement}/launch-check

Lecture engagements.launch-check

Paramètres

engagement chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/launch-check" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/members

Écriture engagements.members.store

Paramètres

engagement chemin: Identifiant (ULID).

Corps application/json

user_id string requis

longueur : exactement 26

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/members" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"user_id":"01JABCDEFGHJKMNPQRSTVWXYZ0"}'

DELETE /engagements/{engagement}/members/{user}

Écriture engagements.members.destroy

Paramètres

engagement chemin: Identifiant (ULID).
user chemin: Identifiant (ULID).

Réponses

204 Supprimé, sans contenu.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X DELETE "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/members/{user}" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/message-templates

Lecture engagements.message-templates.index

Paramètres

engagement chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/message-templates" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/message-templates/{kind}/{locale}

Lecture engagements.message-templates.show

Paramètres

engagement chemin: Identifiant (ULID).
kind chemin: Valeur d’une liste fixe (type, langue, niveau…).
locale chemin: Valeur d’une liste fixe (type, langue, niveau…).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/message-templates/{kind}/{locale}" \
  -H "Authorization: Bearer pat_…"

PUT /engagements/{engagement}/message-templates/{kind}/{locale}

Écriture engagements.message-templates.update

Paramètres

engagement chemin: Identifiant (ULID).
kind chemin: Valeur d’une liste fixe (type, langue, niveau…).
locale chemin: Valeur d’une liste fixe (type, langue, niveau…).

Corps application/json

subject string requis

longueur : au plus 255
body_markdown string requis

longueur : au plus 20000

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X PUT "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/message-templates/{kind}/{locale}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"subject":"…","body_markdown":"…"}'

DELETE /engagements/{engagement}/message-templates/{kind}/{locale}

Écriture engagements.message-templates.destroy

Paramètres

engagement chemin: Identifiant (ULID).
kind chemin: Valeur d’une liste fixe (type, langue, niveau…).
locale chemin: Valeur d’une liste fixe (type, langue, niveau…).

Réponses

204 Supprimé, sans contenu.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X DELETE "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/message-templates/{kind}/{locale}" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/participants

Lecture engagements.participants.index

Paramètres

engagement chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/participants" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/participants

Écriture engagements.participants.store

Paramètres

engagement chemin: Identifiant (ULID).

Corps application/json

display_name string requis

longueur : au plus 255
email string requis

longueur : au plus 255 format email
role_title string requis

longueur : au plus 255
population_id string requis

longueur : exactement 26
locale string | null

longueur : au plus 8
consultant_note string | null

longueur : au plus 5000

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/participants" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"display_name":"…","email":"name@example.com","role_title":"…","population_id":"01JABCDEFGHJKMNPQRSTVWXYZ0"}'

POST /engagements/{engagement}/participants/import

Écriture engagements.participants.import

Paramètres

engagement chemin: Identifiant (ULID).

Corps multipart/form-data

file file requis

longueur : au plus 1024
dry_run boolean
create_populations boolean

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/participants/import" \
  -H "Authorization: Bearer pat_…" \
  -F "file=@./file.pdf"

GET /engagements/{engagement}/participants/{participant}

Lecture engagements.participants.show

Paramètres

engagement chemin: Identifiant (ULID).
participant chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/participants/{participant}" \
  -H "Authorization: Bearer pat_…"

PATCH /engagements/{engagement}/participants/{participant}

Écriture engagements.participants.update

Paramètres

engagement chemin: Identifiant (ULID).
participant chemin: Identifiant (ULID).

Corps application/json

display_name string

longueur : au plus 255
email string

longueur : au plus 255 format email
role_title string

longueur : au plus 255
population_id string

longueur : exactement 26
locale string | null

longueur : au plus 8
consultant_note string | null

longueur : au plus 5000

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/participants/{participant}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"display_name":"…","email":"name@example.com","role_title":"…"}'

DELETE /engagements/{engagement}/participants/{participant}

Écriture engagements.participants.destroy

Paramètres

engagement chemin: Identifiant (ULID).
participant chemin: Identifiant (ULID).

Réponses

204 Supprimé, sans contenu.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X DELETE "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/participants/{participant}" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/participants/{participant}/invite

Écriture engagements.participants.invite

Paramètres

engagement chemin: Identifiant (ULID).
participant chemin: Identifiant (ULID).

Corps application/json

locale string | null

longueur : au plus 8

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/participants/{participant}/invite" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"locale":"…"}'

GET /engagements/{engagement}/participants/{participant}/links

Lecture engagements.participants.links.index

Paramètres

engagement chemin: Identifiant (ULID).
participant chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/participants/{participant}/links" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/participants/{participant}/links

Écriture engagements.participants.links.store

Paramètres

engagement chemin: Identifiant (ULID).
participant chemin: Identifiant (ULID).

Corps application/json

purpose object

une valeur parmi interview follow_up recap_reminder
expires_in_days integer | null

au moins 1 au plus 365
requires_email_code boolean | null
chapter_id string | null

longueur : exactement 26

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/participants/{participant}/links" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"purpose":"interview","expires_in_days":1,"requires_email_code":true}'

POST /engagements/{engagement}/participants/{participant}/links/{token}/revoke

Écriture engagements.participants.links.revoke

Paramètres

engagement chemin: Identifiant (ULID).
participant chemin: Identifiant (ULID).
token chemin: Identifiant (ULID).

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/participants/{participant}/links/{token}/revoke" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/participants/{participant}/messages

Lecture engagements.participants.messages

Paramètres

engagement chemin: Identifiant (ULID).
participant chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/participants/{participant}/messages" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/participants/{participant}/reinstate

Écriture engagements.participants.reinstate

Paramètres

engagement chemin: Identifiant (ULID).
participant chemin: Identifiant (ULID).

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/participants/{participant}/reinstate" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/participants/{participant}/remind

Écriture engagements.participants.remind

Paramètres

engagement chemin: Identifiant (ULID).
participant chemin: Identifiant (ULID).

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/participants/{participant}/remind" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/participants/{participant}/revoke

Écriture engagements.participants.revoke

Paramètres

engagement chemin: Identifiant (ULID).
participant chemin: Identifiant (ULID).

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/participants/{participant}/revoke" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/plan/{ownerType}/{ownerId}

Lecture engagements.plan.show

Paramètres

engagement chemin: Identifiant (ULID).
ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/plan/{ownerType}/{ownerId}" \
  -H "Authorization: Bearer pat_…"

PUT /engagements/{engagement}/plan/{ownerType}/{ownerId}

Écriture engagements.plan.update

Paramètres

engagement chemin: Identifiant (ULID).
ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId chemin: Identifiant (ULID).

Corps application/json

chapters array<object>

éléments : au plus 30
chapters[].title string requis

longueur : au plus 255
chapters[].topic_keys array<string>
chapters[].estimated_minutes integer | null

au moins 1 au plus 240
chapters[].planned_session integer | null

au moins 1 au plus 20
chapters[].origin object

une valeur parmi consultant ai_proposal ai_live analysis

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X PUT "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/plan/{ownerType}/{ownerId}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"chapters":[]}'

GET /engagements/{engagement}/plan/{ownerType}/{ownerId}/proposals/{proposalId}

Lecture engagements.plan.proposals.show

Paramètres

engagement chemin: Identifiant (ULID).
ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId chemin: Identifiant (ULID).
proposalId chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/plan/{ownerType}/{ownerId}/proposals/{proposalId}" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/plan/{ownerType}/{ownerId}/propose

Écriture engagements.plan.propose

Paramètres

engagement chemin: Identifiant (ULID).
ownerType chemin: Valeur d’une liste fixe (type, langue, niveau…).
ownerId chemin: Identifiant (ULID).

Corps application/json

locale string | null

longueur : au plus 8
target_minutes integer | null

au moins 10 au plus 480
notes string | null

longueur : au plus 2000

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/plan/{ownerType}/{ownerId}/propose" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"locale":"…","target_minutes":10,"notes":"…"}'

GET /engagements/{engagement}/populations

Lecture engagements.populations.index

Paramètres

engagement chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/populations" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/populations

Écriture engagements.populations.store

Paramètres

engagement chemin: Identifiant (ULID).

Corps application/json

name string requis

longueur : au plus 255
description string | null

longueur : au plus 5000
expected_demonstrations array<string>

éléments : au plus 20

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/populations" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…"}'

POST /engagements/{engagement}/populations/reorder

Écriture engagements.populations.reorder

Paramètres

engagement chemin: Identifiant (ULID).

Corps application/json

ids array<string> requis

éléments : au moins 1

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/populations/reorder" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"ids":[]}'

PATCH /engagements/{engagement}/populations/{population}

Écriture engagements.populations.update

Paramètres

engagement chemin: Identifiant (ULID).
population chemin: Identifiant (ULID).

Corps application/json

name string

longueur : au plus 255
description string | null

longueur : au plus 5000
expected_demonstrations array<string>

éléments : au plus 20

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X PATCH "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/populations/{population}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"…","description":"…","expected_demonstrations":[]}'

DELETE /engagements/{engagement}/populations/{population}

Écriture engagements.populations.destroy

Paramètres

engagement chemin: Identifiant (ULID).
population chemin: Identifiant (ULID).

Réponses

204 Supprimé, sans contenu.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X DELETE "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/populations/{population}" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/progress

Lecture engagements.progress

Paramètres

engagement chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/progress" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/reopen

Écriture engagements.reopen

Paramètres

engagement chemin: Identifiant (ULID).

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/reopen" \
  -H "Authorization: Bearer pat_…"

GET /engagements/{engagement}/sponsors

Lecture engagements.sponsors.index

Paramètres

engagement chemin: Identifiant (ULID).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/sponsors" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/sponsors

Écriture engagements.sponsors.store

Paramètres

engagement chemin: Identifiant (ULID).

Corps application/json

email string requis

longueur : au plus 255 format email
name string | null

longueur : au plus 255
locale string | null

longueur : au plus 8

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/sponsors" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"email":"name@example.com"}'

DELETE /engagements/{engagement}/sponsors/{user}

Écriture engagements.sponsors.destroy

Paramètres

engagement chemin: Identifiant (ULID).
user chemin: Identifiant (ULID).

Réponses

204 Supprimé, sans contenu.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X DELETE "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/sponsors/{user}" \
  -H "Authorization: Bearer pat_…"

POST /engagements/{engagement}/test-interview

Écriture engagements.test-interview

Paramètres

engagement chemin: Identifiant (ULID).

Corps application/json

population_id string | null

longueur : exactement 26
participant_id string | null

longueur : exactement 26

Réponses

201 Créé (200 ou 202 pour une action ou un traitement asynchrone).
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X POST "https://{votre-espace}.tellmehow.io/api/v1/engagements/{engagement}/test-interview" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"population_id":"01JABCDEFGHJKMNPQRSTVWXYZ0","participant_id":"01JABCDEFGHJKMNPQRSTVWXYZ0"}'

GET /workspace/message-templates

Lecture workspace.message-templates.index

Paramètres

cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/workspace/message-templates" \
  -H "Authorization: Bearer pat_…"

GET /workspace/message-templates/{kind}/{locale}

Lecture workspace.message-templates.show

Paramètres

kind chemin: Valeur d’une liste fixe (type, langue, niveau…).
locale chemin: Valeur d’une liste fixe (type, langue, niveau…).
cursor limit requête: Pagination par curseur, pour les opérations qui rendent une liste paginée.

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl "https://{votre-espace}.tellmehow.io/api/v1/workspace/message-templates/{kind}/{locale}" \
  -H "Authorization: Bearer pat_…"

PUT /workspace/message-templates/{kind}/{locale}

Écriture workspace.message-templates.update

Paramètres

kind chemin: Valeur d’une liste fixe (type, langue, niveau…).
locale chemin: Valeur d’une liste fixe (type, langue, niveau…).

Corps application/json

subject string requis

longueur : au plus 255
body_markdown string requis

longueur : au plus 20000

Réponses

200 Succès : la ressource dans data.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X PUT "https://{votre-espace}.tellmehow.io/api/v1/workspace/message-templates/{kind}/{locale}" \
  -H "Authorization: Bearer pat_…" \
  -H "Content-Type: application/json" \
  -d '{"subject":"…","body_markdown":"…"}'

DELETE /workspace/message-templates/{kind}/{locale}

Écriture workspace.message-templates.destroy

Paramètres

kind chemin: Valeur d’une liste fixe (type, langue, niveau…).
locale chemin: Valeur d’une liste fixe (type, langue, niveau…).

Réponses

204 Supprimé, sans contenu.
401 Jeton absent, invalide, révoqué ou expiré.
403 Non autorisé par le rôle, une règle ou la portée.
404 Ressource inconnue ou hors de l’espace.
422 Données invalides (validation.failed).
429 Limite de débit atteinte.

Exemple

curl -X DELETE "https://{votre-espace}.tellmehow.io/api/v1/workspace/message-templates/{kind}/{locale}" \
  -H "Authorization: Bearer pat_…"