Criar link de convite

Endpoint: POST /unified/accounts/sellers/{sellers_pk}/invitation-links/

Autenticação: JWT obrigatório ou Chave de API aceita

Cria um link de convite pertencente ao sellers_pk. O link é identificado por um short_id gerado automaticamente (8 letras/dígitos minúsculos) e preenche previamente um subconjunto de campos aplicados quando uma nova conta é cadastrada por meio dele. Consulte Onboarding de sellers para o fluxo completo de cadastro. O creator é definido automaticamente a partir da URL — não envie esse campo no corpo da requisição. Definir agent, n1_distributor, n2_distributor, plan ou parent exige permissões granulares específicas atribuídas ao grupo de acesso do solicitante (register_account_choose_agent, register_account_choose_n1, register_account_choose_n2, register_account_choose_plan, register_account_sub).

Parâmetros de path

string (uuid)

required

Conta unificada que será dona (criadora) do link de convite.

Corpo

string

required

Rótulo livre exibido no painel.

string (uuid)

Agente predefinido (opcional) para o split da nova conta. Requer a permissão register_account_choose_agent.

string (uuid)

Distribuidor N1 predefinido (opcional). Requer register_account_choose_n1.

string (uuid)

Distribuidor N2 predefinido (opcional). Requer register_account_choose_n2.

string (uuid)

Plano de split predefinido (opcional). Requer register_account_choose_plan.

string (uuid)

Conta pai predefinida (opcional). Se definida, contas cadastradas pelo link viram sub-contas deste pai (seu type é rebaixado para SUB_SELLER_*). Requer register_account_sub.

Resposta

201 Created. Retorna o novo link de convite.

string (uuid)

string

Gerado automaticamente. Somente leitura. Use como identificador público ao distribuir o link.

string

string (uuid) | null

string

{
  "id": "44aa11b2-9c70-4f5b-8e21-12c8f7d9b1a2",
  "short_id": "k3p9q1xy",
  "name": "Força de vendas – Região SP",
  "agent": "ag-1111-...",
  "n1_distributor": null,
  "n2_distributor": null,
  "plan": "pl-1111-...",
  "parent": null,
  "created_at": "2025-04-12T10:00:00.000000Z",
  "updated_at": "2025-04-12T10:00:00.000000Z"
}

Erros

Status	Quando
`400`	Algum campo de pré-preenchimento referencia uma conta / plano que não existe; ou o solicitante não possui a permissão necessária para definir aquele campo.
`401`	Token ausente ou inválido.
`403`	Solicitante não tem acesso a `sellers_pk`.
`404`	`sellers_pk` não existe.

Exemplos

curl -X POST https://api.dlpay.cloud/unified/accounts/sellers/9b1f0d2a-2b40-4f3e-9c11-c2c0a1b3e711/invitation-links/ \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Força de vendas – Região SP",
    "agent": "ag-1111-2222-3333-4444",
    "plan": "pl-aaaa-bbbb-cccc-dddd"
  }'

import requests

response = requests.post(
    f"https://api.dlpay.cloud/unified/accounts/sellers/{seller_id}/invitation-links/",
    headers={"Authorization": f"Bearer {access_token}"},
    json={
        "name": "Força de vendas – Região SP",
        "agent": agent_id,
        "plan": plan_id,
    },
)
link = response.json()

const response = await fetch(
  `https://api.dlpay.cloud/unified/accounts/sellers/${sellerId}/invitation-links/`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${accessToken}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Força de vendas – Região SP",
      agent: agentId,
      plan: planId,
    }),
  },
);
const link = await response.json();

Início

Autenticação e usuários

Vendedores

Vendas

Planos

Contas unificadas

Eventos

Assinaturas

Contas virtuais

Integrações do vendedor

Criar link de convite

Parâmetros de path

Corpo

Resposta

Erros

Exemplos

​Parâmetros de path

​Corpo

​Resposta

​Erros

​Exemplos

Parâmetros de path

Corpo

Resposta

Erros

Exemplos