Contatos: campos personalizados
Definir campo
Crie um campo personalizado, ou renomeie e altere suas opções. Cada campo tem seu próprio índice, então você pode filtrar e ordenar por ele na hora.
https://g.sendcorex.com/v1/contactscommand: define_fieldPrecisa do scope contact:create na sua API key.
Chamar de novo com o mesmo key e type atualiza o nome e as opções. O tipo nunca muda: tentar falha com TYPE_LOCKED. Para mudá-lo, exclua o campo e crie de novo.
Argumentos
keystringobrigatórioa-z,0-9e_, começando com letra, até 40 caracteres.ex.:
"plan"typestringobrigatóriotext,number,date,bool,enumoumulti_enum.ex.:
"enum"namestringopcionalNome de exibição. Padrão: a chave.
ex.:
"Plan"optionsstring[]opcionalObrigatório para
enumemulti_enum: os valores permitidos.ex.:
["free", "pro", "business"]
Início rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "define_field",
args: {
key: "plan",
name: "Plan",
type: "enum",
options: [
"free",
"pro",
"business"
]
}
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);
const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);Resposta
{
"type": "SUCCESS",
"results": [
{
"command": "define_field",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"key": "plan",
"name": "Plan",
"type": "enum",
"options": [
"free",
"pro",
"business"
],
"created_at": "2026-10-01T10:00:00.000Z",
"updated_at": "2026-10-01T10:00:00.000Z"
}
}
]
}Campos da resposta
(field)O campo como ficou salvo:
key,name,type,options,created_at,updated_at.
Tipos
textAté 2.000 caracteres. Filtre por igual (ignorando maiúsculas e acentos),
containsouexists.numberInteiros ou decimais, negativos incluídos.
"1234,5"é lido como 1234.5. Intervalos e ordenação.dateYYYY-MM-DDou ISO. Intervalos e ordenação.booltrueoufalse."yes","sim"e"1"são lidos como verdadeiro.enumUma das
options."PRO"é salvo como"pro". Um valor fora das opções faz o item falhar.multi_enumQualquer quantidade de
options, como lista ou como"tech, golf". Não pode ser usado para ordenar.
Configure todos os seus campos de uma vez
Corpo do request
{
"commands": [
{
"command": "define_field",
"args": {
"key": "plan",
"name": "Plan",
"type": "enum",
"options": [
"free",
"pro",
"business"
]
}
},
{
"command": "define_field",
"args": {
"key": "age",
"name": "Age",
"type": "number"
}
},
{
"command": "define_field",
"args": {
"key": "city",
"name": "City",
"type": "text"
}
},
{
"command": "define_field",
"args": {
"key": "birthday",
"name": "Birthday",
"type": "date"
}
},
{
"command": "define_field",
"args": {
"key": "interests",
"name": "Interests",
"type": "multi_enum",
"options": [
"golf",
"tech",
"travel"
]
}
},
{
"command": "define_field",
"args": {
"key": "vip",
"name": "VIP",
"type": "bool"
}
}
]
}Uma conta pode ter até 100 campos. Acima disso, define_field falha com LIMIT_REACHED.
Erros
Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.
- 401
INVALID_API_KEYA API key não existe, foi revogada ou foi desativada no dashboard.
- 429
RATE_LIMITEDMais de 15 requests/s ou 15 simultâneos para o mesmo IP + API key. Espere o número de segundos em Retry-After.
- CMD
MISSING_SCOPEA API key não tem o scope que este comando precisa. Os outros comandos do request rodam mesmo assim.
- CMD
INVALID_ARGSUm argumento obrigatório está faltando ou é inválido: email, valor de campo, opção de enum, chave do where, id de lista…
- CMD
TYPE_LOCKEDdefine_field tentou mudar o tipo de um campo existente. Exclua e crie de novo.
- CMD
LIMIT_REACHEDA conta já tem 100 campos personalizados.
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.