Solicitar alteração de email

POST/api/crm/v2/profile.request_email_changev2

operationId: profile.requestEmailChange

Cria uma solicitação para alterar o login e envia um link de confirmação para o novo endereço. O email atual permanece ativo até que o usuário acesse o link; o link é válido por 24 horas. O usuário pode ter apenas uma solicitação ativa: uma nova chamada sobrescreve a anterior e invalida seu link. Erros: 332 — o endereço é igual ao atual, 111 — o endereço já está em uso, 333 — o email já foi enviado, tente novamente mais tarde.

Autorização

api-token + language + role

Corpo da solicitação `application/json`

object

emailstringobrigatório

Exemplo: new@fs.pro

Respostas

object

statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject

descriptionstring

Exemplo: Successfully saved

email_confirmationobject

A solicitação foi criada — a interface exibe o estado de espera com um botão de cancelamento

emailstring

Exemplo: new@fs.pro

date_creationstring (DataTimeFormatSQL)

Exemplo: 2024-05-02 08:31:16

date_expirationstring (DataTimeFormatSQL)

Exemplo: 2024-05-02 08:31:16

curl -X POST 'https://foodsoul.pro/api/crm/v2/profile.request_email_change' \
  -H 'Authorization: Bearer fs_api_YOUR_TOKEN' \
  -H 'language: pt' \
  -H 'role: affiliate' \
  -H 'Content-Type: application/json' \
  -d '{"email":"new@fs.pro"}'

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://foodsoul.pro/api/crm/v2/profile.request_email_change', [
    'headers' => [
        'Authorization' => 'Bearer fs_api_YOUR_TOKEN',
        'language' => 'pt',
        'role' => 'affiliate',
    ],
    'json' => [
        'email' => 'new@fs.pro',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/profile.request_email_change", {
    method: "POST",
    headers: {
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "affiliate",
        "Content-Type": "application/json"
    },
    body: JSON.stringify({
        "email": "new@fs.pro"
    }),
})
const data = await response.json()

import requests

response = requests.request(
    "POST",
    "https://foodsoul.pro/api/crm/v2/profile.request_email_change",
    headers={
        "Authorization": "Bearer fs_api_YOUR_TOKEN",
        "language": "pt",
        "role": "affiliate",
    },
    json={
        "email": "new@fs.pro",
    },
)
data = response.json()

Resposta 200

{
  "status": "success",
  "data": {
    "description": "Successfully saved",
    "email_confirmation": {
      "email": "new@fs.pro",
      "date_creation": "2024-05-02 08:31:16",
      "date_expiration": "2024-05-02 08:31:16"
    }
  }
}

As solicitações são enviadas para foodsoul.pro — o host deste portal, não é possível escolher outro.

Solicitar alteração de email

Autorização

Corpo da solicitação application/json

Respostas

Corpo da solicitação `application/json`