Download OpenAPI specification:Download
enfore API for managing contacts (incl. customers, suppliers and alternative payers)
Contacts are entities that the organization has dealings with. Contacts can be split into individual contacts (i.e., human persons) and organization contacts (i.e., other organizations/businesses). Additionally, contacts can have roles such as being a supplier or a customer. A single contact can have multiple roles. I.e., a supplier can also be a customer.
| org-id required | string ID of the organization whose data is being accessed. |
| limit | integer <int64> [ 1 .. 5000 ] Max number of objects to be returned per page.
Note that both the |
| offset | integer <int64> >= 0 Offset of items and problems of where to start the next page.
Similar to limit and offset in SQL, one would obtain the second page with |
Contacts are successfully returned
Credentials missing or not sufficient
Production
{- "items": [
- {
- "id": "string",
- "external_id": "string",
- "name": "string",
- "date_of_birth": "2025-03-25",
- "anniversary": "2025-03-25",
- "deleted": true
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| external_id | string [ 1 .. 256 ] characters |
| name required | string |
| date_of_birth | string <date> |
| anniversary | string <date> |
Contact has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Production
{- "external_id": "string",
- "name": "string",
- "date_of_birth": "2025-03-25",
- "anniversary": "2025-03-25"
}{- "id": "string",
- "external_id": "string",
- "name": "string",
- "date_of_birth": "2025-03-25",
- "anniversary": "2025-03-25",
- "deleted": true
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Contact is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "external_id": "string",
- "name": "string",
- "date_of_birth": "2025-03-25",
- "anniversary": "2025-03-25",
- "deleted": true
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| external_id | string [ 1 .. 256 ] characters |
| name required | string |
| date_of_birth | string <date> |
| anniversary | string <date> |
Contact was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "external_id": "string",
- "name": "string",
- "date_of_birth": "2025-03-25",
- "anniversary": "2025-03-25"
}{- "id": "string",
- "external_id": "string",
- "name": "string",
- "date_of_birth": "2025-03-25",
- "anniversary": "2025-03-25",
- "deleted": true
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Contact
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Contact is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "individual_contact": {
- "id": "string",
- "external_id": "string",
- "name": "string",
- "date_of_birth": "2025-03-25",
- "anniversary": "2025-03-25",
- "deleted": true
}, - "addresses": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "emails": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
], - "phones": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "web_addresses": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
], - "professional_identities": [
- {
- "professional_identity": {
- "id": "string",
- "organization_contact": "string",
- "is_active": true,
- "job_title": "string",
- "departments": [
- {
- "contact_id": "string",
- "department_id": "string"
}
], - "locations": [
- {
- "contact_id": "string",
- "location_id": "string"
}
]
}, - "addresses": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "emails": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
], - "phones": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "web_addresses": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
]
}
], - "personal_relationships": [
- {
- "id": "string",
- "type": "SPOUSE",
- "individual_contact": "string"
}
], - "customer_role": {
- "customer_id": "string",
- "is_active": true,
- "is_suspended": true,
- "customer_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "external_card": {
- "number": "string",
- "added": "2017-07-07T13:00:00Z"
}, - "tax_information": {
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr",
- "enabled_tax_exemptions": [
- "UNIVERSAL_POSTAL_SERVICE_DE"
]
}, - "global_location_number": "string",
- "alternative_payer": {
- "id": "string"
}, - "requires_formal_invoice": true,
- "credit_limit": {
- "value": 0,
- "unit": "AUD"
}, - "delivery_and_invoicing_configurations": [
- {
- "limitations": {
- "brand_id": "string"
}, - "alternative_payer": {
- "id": "string"
}, - "invoice_address_id": "string",
- "delivery_address_id": "string"
}
], - "debtor_account_id": "string"
}, - "supplier_role": {
- "supplier_id": "string",
- "is_active": true,
- "supplier_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "my_customer_id": "string",
- "tax_information": {
- "@type": "VendorTaxInformation",
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr"
}, - "global_location_number": "string",
- "creditor_account_id": "string"
}, - "alternative_payer_role": {
- "alternative_payer_id": "string",
- "is_active": true,
- "since": "2025-03-25",
- "debtor_account_id": "string"
}
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Address information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| type required | string (AddressType) Enum: "NOT_QUALIFIED" "FACTORY" "HEADQUARTERS" "HOME_OFFICE" "OFFICE" "OFFICE_CENTER" "PACKSTATION" "PO_BOX" "POST_OFFICE" "RESIDENTIAL_HOME" "SECOND_HOME" "SERVICE_POINT" "STORE" "SUBSIDIARY" "VACATION_HOME" "WAREHOUSE" |
| full_address required | string The full address as a string suitable for display to an end user. |
| recipient_name | string |
| care_of | string |
| street_name | string |
| street_number | string |
| additional | string |
| city | string |
| zip | string |
| country_code | string (CountryCode) Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SS" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "AN" "WG" "NO" The country code according to iso-3166-1-alpha-2 |
| description | string |
| usages | Array of strings (AddressUsage) Items Enum: "EVERYTHING" "CORRESPONDENCE" "INVOICES" "SHIPPING" |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Address has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| address-id required | string ID of the address |
Address is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| address-id required | string ID of the address |
| type required | string (AddressType) Enum: "NOT_QUALIFIED" "FACTORY" "HEADQUARTERS" "HOME_OFFICE" "OFFICE" "OFFICE_CENTER" "PACKSTATION" "PO_BOX" "POST_OFFICE" "RESIDENTIAL_HOME" "SECOND_HOME" "SERVICE_POINT" "STORE" "SUBSIDIARY" "VACATION_HOME" "WAREHOUSE" |
| full_address required | string The full address as a string suitable for display to an end user. |
| recipient_name | string |
| care_of | string |
| street_name | string |
| street_number | string |
| additional | string |
| city | string |
| zip | string |
| country_code | string (CountryCode) Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SS" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "AN" "WG" "NO" The country code according to iso-3166-1-alpha-2 |
| description | string |
| usages | Array of strings (AddressUsage) Items Enum: "EVERYTHING" "CORRESPONDENCE" "INVOICES" "SHIPPING" |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Address was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| address-id required | string ID of the address |
Delete successful
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Email information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| type required | string (EmailType) Enum: "NOT_QUALIFIED" "EMAIL_ALIAS" "MAILING_LIST" "PERSONAL_EMAIL" "WORK_EMAIL" |
| address required | string <email> |
| description | string |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Email has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| email-id required | string ID of the email |
Email is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| email-id required | string ID of the email |
| type required | string (EmailType) Enum: "NOT_QUALIFIED" "EMAIL_ALIAS" "MAILING_LIST" "PERSONAL_EMAIL" "WORK_EMAIL" |
| address required | string <email> |
| description | string |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Email was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| email-id required | string ID of the email |
Delete successful
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Phone information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| type required | string (PhoneType) Enum: "NOT_QUALIFIED" "DIRECT_EXTENSION" "DIRECT_FAX" "DIRECT_LINE" "FAX_LINE" "FIXED_LINE" "HOME_FAX" "HOME_PHONE" "HOTLINE" "MAIN" "MAIN_FAX" "MOBILE" "PAGER" "PERSONAL_MOBILE" "SAT" "VIRTUAL_LINE" "VOIP_LINE" "WORK_MOBILE" |
| number required | string |
| description | string |
| usages | Array of strings (PhoneUsage) Items Enum: "EVERYTHING" "CALL" "SMS" "WHATSAPP" |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Phone has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| phone-id required | string ID of the phone |
Phone is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| phone-id required | string ID of the phone |
| type required | string (PhoneType) Enum: "NOT_QUALIFIED" "DIRECT_EXTENSION" "DIRECT_FAX" "DIRECT_LINE" "FAX_LINE" "FIXED_LINE" "HOME_FAX" "HOME_PHONE" "HOTLINE" "MAIN" "MAIN_FAX" "MOBILE" "PAGER" "PERSONAL_MOBILE" "SAT" "VIRTUAL_LINE" "VOIP_LINE" "WORK_MOBILE" |
| number required | string |
| description | string |
| usages | Array of strings (PhoneUsage) Items Enum: "EVERYTHING" "CALL" "SMS" "WHATSAPP" |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Phone was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| phone-id required | string ID of the phone |
Delete successful
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Web address information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| type required | string (WebAddressType) Enum: "NOT_QUALIFIED" "BLOG" "FACEBOOK_PAGE_OR_PROFILE" "GOOGLE_PLUS_PROFILE" "HOMEPAGE_OR_WEBSITE" "LINKEDIN_PROFILE" "ONLINE_STORE" "ORGANIZATION_BLOG" "ORGANIZATION_PROFILE" "ORGANIZATION_WEBSITE" "OTHER" "PERSONAL_BLOG" "PERSONAL_PROFILE" "PERSONAL_WEBSITE" "PROFESSIONAL_BLOG" "PROFESSIONAL_PROFILE" "PROFESSIONAL_WEBSITE" "TWITTER_PROFILE" "TWITTER_STREAM" "XING_PROFILE" "YELP_IMAGE" "INSTAGRAM_PROFILE" "YOUTUBE" |
| url required | string <uri> |
| description | string |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Web address has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| web-address-id required | string ID of the address |
Web address is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| web-address-id required | string ID of the address |
| type required | string (WebAddressType) Enum: "NOT_QUALIFIED" "BLOG" "FACEBOOK_PAGE_OR_PROFILE" "GOOGLE_PLUS_PROFILE" "HOMEPAGE_OR_WEBSITE" "LINKEDIN_PROFILE" "ONLINE_STORE" "ORGANIZATION_BLOG" "ORGANIZATION_PROFILE" "ORGANIZATION_WEBSITE" "OTHER" "PERSONAL_BLOG" "PERSONAL_PROFILE" "PERSONAL_WEBSITE" "PROFESSIONAL_BLOG" "PROFESSIONAL_PROFILE" "PROFESSIONAL_WEBSITE" "TWITTER_PROFILE" "TWITTER_STREAM" "XING_PROFILE" "YELP_IMAGE" "INSTAGRAM_PROFILE" "YOUTUBE" |
| url required | string <uri> |
| description | string |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Address was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| web-address-id required | string ID of the address |
Delete successful
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Professional identity information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "organization_contact": "string",
- "is_active": true,
- "job_title": "string",
- "departments": [
- {
- "contact_id": "string",
- "department_id": "string"
}
], - "locations": [
- {
- "contact_id": "string",
- "location_id": "string"
}
]
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| organization_contact required | string [ 1 .. 256 ] characters The ID of the OrganizationContact that the IndividualContact owning the ProfessionalIdentity represents. |
| is_active required | boolean |
| job_title | string |
| departments | Array of objects (OrganizationDepartmentRef) The departments of the represented organization that the person works at. The array contains the IDs which reference Department items that belong to the OrganizationContact referenced by the PIs "organization_contact" field. |
| locations | Array of objects (OrganizationLocationRef) The locations of the represented organization that the person works at. The array contains the IDs which reference Location items that belong to the OrganizationContact referenced by the PIs "organization_contact" field. |
ProfessionalIdentity has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "organization_contact": "string",
- "is_active": true,
- "job_title": "string",
- "departments": [
- {
- "contact_id": "string",
- "department_id": "string"
}
], - "locations": [
- {
- "contact_id": "string",
- "location_id": "string"
}
]
}{- "id": "string",
- "organization_contact": "string",
- "is_active": true,
- "job_title": "string",
- "departments": [
- {
- "contact_id": "string",
- "department_id": "string"
}
], - "locations": [
- {
- "contact_id": "string",
- "location_id": "string"
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Professional identity information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "professional_identity": {
- "id": "string",
- "organization_contact": "string",
- "is_active": true,
- "job_title": "string",
- "departments": [
- {
- "contact_id": "string",
- "department_id": "string"
}
], - "locations": [
- {
- "contact_id": "string",
- "location_id": "string"
}
]
}, - "addresses": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "emails": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
], - "phones": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "web_addresses": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
]
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the ProfessionalIdentity |
ProfessionalIdentity is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "organization_contact": "string",
- "is_active": true,
- "job_title": "string",
- "departments": [
- {
- "contact_id": "string",
- "department_id": "string"
}
], - "locations": [
- {
- "contact_id": "string",
- "location_id": "string"
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the ProfessionalIdentity |
| is_active required | boolean |
| job_title | string |
| departments | Array of objects (OrganizationDepartmentRef) The departments of the represented organization that the person works at. The array contains the IDs which reference Department items that belong to the OrganizationContact referenced by the PIs "organization_contact" field. |
| locations | Array of objects (OrganizationLocationRef) The locations of the represented organization that the person works at. The array contains the IDs which reference Location items that belong to the OrganizationContact referenced by the PIs "organization_contact" field. |
ProfessionalIdentity was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "is_active": true,
- "job_title": "string",
- "departments": [
- {
- "contact_id": "string",
- "department_id": "string"
}
], - "locations": [
- {
- "contact_id": "string",
- "location_id": "string"
}
]
}{- "id": "string",
- "organization_contact": "string",
- "is_active": true,
- "job_title": "string",
- "departments": [
- {
- "contact_id": "string",
- "department_id": "string"
}
], - "locations": [
- {
- "contact_id": "string",
- "location_id": "string"
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the ProfessionalIdentity |
ProfessionalIdentity is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "professional_identity": {
- "id": "string",
- "organization_contact": "string",
- "is_active": true,
- "job_title": "string",
- "departments": [
- {
- "contact_id": "string",
- "department_id": "string"
}
], - "locations": [
- {
- "contact_id": "string",
- "location_id": "string"
}
]
}, - "addresses": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "emails": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
], - "phones": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "web_addresses": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity |
Address information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity |
| type required | string (AddressType) Enum: "NOT_QUALIFIED" "FACTORY" "HEADQUARTERS" "HOME_OFFICE" "OFFICE" "OFFICE_CENTER" "PACKSTATION" "PO_BOX" "POST_OFFICE" "RESIDENTIAL_HOME" "SECOND_HOME" "SERVICE_POINT" "STORE" "SUBSIDIARY" "VACATION_HOME" "WAREHOUSE" |
| full_address required | string The full address as a string suitable for display to an end user. |
| recipient_name | string |
| care_of | string |
| street_name | string |
| street_number | string |
| additional | string |
| city | string |
| zip | string |
| country_code | string (CountryCode) Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SS" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "AN" "WG" "NO" The country code according to iso-3166-1-alpha-2 |
| description | string |
| usages | Array of strings (AddressUsage) Items Enum: "EVERYTHING" "CORRESPONDENCE" "INVOICES" "SHIPPING" |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Address has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity the address belongs to |
| address-id required | string ID of the address |
Address is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity the address belongs to |
| address-id required | string ID of the address |
| type required | string (AddressType) Enum: "NOT_QUALIFIED" "FACTORY" "HEADQUARTERS" "HOME_OFFICE" "OFFICE" "OFFICE_CENTER" "PACKSTATION" "PO_BOX" "POST_OFFICE" "RESIDENTIAL_HOME" "SECOND_HOME" "SERVICE_POINT" "STORE" "SUBSIDIARY" "VACATION_HOME" "WAREHOUSE" |
| full_address required | string The full address as a string suitable for display to an end user. |
| recipient_name | string |
| care_of | string |
| street_name | string |
| street_number | string |
| additional | string |
| city | string |
| zip | string |
| country_code | string (CountryCode) Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SS" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "AN" "WG" "NO" The country code according to iso-3166-1-alpha-2 |
| description | string |
| usages | Array of strings (AddressUsage) Items Enum: "EVERYTHING" "CORRESPONDENCE" "INVOICES" "SHIPPING" |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Address was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity the emails belong to |
Email information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity the emails belong to |
| type required | string (EmailType) Enum: "NOT_QUALIFIED" "EMAIL_ALIAS" "MAILING_LIST" "PERSONAL_EMAIL" "WORK_EMAIL" |
| address required | string <email> |
| description | string |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Email has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity the email belongs to |
| email-id required | string ID of the email |
Email is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity the email belongs to |
| email-id required | string ID of the email |
| type required | string (EmailType) Enum: "NOT_QUALIFIED" "EMAIL_ALIAS" "MAILING_LIST" "PERSONAL_EMAIL" "WORK_EMAIL" |
| address required | string <email> |
| description | string |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Email was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity the phones belong to |
Phone information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity the phones belong to |
| type required | string (PhoneType) Enum: "NOT_QUALIFIED" "DIRECT_EXTENSION" "DIRECT_FAX" "DIRECT_LINE" "FAX_LINE" "FIXED_LINE" "HOME_FAX" "HOME_PHONE" "HOTLINE" "MAIN" "MAIN_FAX" "MOBILE" "PAGER" "PERSONAL_MOBILE" "SAT" "VIRTUAL_LINE" "VOIP_LINE" "WORK_MOBILE" |
| number required | string |
| description | string |
| usages | Array of strings (PhoneUsage) Items Enum: "EVERYTHING" "CALL" "SMS" "WHATSAPP" |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Phone has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity the phone belongs to |
| phone-id required | string ID of the phone |
Phone is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity the phone belongs to |
| phone-id required | string ID of the phone |
| type required | string (PhoneType) Enum: "NOT_QUALIFIED" "DIRECT_EXTENSION" "DIRECT_FAX" "DIRECT_LINE" "FAX_LINE" "FIXED_LINE" "HOME_FAX" "HOME_PHONE" "HOTLINE" "MAIN" "MAIN_FAX" "MOBILE" "PAGER" "PERSONAL_MOBILE" "SAT" "VIRTUAL_LINE" "VOIP_LINE" "WORK_MOBILE" |
| number required | string |
| description | string |
| usages | Array of strings (PhoneUsage) Items Enum: "EVERYTHING" "CALL" "SMS" "WHATSAPP" |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Phone was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity the addresses belong to |
Web address information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity the addresses belong to |
| type required | string (WebAddressType) Enum: "NOT_QUALIFIED" "BLOG" "FACEBOOK_PAGE_OR_PROFILE" "GOOGLE_PLUS_PROFILE" "HOMEPAGE_OR_WEBSITE" "LINKEDIN_PROFILE" "ONLINE_STORE" "ORGANIZATION_BLOG" "ORGANIZATION_PROFILE" "ORGANIZATION_WEBSITE" "OTHER" "PERSONAL_BLOG" "PERSONAL_PROFILE" "PERSONAL_WEBSITE" "PROFESSIONAL_BLOG" "PROFESSIONAL_PROFILE" "PROFESSIONAL_WEBSITE" "TWITTER_PROFILE" "TWITTER_STREAM" "XING_PROFILE" "YELP_IMAGE" "INSTAGRAM_PROFILE" "YOUTUBE" |
| url required | string <uri> |
| description | string |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Web address has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity the address belongs to |
| web-address-id required | string ID of the address |
Web address is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| professional-identity-id required | string ID of the professional identity the address belongs to |
| web-address-id required | string ID of the address |
| type required | string (WebAddressType) Enum: "NOT_QUALIFIED" "BLOG" "FACEBOOK_PAGE_OR_PROFILE" "GOOGLE_PLUS_PROFILE" "HOMEPAGE_OR_WEBSITE" "LINKEDIN_PROFILE" "ONLINE_STORE" "ORGANIZATION_BLOG" "ORGANIZATION_PROFILE" "ORGANIZATION_WEBSITE" "OTHER" "PERSONAL_BLOG" "PERSONAL_PROFILE" "PERSONAL_WEBSITE" "PROFESSIONAL_BLOG" "PROFESSIONAL_PROFILE" "PROFESSIONAL_WEBSITE" "TWITTER_PROFILE" "TWITTER_STREAM" "XING_PROFILE" "YELP_IMAGE" "INSTAGRAM_PROFILE" "YOUTUBE" |
| url required | string <uri> |
| description | string |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Address was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Customer info is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "customer_id": "string",
- "is_active": true,
- "is_suspended": true,
- "customer_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "external_card": {
- "number": "string",
- "added": "2017-07-07T13:00:00Z"
}, - "tax_information": {
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr",
- "enabled_tax_exemptions": [
- "UNIVERSAL_POSTAL_SERVICE_DE"
]
}, - "global_location_number": "string",
- "alternative_payer": {
- "id": "string"
}, - "requires_formal_invoice": true,
- "credit_limit": {
- "value": 0,
- "unit": "AUD"
}, - "delivery_and_invoicing_configurations": [
- {
- "limitations": {
- "brand_id": "string"
}, - "alternative_payer": {
- "id": "string"
}, - "invoice_address_id": "string",
- "delivery_address_id": "string"
}
], - "debtor_account_id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| customer_id required | string |
| is_active required | boolean |
| is_suspended required | boolean |
| customer_since required | string <date> |
| managed_by | object (ProfessionalIdentityRef) |
| external_card | object (CustomerCard) |
| tax_information | object (CustomerTaxInformation) Tax information about a customer. |
| global_location_number | string [ 1 .. 256 ] characters The Global Location Number (GLN) of the customer. See this PDF for more information on GLNs. The GLN of a customer will be printed on business documents related to that customer, for example on invoices. |
| alternative_payer | any (ContactRef) |
| requires_formal_invoice | boolean |
| credit_limit | object (Money) A Money represents a monetary value (i.e., a currency and an amount), for example "120 EUR" or "2,500.75 USD". |
| delivery_and_invoicing_configurations | Array of objects (CustomerDeliveryAndInvoicingConfiguration) The list of delivery and invoicing configurations for this customer. Whenever a delivery is configured for/by the customer or an invoice is created for the customer, certain information is needed: * what is the delivery address * what is the invoice address * is there an alternative payer for the invoice To determine this information, the enfore platform checks the CustomerDeliveryAndInvoicingConfiguration instances in this set to determine the configuration that is to be used (see below for more information). When no valid CustomerDeliveryAndInvoicingConfiguration is found, the platform falls back to determine the delivery and invoice address from the basic ContactBase.addressSet and no alternative payer. Note that the client UI may allow the user to manually override the information, depending on user rights and UI flow. Constraints:A customer may have multiple configurations but it is * forbidden to have multiple configurations with the same limitations. * forbidden to have multiple configurations without limitations. Logic to determine the configuration to be used:From the set of configuration, we first determine the configuration without limitations. There may be zero or one of those. From the remaining configurations, we remove all that have at least one non- matching limitation. If there are no configurations remaining, use the configuration without limitations when available. Otherwise, the remaining configurations are ordered by the priority of their limitations and the first one in that ordering is used. For the delivery and invoicing configurations, the limitation priority is (from highest to lowest): * brand Note that the limitations structure will be extended with more fields later on (e.g., min/max invoice amount). Then, the limitation priority becomes meaningful for the logic of choosing the applicable configration. For example, assume four limitations La, Lb Lc, and Ld (La > Lb > Lc > Ld) and the following configurations: * CFG "1": no limitations * CFG "2": La set * CFG "3": Lb set * CFG "4": La and Ld set * CFG "5": Lb, Lc, and Ld set Assuming all limitations of all confgurations match the context, configuration "4" would be used because: * "1" would be the one without limitations, but as there are configs with matching limitations, it does not get used * The remaining configs are ordered by priority of their limitations. * That ordering is "4" > "2" > "5" > "3" because * "4" and "2" have La set and the others do not * "4" has ld set but "2" does not * "5" has Lc set but "4" does not |
Customer info is successfully created or updated
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "customer_id": "string",
- "is_active": true,
- "is_suspended": true,
- "customer_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "external_card": {
- "number": "string"
}, - "tax_information": {
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr",
- "enabled_tax_exemptions": [
- "UNIVERSAL_POSTAL_SERVICE_DE"
]
}, - "global_location_number": "string",
- "alternative_payer": {
- "id": "string"
}, - "requires_formal_invoice": true,
- "credit_limit": {
- "value": 0,
- "unit": "AUD"
}, - "delivery_and_invoicing_configurations": [
- {
- "limitations": {
- "brand_id": "string"
}, - "alternative_payer": {
- "id": "string"
}, - "invoice_address_id": "string",
- "delivery_address_id": "string"
}
]
}{- "customer_id": "string",
- "is_active": true,
- "is_suspended": true,
- "customer_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "external_card": {
- "number": "string",
- "added": "2017-07-07T13:00:00Z"
}, - "tax_information": {
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr",
- "enabled_tax_exemptions": [
- "UNIVERSAL_POSTAL_SERVICE_DE"
]
}, - "global_location_number": "string",
- "alternative_payer": {
- "id": "string"
}, - "requires_formal_invoice": true,
- "credit_limit": {
- "value": 0,
- "unit": "AUD"
}, - "delivery_and_invoicing_configurations": [
- {
- "limitations": {
- "brand_id": "string"
}, - "alternative_payer": {
- "id": "string"
}, - "invoice_address_id": "string",
- "delivery_address_id": "string"
}
], - "debtor_account_id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Alternative payer info is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "alternative_payer_id": "string",
- "is_active": true,
- "since": "2025-03-25",
- "debtor_account_id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| alternative_payer_id required | string |
| is_active required | boolean |
| since required | string <date> |
Alternative payer info is successfully created or updated
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "alternative_payer_id": "string",
- "is_active": true,
- "since": "2025-03-25"
}{- "alternative_payer_id": "string",
- "is_active": true,
- "since": "2025-03-25",
- "debtor_account_id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Supplier info is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "supplier_id": "string",
- "is_active": true,
- "supplier_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "my_customer_id": "string",
- "tax_information": {
- "@type": "VendorTaxInformation",
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr"
}, - "global_location_number": "string",
- "creditor_account_id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| supplier_id required | string [ 1 .. 256 ] characters |
| is_active required | boolean |
| supplier_since required | string <date> |
| managed_by | object (ProfessionalIdentityRef) |
| my_customer_id | string |
| tax_information | any (SupplierTaxInformation) |
| global_location_number | string [ 1 .. 256 ] characters The Global Location Number (GLN) of the supplier. See this PDF for more information on GLNs. The GLN of a supplier will be printed on business documents related to that supplier, for example on purchase orders. |
Supplier info is successfully created or updated
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "supplier_id": "string",
- "is_active": true,
- "supplier_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "my_customer_id": "string",
- "tax_information": {
- "@type": "VendorTaxInformation",
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr"
}, - "global_location_number": "string"
}{- "supplier_id": "string",
- "is_active": true,
- "supplier_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "my_customer_id": "string",
- "tax_information": {
- "@type": "VendorTaxInformation",
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr"
}, - "global_location_number": "string",
- "creditor_account_id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Tag information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "name": "string"
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| name required | string [ 1 .. 256 ] characters Tag name as shown in the UI. |
Tag has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "name": "string"
}{- "id": "string",
- "name": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| tag-id required | string ID of the tag |
Tag successfully removed
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Successfully returns information
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string"
}
]
}This method inserts a new image to the list of images belonging to the contact. The image is inserted at the start of the list such that it becomes the default image. Note that at the moment only JPEG and PNG images are supported. A request size restriction may also be imposed by the gateway. Typically, the gateway limits requests over 12 Megabytes.
| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| data required | string The base64 encoded image binary |
Successfully added the image
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "data": "string"
}{- "id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| image-id required | string ID of the image |
Successfully removed the image
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
The mapping of internal to external IDs for individual contacts.
Credentials missing or not sufficient
Production
{- "items": [
- {
- "internal": "string",
- "external": "string"
}
]
}The external ID mapping is a one to one mapping. Every external ID as well as every internal ID needs to be unique in the given list.
| org-id required | string ID of the organization whose data is being accessed. |
| items required | Array of objects (IDMapping) The mapping of internal to external ID |
The mapping of internal to external IDs for individual contacts.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Specified data is semantically incorrect.
Production
{- "items": [
- {
- "internal": "string",
- "external": "string"
}
]
}{- "items": [
- {
- "internal": "string",
- "external": "string"
}
]
}The external ID mapping is a one to one mapping. Every external ID as well as every internal ID needs to be unique in the given list. All external and internal IDs that are in the list will have their corresponding mapping replaced with the one from the request.
| org-id required | string ID of the organization whose data is being accessed. |
| items required | Array of objects (IDMapping) The mapping of internal to external ID |
The mapping of internal to external IDs for individual contacts.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Specified data is semantically incorrect.
Production
{- "items": [
- {
- "internal": "string",
- "external": "string"
}
]
}{- "items": [
- {
- "internal": "string",
- "external": "string"
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| external-id required | string External ID for which an internal ID should be returned. |
The mapping of internal to external ID for individual contacts.
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "internal": "string",
- "external": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| external-id required | string External ID for which an internal ID should be returned. |
The mapping of internal to external ID for individual contact was sucessfully deleted.
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
The mapping of internal to external ID for individual contacts.
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "internal": "string",
- "external": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
The mapping of internal to external ID for individual contact was sucessfully deleted.
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "title": "string",
- "detail": "string",
}Organization contacts are businesses and other organizations that the organization has dealings with.
| org-id required | string ID of the organization whose data is being accessed. |
| limit | integer <int64> [ 1 .. 5000 ] Max number of objects to be returned per page.
Note that both the |
| offset | integer <int64> >= 0 Offset of items and problems of where to start the next page.
Similar to limit and offset in SQL, one would obtain the second page with |
Contacts are successfully returned
Credentials missing or not sufficient
Production
{- "items": [
- {
- "id": "string",
- "external_id": "string",
- "name": "string",
- "founded": "2025-03-25",
- "representatives": [
- {
- "professional_identity": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "is_active": true,
- "activation_date": "2017-07-07T13:00:00Z",
- "deactivation_date": "2017-07-07T13:00:00Z"
}
], - "founders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "leaders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "external_organization_id": "string",
- "deleted": true
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| external_id | string [ 1 .. 256 ] characters |
| name required | string |
| founded | string <date> |
| founders | Array of objects (ProfessionalIdentityRef) The founders of the organization. The array contains the IDs for accessing the professional identities of the founders of the organization. |
| leaders | Array of objects (ProfessionalIdentityRef) The leaders of the organization. The array contains the IDs for accessing the professional identities of the leaders of the organization. |
| external_organization_id | string An ID of addressing the organization in an external system. This field is currently only used by the Refund CUWOs when a refund for "another org" is performed to avoid creation of multiple org contact instances for the same organization. The ID may be an enfore organization ID, but this is not guaranteed and thus the ID must not be used in that way. |
Contact has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Production
{- "external_id": "string",
- "name": "string",
- "founded": "2025-03-25",
- "founders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "leaders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "external_organization_id": "string"
}{- "id": "string",
- "external_id": "string",
- "name": "string",
- "founded": "2025-03-25",
- "representatives": [
- {
- "professional_identity": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "is_active": true,
- "activation_date": "2017-07-07T13:00:00Z",
- "deactivation_date": "2017-07-07T13:00:00Z"
}
], - "founders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "leaders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "external_organization_id": "string",
- "deleted": true
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Contact is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "external_id": "string",
- "name": "string",
- "founded": "2025-03-25",
- "representatives": [
- {
- "professional_identity": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "is_active": true,
- "activation_date": "2017-07-07T13:00:00Z",
- "deactivation_date": "2017-07-07T13:00:00Z"
}
], - "founders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "leaders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "external_organization_id": "string",
- "deleted": true
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| external_id | string [ 1 .. 256 ] characters |
| name required | string |
| founded | string <date> |
| founders | Array of objects (ProfessionalIdentityRef) The founders of the organization. The array contains the IDs for accessing the professional identities of the founders of the organization. |
| leaders | Array of objects (ProfessionalIdentityRef) The leaders of the organization. The array contains the IDs for accessing the professional identities of the leaders of the organization. |
| external_organization_id | string An ID of addressing the organization in an external system. This field is currently only used by the Refund CUWOs when a refund for "another org" is performed to avoid creation of multiple org contact instances for the same organization. The ID may be an enfore organization ID, but this is not guaranteed and thus the ID must not be used in that way. |
Contact was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "external_id": "string",
- "name": "string",
- "founded": "2025-03-25",
- "founders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "leaders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "external_organization_id": "string"
}{- "id": "string",
- "external_id": "string",
- "name": "string",
- "founded": "2025-03-25",
- "representatives": [
- {
- "professional_identity": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "is_active": true,
- "activation_date": "2017-07-07T13:00:00Z",
- "deactivation_date": "2017-07-07T13:00:00Z"
}
], - "founders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "leaders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "external_organization_id": "string",
- "deleted": true
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Contact
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Contact is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "organization_contact": {
- "id": "string",
- "external_id": "string",
- "name": "string",
- "founded": "2025-03-25",
- "representatives": [
- {
- "professional_identity": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "is_active": true,
- "activation_date": "2017-07-07T13:00:00Z",
- "deactivation_date": "2017-07-07T13:00:00Z"
}
], - "founders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "leaders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "external_organization_id": "string",
- "deleted": true
}, - "addresses": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "emails": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
], - "phones": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "web_addresses": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
], - "departments": [
- {
- "id": "string",
- "name": "string",
- "description": "string",
- "area": "ADMINISTRATION",
- "code": "string"
}
], - "locations": [
- {
- "id": "string",
- "name": "string",
- "leaders": [
- {
- "contact_id": "string",
- "professional_identity_id": "string"
}
], - "member_count": 0
}
], - "memberships": [
- {
- "id": "string",
- "type": "CLUB",
- "organization_contact": "string",
- "name": "string",
- "reference": "string"
}
], - "customer_role": {
- "customer_id": "string",
- "is_active": true,
- "is_suspended": true,
- "customer_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "external_card": {
- "number": "string",
- "added": "2017-07-07T13:00:00Z"
}, - "tax_information": {
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr",
- "enabled_tax_exemptions": [
- "UNIVERSAL_POSTAL_SERVICE_DE"
]
}, - "global_location_number": "string",
- "alternative_payer": {
- "id": "string"
}, - "requires_formal_invoice": true,
- "credit_limit": {
- "value": 0,
- "unit": "AUD"
}, - "delivery_and_invoicing_configurations": [
- {
- "limitations": {
- "brand_id": "string"
}, - "alternative_payer": {
- "id": "string"
}, - "invoice_address_id": "string",
- "delivery_address_id": "string"
}
], - "debtor_account_id": "string"
}, - "supplier_role": {
- "supplier_id": "string",
- "is_active": true,
- "supplier_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "my_customer_id": "string",
- "tax_information": {
- "@type": "VendorTaxInformation",
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr"
}, - "global_location_number": "string",
- "creditor_account_id": "string"
}, - "alternative_payer_role": {
- "alternative_payer_id": "string",
- "is_active": true,
- "since": "2025-03-25",
- "debtor_account_id": "string"
}
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Address information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| type required | string (AddressType) Enum: "NOT_QUALIFIED" "FACTORY" "HEADQUARTERS" "HOME_OFFICE" "OFFICE" "OFFICE_CENTER" "PACKSTATION" "PO_BOX" "POST_OFFICE" "RESIDENTIAL_HOME" "SECOND_HOME" "SERVICE_POINT" "STORE" "SUBSIDIARY" "VACATION_HOME" "WAREHOUSE" |
| full_address required | string The full address as a string suitable for display to an end user. |
| recipient_name | string |
| care_of | string |
| street_name | string |
| street_number | string |
| additional | string |
| city | string |
| zip | string |
| country_code | string (CountryCode) Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SS" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "AN" "WG" "NO" The country code according to iso-3166-1-alpha-2 |
| description | string |
| usages | Array of strings (AddressUsage) Items Enum: "EVERYTHING" "CORRESPONDENCE" "INVOICES" "SHIPPING" |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Address has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| address-id required | string ID of the address to load |
Address is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| address-id required | string ID of the address to load |
| type required | string (AddressType) Enum: "NOT_QUALIFIED" "FACTORY" "HEADQUARTERS" "HOME_OFFICE" "OFFICE" "OFFICE_CENTER" "PACKSTATION" "PO_BOX" "POST_OFFICE" "RESIDENTIAL_HOME" "SECOND_HOME" "SERVICE_POINT" "STORE" "SUBSIDIARY" "VACATION_HOME" "WAREHOUSE" |
| full_address required | string The full address as a string suitable for display to an end user. |
| recipient_name | string |
| care_of | string |
| street_name | string |
| street_number | string |
| additional | string |
| city | string |
| zip | string |
| country_code | string (CountryCode) Enum: "AF" "AX" "AL" "DZ" "AS" "AD" "AO" "AI" "AQ" "AG" "AR" "AM" "AW" "AU" "AT" "AZ" "BS" "BH" "BD" "BB" "BY" "BE" "BZ" "BJ" "BM" "BT" "BO" "BQ" "BA" "BW" "BV" "BR" "IO" "BN" "BG" "BF" "BI" "KH" "CM" "CA" "CV" "KY" "CF" "TD" "CL" "CN" "CX" "CC" "CO" "KM" "CG" "CD" "CK" "CR" "CI" "HR" "CU" "CW" "CY" "CZ" "DK" "DJ" "DM" "DO" "EC" "EG" "SV" "GQ" "ER" "EE" "ET" "FK" "FO" "FJ" "FI" "FR" "GF" "PF" "TF" "GA" "GM" "GE" "DE" "GH" "GI" "GR" "GL" "GD" "GP" "GU" "GT" "GG" "GN" "GW" "GY" "HT" "HM" "VA" "HN" "HK" "HU" "IS" "IN" "ID" "IR" "IQ" "IE" "IM" "IL" "IT" "JM" "JP" "JE" "JO" "KZ" "KE" "KI" "KP" "KR" "KW" "KG" "LA" "LV" "LB" "LS" "LR" "LY" "LI" "LT" "LU" "MO" "MK" "MG" "MW" "MY" "MV" "ML" "MT" "MH" "MQ" "MR" "MU" "YT" "MX" "FM" "MD" "MC" "MN" "ME" "MS" "MA" "MZ" "MM" "NA" "NR" "NP" "NL" "NC" "NZ" "NI" "NE" "NG" "NU" "NF" "MP" "OM" "PK" "PW" "PS" "PA" "PG" "PY" "PE" "PH" "PN" "PL" "PT" "PR" "QA" "RE" "RO" "RU" "RW" "BL" "SH" "KN" "LC" "MF" "PM" "VC" "WS" "SM" "ST" "SA" "SN" "RS" "SC" "SL" "SG" "SX" "SK" "SI" "SB" "SO" "ZA" "GS" "ES" "LK" "SD" "SS" "SR" "SJ" "SZ" "SE" "CH" "SY" "TW" "TJ" "TZ" "TH" "TL" "TG" "TK" "TO" "TT" "TN" "TR" "TM" "TC" "TV" "UG" "UA" "AE" "GB" "US" "UM" "UY" "UZ" "VU" "VE" "VN" "VG" "VI" "WF" "EH" "YE" "ZM" "ZW" "AN" "WG" "NO" The country code according to iso-3166-1-alpha-2 |
| description | string |
| usages | Array of strings (AddressUsage) Items Enum: "EVERYTHING" "CORRESPONDENCE" "INVOICES" "SHIPPING" |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Address was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "full_address": "string",
- "recipient_name": "string",
- "care_of": "string",
- "street_name": "string",
- "street_number": "string",
- "additional": "string",
- "city": "string",
- "zip": "string",
- "country_code": "AF",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| address-id required | string ID of the address to load |
Delete successful
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Email information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| type required | string (EmailType) Enum: "NOT_QUALIFIED" "EMAIL_ALIAS" "MAILING_LIST" "PERSONAL_EMAIL" "WORK_EMAIL" |
| address required | string <email> |
| description | string |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Email has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| email-id required | string ID of the email to load |
Email is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| email-id required | string ID of the email to load |
| type required | string (EmailType) Enum: "NOT_QUALIFIED" "EMAIL_ALIAS" "MAILING_LIST" "PERSONAL_EMAIL" "WORK_EMAIL" |
| address required | string <email> |
| description | string |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Email was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "address": "user@example.com",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| email-id required | string ID of the email to load |
Delete successful
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Phone information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| type required | string (PhoneType) Enum: "NOT_QUALIFIED" "DIRECT_EXTENSION" "DIRECT_FAX" "DIRECT_LINE" "FAX_LINE" "FIXED_LINE" "HOME_FAX" "HOME_PHONE" "HOTLINE" "MAIN" "MAIN_FAX" "MOBILE" "PAGER" "PERSONAL_MOBILE" "SAT" "VIRTUAL_LINE" "VOIP_LINE" "WORK_MOBILE" |
| number required | string |
| description | string |
| usages | Array of strings (PhoneUsage) Items Enum: "EVERYTHING" "CALL" "SMS" "WHATSAPP" |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Phone has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| phone-id required | string ID of the phone |
Phone is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| phone-id required | string ID of the phone |
| type required | string (PhoneType) Enum: "NOT_QUALIFIED" "DIRECT_EXTENSION" "DIRECT_FAX" "DIRECT_LINE" "FAX_LINE" "FIXED_LINE" "HOME_FAX" "HOME_PHONE" "HOTLINE" "MAIN" "MAIN_FAX" "MOBILE" "PAGER" "PERSONAL_MOBILE" "SAT" "VIRTUAL_LINE" "VOIP_LINE" "WORK_MOBILE" |
| number required | string |
| description | string |
| usages | Array of strings (PhoneUsage) Items Enum: "EVERYTHING" "CALL" "SMS" "WHATSAPP" |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Phone was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "number": "string",
- "description": "string",
- "usages": [
- "EVERYTHING"
], - "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| phone-id required | string ID of the phone |
Delete successful
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Web address information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| type required | string (WebAddressType) Enum: "NOT_QUALIFIED" "BLOG" "FACEBOOK_PAGE_OR_PROFILE" "GOOGLE_PLUS_PROFILE" "HOMEPAGE_OR_WEBSITE" "LINKEDIN_PROFILE" "ONLINE_STORE" "ORGANIZATION_BLOG" "ORGANIZATION_PROFILE" "ORGANIZATION_WEBSITE" "OTHER" "PERSONAL_BLOG" "PERSONAL_PROFILE" "PERSONAL_WEBSITE" "PROFESSIONAL_BLOG" "PROFESSIONAL_PROFILE" "PROFESSIONAL_WEBSITE" "TWITTER_PROFILE" "TWITTER_STREAM" "XING_PROFILE" "YELP_IMAGE" "INSTAGRAM_PROFILE" "YOUTUBE" |
| url required | string <uri> |
| description | string |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Web address has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| web-address-id required | string ID of the web address |
Web address is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| web-address-id required | string ID of the web address |
| type required | string (WebAddressType) Enum: "NOT_QUALIFIED" "BLOG" "FACEBOOK_PAGE_OR_PROFILE" "GOOGLE_PLUS_PROFILE" "HOMEPAGE_OR_WEBSITE" "LINKEDIN_PROFILE" "ONLINE_STORE" "ORGANIZATION_BLOG" "ORGANIZATION_PROFILE" "ORGANIZATION_WEBSITE" "OTHER" "PERSONAL_BLOG" "PERSONAL_PROFILE" "PERSONAL_WEBSITE" "PROFESSIONAL_BLOG" "PROFESSIONAL_PROFILE" "PROFESSIONAL_WEBSITE" "TWITTER_PROFILE" "TWITTER_STREAM" "XING_PROFILE" "YELP_IMAGE" "INSTAGRAM_PROFILE" "YOUTUBE" |
| url required | string <uri> |
| description | string |
| usage_context required | string (UsageContext) Enum: "ORGANIZATION" "PERSONAL" "PROFESSIONAL" |
Address was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}{- "id": "string",
- "type": "NOT_QUALIFIED",
- "description": "string",
- "usage_context": "ORGANIZATION"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| web-address-id required | string ID of the web address |
Delete successful
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Tag information is successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "name": "string"
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| name required | string [ 1 .. 256 ] characters Tag name as shown in the UI. |
Tag has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "name": "string"
}{- "id": "string",
- "name": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| tag-id required | string ID of the tag |
Tag successfully removed
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Customer info is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "customer_id": "string",
- "is_active": true,
- "is_suspended": true,
- "customer_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "external_card": {
- "number": "string",
- "added": "2017-07-07T13:00:00Z"
}, - "tax_information": {
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr",
- "enabled_tax_exemptions": [
- "UNIVERSAL_POSTAL_SERVICE_DE"
]
}, - "global_location_number": "string",
- "alternative_payer": {
- "id": "string"
}, - "requires_formal_invoice": true,
- "credit_limit": {
- "value": 0,
- "unit": "AUD"
}, - "delivery_and_invoicing_configurations": [
- {
- "limitations": {
- "brand_id": "string"
}, - "alternative_payer": {
- "id": "string"
}, - "invoice_address_id": "string",
- "delivery_address_id": "string"
}
], - "debtor_account_id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| customer_id required | string |
| is_active required | boolean |
| is_suspended required | boolean |
| customer_since required | string <date> |
| managed_by | object (ProfessionalIdentityRef) |
| external_card | object (CustomerCard) |
| tax_information | object (CustomerTaxInformation) Tax information about a customer. |
| global_location_number | string [ 1 .. 256 ] characters The Global Location Number (GLN) of the customer. See this PDF for more information on GLNs. The GLN of a customer will be printed on business documents related to that customer, for example on invoices. |
| alternative_payer | any (ContactRef) |
| requires_formal_invoice | boolean |
| credit_limit | object (Money) A Money represents a monetary value (i.e., a currency and an amount), for example "120 EUR" or "2,500.75 USD". |
| delivery_and_invoicing_configurations | Array of objects (CustomerDeliveryAndInvoicingConfiguration) The list of delivery and invoicing configurations for this customer. Whenever a delivery is configured for/by the customer or an invoice is created for the customer, certain information is needed: * what is the delivery address * what is the invoice address * is there an alternative payer for the invoice To determine this information, the enfore platform checks the CustomerDeliveryAndInvoicingConfiguration instances in this set to determine the configuration that is to be used (see below for more information). When no valid CustomerDeliveryAndInvoicingConfiguration is found, the platform falls back to determine the delivery and invoice address from the basic ContactBase.addressSet and no alternative payer. Note that the client UI may allow the user to manually override the information, depending on user rights and UI flow. Constraints:A customer may have multiple configurations but it is * forbidden to have multiple configurations with the same limitations. * forbidden to have multiple configurations without limitations. Logic to determine the configuration to be used:From the set of configuration, we first determine the configuration without limitations. There may be zero or one of those. From the remaining configurations, we remove all that have at least one non- matching limitation. If there are no configurations remaining, use the configuration without limitations when available. Otherwise, the remaining configurations are ordered by the priority of their limitations and the first one in that ordering is used. For the delivery and invoicing configurations, the limitation priority is (from highest to lowest): * brand Note that the limitations structure will be extended with more fields later on (e.g., min/max invoice amount). Then, the limitation priority becomes meaningful for the logic of choosing the applicable configration. For example, assume four limitations La, Lb Lc, and Ld (La > Lb > Lc > Ld) and the following configurations: * CFG "1": no limitations * CFG "2": La set * CFG "3": Lb set * CFG "4": La and Ld set * CFG "5": Lb, Lc, and Ld set Assuming all limitations of all confgurations match the context, configuration "4" would be used because: * "1" would be the one without limitations, but as there are configs with matching limitations, it does not get used * The remaining configs are ordered by priority of their limitations. * That ordering is "4" > "2" > "5" > "3" because * "4" and "2" have La set and the others do not * "4" has ld set but "2" does not * "5" has Lc set but "4" does not |
Customer info is successfully created or updated
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "customer_id": "string",
- "is_active": true,
- "is_suspended": true,
- "customer_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "external_card": {
- "number": "string"
}, - "tax_information": {
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr",
- "enabled_tax_exemptions": [
- "UNIVERSAL_POSTAL_SERVICE_DE"
]
}, - "global_location_number": "string",
- "alternative_payer": {
- "id": "string"
}, - "requires_formal_invoice": true,
- "credit_limit": {
- "value": 0,
- "unit": "AUD"
}, - "delivery_and_invoicing_configurations": [
- {
- "limitations": {
- "brand_id": "string"
}, - "alternative_payer": {
- "id": "string"
}, - "invoice_address_id": "string",
- "delivery_address_id": "string"
}
]
}{- "customer_id": "string",
- "is_active": true,
- "is_suspended": true,
- "customer_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "external_card": {
- "number": "string",
- "added": "2017-07-07T13:00:00Z"
}, - "tax_information": {
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr",
- "enabled_tax_exemptions": [
- "UNIVERSAL_POSTAL_SERVICE_DE"
]
}, - "global_location_number": "string",
- "alternative_payer": {
- "id": "string"
}, - "requires_formal_invoice": true,
- "credit_limit": {
- "value": 0,
- "unit": "AUD"
}, - "delivery_and_invoicing_configurations": [
- {
- "limitations": {
- "brand_id": "string"
}, - "alternative_payer": {
- "id": "string"
}, - "invoice_address_id": "string",
- "delivery_address_id": "string"
}
], - "debtor_account_id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Alternative payer info is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "alternative_payer_id": "string",
- "is_active": true,
- "since": "2025-03-25",
- "debtor_account_id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| alternative_payer_id required | string |
| is_active required | boolean |
| since required | string <date> |
Alternative payer info is successfully created or updated
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "alternative_payer_id": "string",
- "is_active": true,
- "since": "2025-03-25"
}{- "alternative_payer_id": "string",
- "is_active": true,
- "since": "2025-03-25",
- "debtor_account_id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Supplier info is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "supplier_id": "string",
- "is_active": true,
- "supplier_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "my_customer_id": "string",
- "tax_information": {
- "@type": "VendorTaxInformation",
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr"
}, - "global_location_number": "string",
- "creditor_account_id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| supplier_id required | string [ 1 .. 256 ] characters |
| is_active required | boolean |
| supplier_since required | string <date> |
| managed_by | object (ProfessionalIdentityRef) |
| my_customer_id | string |
| tax_information | any (SupplierTaxInformation) |
| global_location_number | string [ 1 .. 256 ] characters The Global Location Number (GLN) of the supplier. See this PDF for more information on GLNs. The GLN of a supplier will be printed on business documents related to that supplier, for example on purchase orders. |
Supplier info is successfully created or updated
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "supplier_id": "string",
- "is_active": true,
- "supplier_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "my_customer_id": "string",
- "tax_information": {
- "@type": "VendorTaxInformation",
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr"
}, - "global_location_number": "string"
}{- "supplier_id": "string",
- "is_active": true,
- "supplier_since": "2025-03-25",
- "managed_by": {
- "contact_id": "string",
- "professional_identity_id": "string"
}, - "my_customer_id": "string",
- "tax_information": {
- "@type": "VendorTaxInformation",
- "eu_vat_number": "string",
- "tax_registration_number": "stringstr"
}, - "global_location_number": "string",
- "creditor_account_id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
Successfully returns information
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string"
}
]
}This method inserts a new image to the list of images belonging to the contact. The image is inserted at the start of the list such that it becomes the default image. Note that at the moment only JPEG and PNG images are supported. A request size restriction may also be imposed by the gateway. Typically, the gateway limits requests over 12 Megabytes.
| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| data required | string The base64 encoded image binary |
Successfully added the image
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "data": "string"
}{- "id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
| image-id required | string ID of the image |
Successfully removed the image
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
The mapping of internal to external IDs for organization contacts.
Credentials missing or not sufficient
Production
{- "items": [
- {
- "internal": "string",
- "external": "string"
}
]
}The external ID mapping is a one to one mapping. Every external ID as well as every internal ID needs to be unique in the given list.
| org-id required | string ID of the organization whose data is being accessed. |
| items required | Array of objects (IDMapping) The mapping of internal to external ID |
The mapping of internal to external IDs for organization contacts.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Specified data is semantically incorrect.
Production
{- "items": [
- {
- "internal": "string",
- "external": "string"
}
]
}{- "items": [
- {
- "internal": "string",
- "external": "string"
}
]
}The external ID mapping is a one to one mapping. Every external ID as well as every internal ID needs to be unique in the given list. All external and internal IDs that are in the list will have their corresponding mapping replaced with the one from the request.
| org-id required | string ID of the organization whose data is being accessed. |
| items required | Array of objects (IDMapping) The mapping of internal to external ID |
The mapping of internal to external IDs for organization contacts.
Invalid parameters were sent by the client
Credentials missing or not sufficient
Specified data is semantically incorrect.
Production
{- "items": [
- {
- "internal": "string",
- "external": "string"
}
]
}{- "items": [
- {
- "internal": "string",
- "external": "string"
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| external-id required | string External ID for which an internal ID should be returned. |
The mapping of internal to external ID for organization contacts.
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "internal": "string",
- "external": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| external-id required | string External ID for which an internal ID should be returned. |
The mapping of internal to external ID for organization contact was sucessfully deleted.
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
The mapping of internal to external ID for organization contacts.
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "internal": "string",
- "external": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| contact-id required | string ID of the contact |
The mapping of internal to external ID for organization contact was sucessfully deleted.
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| limit | integer <int64> [ 1 .. 5000 ] Max number of objects to be returned per page.
Note that both the |
| offset | integer <int64> >= 0 Offset of items and problems of where to start the next page.
Similar to limit and offset in SQL, one would obtain the second page with |
PlaceholderCustomers are successfully returned
Invalid parameters were sent by the client
Credentials missing or not sufficient
Production
{- "items": [
- {
- "id": "string",
- "external_id": "string",
- "customer_id": "string",
- "name": "string",
- "is_active": true,
- "customer_since": "2025-03-25",
- "requires_formal_invoice": true,
- "track_revenue": true,
- "deleted": true
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| external_id | string [ 1 .. 256 ] characters |
| customer_id required | string |
| name required | string |
| is_active required | boolean |
| customer_since required | string <date> |
| requires_formal_invoice required | boolean |
| track_revenue required | boolean |
PlaceholderCustomer has successfully been added
Invalid parameters were sent by the client
Credentials missing or not sufficient
Specified data is semantically incorrect.
Production
{- "external_id": "string",
- "customer_id": "string",
- "name": "string",
- "is_active": true,
- "customer_since": "2025-03-25",
- "requires_formal_invoice": true,
- "track_revenue": true
}{- "id": "string",
- "external_id": "string",
- "customer_id": "string",
- "name": "string",
- "is_active": true,
- "customer_since": "2025-03-25",
- "requires_formal_invoice": true,
- "track_revenue": true,
- "deleted": true
}| org-id required | string ID of the organization whose data is being accessed. |
| placeholder-customer-id required | string ID of the placeholder customer |
PlaceholderCustomer is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "id": "string",
- "external_id": "string",
- "customer_id": "string",
- "name": "string",
- "is_active": true,
- "customer_since": "2025-03-25",
- "requires_formal_invoice": true,
- "track_revenue": true,
- "deleted": true
}| org-id required | string ID of the organization whose data is being accessed. |
| placeholder-customer-id required | string ID of the placeholder customer |
| external_id | string [ 1 .. 256 ] characters |
| customer_id required | string |
| name required | string |
| is_active required | boolean |
| customer_since required | string <date> |
| requires_formal_invoice required | boolean |
| track_revenue required | boolean |
PlaceholderCustomer was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "external_id": "string",
- "customer_id": "string",
- "name": "string",
- "is_active": true,
- "customer_since": "2025-03-25",
- "requires_formal_invoice": true,
- "track_revenue": true
}{- "id": "string",
- "external_id": "string",
- "customer_id": "string",
- "name": "string",
- "is_active": true,
- "customer_since": "2025-03-25",
- "requires_formal_invoice": true,
- "track_revenue": true,
- "deleted": true
}| org-id required | string ID of the organization whose data is being accessed. |
| placeholder-customer-id required | string ID of the placeholder customer |
PlaceholderCustomer
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| placeholder-customer-id required | string ID of the placeholder customer |
Successfully returns information
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string"
}
]
}This method inserts a new image to the list of images belonging to the contact. The image is inserted at the start of the list such that it becomes the default image. Note that at the moment only JPEG and PNG images are supported. A request size restriction may also be imposed by the gateway. Typically, the gateway limits requests over 12 Megabytes.
| org-id required | string ID of the organization whose data is being accessed. |
| placeholder-customer-id required | string ID of the placeholder customer |
| data required | string The base64 encoded image binary |
Successfully added the image
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "data": "string"
}{- "id": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| placeholder-customer-id required | string ID of the placeholder customer |
| image-id required | string ID of the image |
Successfully removed the image
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
Customer lists meta data
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string",
- "name": "string"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| name required | string non-empty Name of the customer list. |
Created customer list meta data
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "name": "string"
}{- "id": "string",
- "name": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| list-id required | string ID of the customer list |
Meta data of single customer list
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "id": "string",
- "name": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| list-id required | string ID of the customer list |
| name required | string non-empty Name of the customer list. |
Updated customer list meta data
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "name": "string"
}{- "id": "string",
- "name": "string"
}| org-id required | string ID of the organization whose data is being accessed. |
| list-id required | string ID of the customer list |
Customer list has been deleted
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
| list-id required | string ID of the customer list |
| limit | integer <int64> [ 1 .. 5000 ] Max number of objects to be returned per page.
Note that both the |
| offset | integer <int64> >= 0 Offset of items and problems of where to start the next page.
Similar to limit and offset in SQL, one would obtain the second page with |
Returns a customer list's items
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| list-id required | string ID of the customer list |
| items required | Array of any (ContactRef) The customer references contained in the sequence |
| problems | Array of objects (Problem) Any problems that occurred when handling the query |
Add item to customer
Invalid parameters were sent by the client
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "items": [
- {
- "id": "string"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}{- "items": [
- {
- "id": "string"
}
], - "problems": [
- {
- "title": "string",
- "detail": "string",
}
]
}| org-id required | string ID of the organization whose data is being accessed. |
| list-id required | string ID of the customer list |
| contact-id required | string ID of the contact |
Item has been successfully removed
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Production
{- "title": "string",
- "detail": "string",
}| org-id required | string ID of the organization whose data is being accessed. |
Configuration is successfully returned
Credentials missing or not sufficient
Resource(s) not found or invalid identifier
Specified data is semantically incorrect.
Production
{- "use_external_contact_management": false,
- "custom_workflow_config": {
- "provider_id": "string",
- "provide_contact_start_url": "string",
- "provide_contact_address_start_url": "string",
- "show_contact_details_start_url": "string"
}, - "api_access_configuration": {
- "url": "string",
- "credentials_key": "string",
- "timeout_in_millis": 2000,
- "max_retries": 3,
- "retry_interval_in_millis": 250
}
}| org-id required | string ID of the organization whose data is being accessed. |
| use_external_contact_management required | boolean Default: false When TRUE, the enfore CRM functionality is replaced by the "contacts" CUWOs and complementary API configured here. When FALSE, the enfore CRM is used normally and the the CUWOs and API configured here have not effect. |
| custom_workflow_config | object (ContactCUWOConfig) Holds information about the custom workflows defined for contact management. |
| api_access_configuration | object (ExternalAPIAccessConfiguration) A data structure holding the configuration data needed to access an external API. |
Configuration was successfully updated
Invalid parameters were sent by the client
Credentials missing or not sufficient
Specified data is semantically incorrect.
Production
{- "use_external_contact_management": false,
- "custom_workflow_config": {
- "provider_id": "string",
- "provide_contact_start_url": "string",
- "provide_contact_address_start_url": "string",
- "show_contact_details_start_url": "string"
}, - "api_access_configuration": {
- "url": "string",
- "credentials_key": "string",
- "timeout_in_millis": 2000,
- "max_retries": 3,
- "retry_interval_in_millis": 250
}
}{- "use_external_contact_management": false,
- "custom_workflow_config": {
- "provider_id": "string",
- "provide_contact_start_url": "string",
- "provide_contact_address_start_url": "string",
- "show_contact_details_start_url": "string"
}, - "api_access_configuration": {
- "url": "string",
- "credentials_key": "string",
- "timeout_in_millis": 2000,
- "max_retries": 3,
- "retry_interval_in_millis": 250
}
}