Description
Format the label and return contactPermittedByRecord only for granted.
Contact and disclosure permissions describe what a supplied record says at a particular time. A boolean flag or formatted permission label cannot verify informed consent, identity, authority, or permission for a different purpose.
Format the label and return contactPermittedByRecord only for granted.
When to use this tool
Use Care Contact Permission Label when you need to preserve or compare a stated permission without broadening its meaning.
How to use the tool and how it works
- Enter contactCode, permission. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read label, contactPermittedByRecord. Inspect contactPermittedByRecord before interpreting the associated values.
Require nonempty contactCode and permission granted, declined, pending, or withdrawn. Format the label and return contactPermittedByRecord only for granted.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| contactCode | Contact Code | Required. Text; maximum UTF-16 length 8192. |
| permission | Permission | Required. Text; one of "granted", "declined", "pending", "withdrawn"; maximum UTF-16 length 8192. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| label | Formatted label for the supplied components under the convention above. | Required. Text; maximum UTF-16 length 8192. |
| contactPermittedByRecord | Contact Permitted By Record | Required. Boolean. |
{
"input": {
"contactCode": "C17",
"permission": "granted"
},
"output": {
"label": "C17 [contact permission: granted]",
"contactPermittedByRecord": true
}
}Limitations and assumptions
- The flag records supplied permission metadata; current consent, identity, safeguarding conditions, and legal authority require separate verification.
- Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
Alternative or Complementary methods
Check the original permission record, its scope, and current organizational requirements before contacting someone or disclosing information.
References
Similar or alternative tools
- Consent Recontact Preference Label
Accept yes, no, not-asked, or withdrawn and label the recontact preference.
- Reconciliation Consent Choice Label
Format the choice label and mark optedIn only for opt-in.