Skip to content

ApiClient

Information about the API client

PropertyTypeRequiredDescription
subscriberIdstring (uuid)NoThe id of the Ferretly user associated with the API client key
organizationIdstring (uuid)NoThe id of the Ferretly organization associated with the API client key
ownerstringNoName of the API client key owner Nullable.
permissionsstringNoComma-separated list of permissions associated with the API client Nullable.
statusUpdateCallbackUrlstringNoWebhook URL Nullable.
clientSpecificPropertiesstringNoA place to store additional, generic properties about the API Client Nullable.
technicalContactEmailstringNoEmail address of the technical contact for this API client organization. Nullable.
allowPreferenceProfileUpdatebooleanNoGets or sets a value indicating whether this API client is allowed to update preference profiles.

Use only the documented fields.