Skip to content

Andamento e relatório de uma importação

GET/api/members/imports/{id}

Auth
Requires a token
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

Owner e admin. `status` (`ANALYZED`, `QUEUED`, `PROCESSING`, `DONE`, `FAILED`, `ABANDONED`, `INTERRUPTED` = parada pela suspensão da comunidade, F-86), `processedRows` de `totalRows`, as contagens e `rows`, as linhas ignoradas (`result: SKIPPED`, `reason` `NO_EMAIL`, `INVALID_EMAIL`, `DUPLICATE_IN_FILE`, `NO_CONSENT` ou `DECLINED`) e as que entraram com aviso (`warnings`, ex. `INVALID_VALUE` quando o valor não serve ao tipo do campo e ficou vazio, `INVALID_PHONE`).

Parameters

NameInTypeDescription
idrequiredpathstring (uuid)

Headers

NameTypeDescription
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Responses

StatusDescription
200A importação.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.

curl example

curl -X GET "https://api.memberfy.net/api/members/imports/<id>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"