Skip to main content
PATCH
Update FSMA settings

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

Identifier of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

The FSMA 204 settings to change. Send only the fields you are changing.

designated_contact_name
string | null

Name of the designated contact, up to 255 characters; empty clears it.

Maximum string length: 255
Pattern: ^[^\x00]{0,255}$
designated_contact_email
string | null

Email address of the designated contact, up to 254 characters; empty clears it. One that is not a valid address is refused with 422.

Maximum string length: 254
Pattern: ^[^\x00]{0,254}$
designated_contact_phone
string | null

Phone number of the designated contact, up to 40 characters; empty clears it.

Maximum string length: 40
Pattern: ^[^\x00]{0,40}$
tlc_prefix
string | null

Short token that starts each Traceability Lot Code, up to 16 characters, such as SALSA. Empty uses the organization's GLN instead.

Maximum string length: 16
Pattern: ^[^\x00]{0,16}$
tlc_pattern
string | null

Template for assigned Traceability Lot Codes, up to 128 characters. Use only {prefix}, {date}, {sequence} and {gtin}, with Python format specs such as {sequence:04d}; {sequence} is required because it keeps each code unique. A pattern that breaks these rules is refused with 422. Empty restores the default {prefix}-{date}-{sequence:04d}.

Maximum string length: 128
Pattern: ^[^\x00]{0,128}$

Response

OK

The organization's FSMA 204 designated contact and Traceability Lot Code settings.

designated_contact_name
string
required

Name of the person the FDA contacts for traceability records within 24 hours, as FSMA 204 requires on every traceability plan; empty when not set.

designated_contact_email
string
required

Email address of the designated contact; empty when not set.

designated_contact_phone
string
required

Phone number of the designated contact; empty when not set.

tlc_prefix
string
required

Short token that starts each Traceability Lot Code the organization assigns. Empty means the organization's GLN is used instead.

tlc_pattern
string
required

Template for the Traceability Lot Codes the organization assigns to food received from an exempt supplier without one. Tokens: {prefix}, {date} (YYYYMMDD), {sequence} and {gtin}.