Complete a reserved registration

PATCH

/v1/communications/{id}

const url = 'https://api.fromenance.com/v1/communications/com_01J8Z9X0Q3K4M5N6P7R8S9T0V1';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"recipient_hash":"example","message_id":"example","from_address":"example","sent_at":"2026-04-15T12:00:00Z","subject_fingerprint":"example","content_fingerprint":{"simhash":"0x9a4d3c2b1f0e8d7c","sha256":"example"},"link_domains":["example"],"template_id":"example","campaign_id":"example","expires_at":"2026-04-15T12:00:00Z"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://api.fromenance.com/v1/communications/com_01J8Z9X0Q3K4M5N6P7R8S9T0V1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "recipient_hash": "example", "message_id": "example", "from_address": "example", "sent_at": "2026-04-15T12:00:00Z", "subject_fingerprint": "example", "content_fingerprint": { "simhash": "0x9a4d3c2b1f0e8d7c", "sha256": "example" }, "link_domains": [ "example" ], "template_id": "example", "campaign_id": "example", "expires_at": "2026-04-15T12:00:00Z" }'

Authorizations

ApiKey
register

Parameters

Path Parameters

required

string

/^com_[0-9A-Z]{26}$/

Example

com_01J8Z9X0Q3K4M5N6P7R8S9T0V1

Request Body

application/json

object

recipient_hash

string

/^hmac-sha256:[0-9a-f]{64}$/

message_id

string

>= 1 characters <= 998 characters

from_address

string

>= 3 characters <= 320 characters

sent_at

string format: date-time

subject_fingerprint

string

/^[0-9a-f]{64}$/

content_fingerprint

object

simhash

required

string

/^0x[0-9a-fA-F]{1,16}$/

Example

0x9a4d3c2b1f0e8d7c

sha256

required

string

/^[0-9a-f]{64}$/

link_domains

Array<string>

<= 50 items

template_id

string | null

<= 120 characters

campaign_id

string | null

<= 120 characters

expires_at

string format: date-time

Responses

200

Communication

application/json

object

required

string

channel

required

string

status

required

string

recipient_hash

required

string | null

message_id

required

string | null

from_address

required

string | null

sent_at

required

string | null

verify_code

required

string

subject_fingerprint

required

string | null

content_fingerprint

required

object

simhash

required

string

/^0x[0-9a-fA-F]{1,16}$/

sha256

required

string

/^[0-9a-f]{64}$/

link_domains

required

Array<string>

template_id

required

string | null

campaign_id

required

string | null

provider

required

string | null

source_id

required

string | null

retro

required

boolean

sandbox

required

boolean

reserved_at

required

string | null

completed_at

required

string | null

expires_at

required

string

created_at

required

string

verifications

Array<object>

object

submission_id

required

string

outcome

required

string

rule

required

string

received_at

required

string

Example

{
  "content_fingerprint": {
    "simhash": "0x9a4d3c2b1f0e8d7c"
  }
}