Create a recipient
POST
/v1/organizations/{orgId}/recipientsAuthorization
AuthorizationBasic auth · headerrequiredRegistered confidential integration credentials. Keep the secret server-side.
or
CookieAPI key · headerrequiredConsole-managed Vault session cookie; secure cookie naming may vary by environment.
Path parameters
orgIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Request body
requiredapplication/jsonaddressLine1string | nullShow propertiesHide properties
Any of:
string
stringnull
nulladdressLine2string | nullShow propertiesHide properties
Any of:
string
stringnull
nulladdressLine3string | nullShow propertiesHide properties
Any of:
string
stringnull
nullcitystring | nullShow propertiesHide properties
Any of:
string
stringnull
nullcompanyNamestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullcontactNamestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullcountryCodestring | nullShow propertiesHide properties
Any of:
string
stringnull
nulldefaultIncotermstring | nullShow propertiesHide properties
Any of:
string
stringnull
nullemailstring | nullShow propertiesHide properties
Any of:
string
stringnull
nullimporterOfRecordstring | nullShow propertiesHide properties
Any of:
string
stringnull
nulllegalNamestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullphonestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullpostalCodestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullregionstring | nullShow propertiesHide properties
Any of:
string
stringnull
nulltaxIdentifierstring | nullShow propertiesHide properties
Any of:
string
stringnull
nullsubmissionKeystringrequiredmin length 8 · max length 128 · matches ^[A-Za-z0-9_.:-]+$
Responses
200
Success
dataobjectrequiredShow propertiesHide properties
effectsstring[]requiredoperationIdstringrequiredoutcomestringrequiredrecipientobjectrequiredShow propertiesHide properties
addressLine1string | nullrequiredaddressLine2string | nullrequiredaddressLine3string | nullrequiredcitystring | nullrequiredcompanyNamestring | nullrequiredcontactNamestring | nullrequiredcountryCodestring | nullrequireddefaultIncotermstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullemailstring | nullrequiredidstringrequiredimporterOfRecordstring | nullrequiredlegalNamestring | nullrequiredphonestring | nullrequiredpostalCodestring | nullrequiredregionstring | nullrequiredrevisionintegerrequiredmax 9007199254740991
taxIdentifierstring | nullrequiredupdatedAtstring<date-time>requiredmatches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
metaobjectrequiredShow propertiesHide properties
requestIdstringrequireddefault
Error
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_readyfieldsobject[]Show propertiesHide properties
Array of
objectcodestringrequiredmessagestringrequiredpathstringrequiredmessagestringrequiredoperationIdstringmetaobjectrequiredShow propertiesHide properties
requestIdstringrequired