Extole Integration API - Consumer to Extole
Consumer/advocate-facing operations: profiles, share links (shareables), referrals, reward status, content zones, and share events. 60 operations across 50 paths.
OpenAPI Specification
{
"components" : {
"examples" : {
"ADVOCATE_CODE_MISSING" : {
"summary" : "ADVOCATE_CODE_MISSING",
"value" : {
"code" : "ADVOCATE_CODE_MISSING",
"http_status_code" : 400,
"message" : "advocate_code is required in the share request.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"ADVOCATE_CODE_NOT_FOUND" : {
"summary" : "ADVOCATE_CODE_NOT_FOUND",
"value" : {
"code" : "ADVOCATE_CODE_NOT_FOUND",
"http_status_code" : 400,
"message" : "Advocate code not found",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"CHANNEL_MISSING" : {
"summary" : "CHANNEL_MISSING",
"value" : {
"code" : "CHANNEL_MISSING",
"http_status_code" : 400,
"message" : "Channel is missing",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"EXISTING_LINK" : {
"summary" : "EXISTING_LINK",
"value" : {
"code" : "EXISTING_LINK",
"http_status_code" : 400,
"message" : "Link already exists.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_IMAGE_URL" : {
"summary" : "INVALID_IMAGE_URL",
"value" : {
"code" : "INVALID_IMAGE_URL",
"http_status_code" : 400,
"message" : "Invalid image URL.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_MESSAGE_LENGTH" : {
"summary" : "INVALID_MESSAGE_LENGTH",
"value" : {
"code" : "INVALID_MESSAGE_LENGTH",
"http_status_code" : 400,
"message" : "Share message cannot exceed 2048 characters",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_PARTNER_CONTENT_URL" : {
"summary" : "INVALID_PARTNER_CONTENT_URL",
"value" : {
"code" : "INVALID_PARTNER_CONTENT_URL",
"http_status_code" : 400,
"message" : "Invalid partner content URL.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_RECIPIENT" : {
"summary" : "INVALID_RECIPIENT",
"value" : {
"code" : "INVALID_RECIPIENT",
"http_status_code" : 400,
"message" : "Recipient has a wrong syntax.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_RECIPIENTS" : {
"summary" : "INVALID_RECIPIENTS",
"value" : {
"code" : "INVALID_RECIPIENTS",
"http_status_code" : 400,
"message" : "Recipient has a wrong syntax.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_RECIPIENT_SIZE" : {
"summary" : "INVALID_RECIPIENT_SIZE",
"value" : {
"code" : "INVALID_RECIPIENT_SIZE",
"http_status_code" : 400,
"message" : "Cannot share to more than 25 recipients at once.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_SHAREABLE_ID" : {
"summary" : "INVALID_SHAREABLE_ID",
"value" : {
"code" : "INVALID_SHAREABLE_ID",
"http_status_code" : 400,
"message" : "ShareableId not valid in the share request.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_SHARE_MESSAGE_CHARACTERS" : {
"summary" : "INVALID_SHARE_MESSAGE_CHARACTERS",
"value" : {
"code" : "INVALID_SHARE_MESSAGE_CHARACTERS",
"http_status_code" : 400,
"message" : "Sorry, we can not put these characters in a share message.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_SHARE_MESSAGE_LINK" : {
"summary" : "INVALID_SHARE_MESSAGE_LINK",
"value" : {
"code" : "INVALID_SHARE_MESSAGE_LINK",
"http_status_code" : 400,
"message" : "Sorry, we can not put that link in a share message.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_SHARE_SUBJECT_CHARACTERS" : {
"summary" : "INVALID_SHARE_SUBJECT_CHARACTERS",
"value" : {
"code" : "INVALID_SHARE_SUBJECT_CHARACTERS",
"http_status_code" : 400,
"message" : "Sorry, we can not put these characters in a share subject.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_SHARE_SUBJECT_LINK" : {
"summary" : "INVALID_SHARE_SUBJECT_LINK",
"value" : {
"code" : "INVALID_SHARE_SUBJECT_LINK",
"http_status_code" : 400,
"message" : "Sorry, we can not put that link in a share subject.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_SHARE_URL" : {
"summary" : "INVALID_SHARE_URL",
"value" : {
"code" : "INVALID_SHARE_URL",
"http_status_code" : 400,
"message" : "Invalid share URL.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_SUBJECT_LENGTH" : {
"summary" : "INVALID_SUBJECT_LENGTH",
"value" : {
"code" : "INVALID_SUBJECT_LENGTH",
"http_status_code" : 400,
"message" : "Email subject cannot exceed 78 characters.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_TARGET_URL" : {
"summary" : "INVALID_TARGET_URL",
"value" : {
"code" : "INVALID_TARGET_URL",
"http_status_code" : 400,
"message" : "Invalid target URL.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"INVALID_URL_FORMAT" : {
"summary" : "INVALID_URL_FORMAT",
"value" : {
"code" : "INVALID_URL_FORMAT",
"http_status_code" : 400,
"message" : "Invalid URL format for URL.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"MESSAGE_MISSING" : {
"summary" : "MESSAGE_MISSING",
"value" : {
"code" : "MESSAGE_MISSING",
"http_status_code" : 400,
"message" : "Email message is missing.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"MISSING_MESSAGE" : {
"summary" : "MISSING_MESSAGE",
"value" : {
"code" : "MISSING_MESSAGE",
"http_status_code" : 400,
"message" : "Share message is missing.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"MISSING_RECIPIENT" : {
"summary" : "MISSING_RECIPIENT",
"value" : {
"code" : "MISSING_RECIPIENT",
"http_status_code" : 400,
"message" : "Recipient is missing.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"NON_EXISTING_LINK" : {
"summary" : "NON_EXISTING_LINK",
"value" : {
"code" : "NON_EXISTING_LINK",
"http_status_code" : 400,
"message" : "Link doesn't exist for update.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"NOT_FOUND" : {
"summary" : "NOT_FOUND",
"value" : {
"code" : "NOT_FOUND",
"http_status_code" : 403,
"message" : "Shareable Not Found.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"NO_RECIPIENT" : {
"summary" : "NO_RECIPIENT",
"value" : {
"code" : "NO_RECIPIENT",
"http_status_code" : 400,
"message" : "There is no recipient in the share request.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"RECEIPIENT_JSON_CONVERSION_ERROR" : {
"summary" : "RECEIPIENT_JSON_CONVERSION_ERROR",
"value" : {
"code" : "RECEIPIENT_JSON_CONVERSION_ERROR",
"http_status_code" : 400,
"message" : "Error occurred when converting recipient list to JSON",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"RECIPIENTS_MISSING" : {
"summary" : "RECIPIENTS_MISSING",
"value" : {
"code" : "RECIPIENTS_MISSING",
"http_status_code" : 400,
"message" : "Share recipient is missing.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"SHAREABLE_ID_MISSING" : {
"summary" : "SHAREABLE_ID_MISSING",
"value" : {
"code" : "SHAREABLE_ID_MISSING",
"http_status_code" : 400,
"message" : "ShareableId is missing in the share request.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"SHAREABLE_NOT_FOUND" : {
"summary" : "SHAREABLE_NOT_FOUND",
"value" : {
"code" : "SHAREABLE_NOT_FOUND",
"http_status_code" : 403,
"message" : "Shareable Not Found.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"SHARE_NOT_FOUND" : {
"summary" : "SHARE_NOT_FOUND",
"value" : {
"code" : "SHARE_NOT_FOUND",
"http_status_code" : 403,
"message" : "Share not found.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"UNREWARDABLE" : {
"summary" : "UNREWARDABLE",
"value" : {
"code" : "UNREWARDABLE",
"http_status_code" : 400,
"message" : "User must have an associated email to create a shareable.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"access_denied" : {
"summary" : "access_denied",
"value" : {
"code" : "access_denied",
"http_status_code" : 403,
"message" : "The access_token provided is not permitted to access the specified resource.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"asset_content_not_downloadable" : {
"summary" : "asset_content_not_downloadable",
"value" : {
"code" : "asset_content_not_downloadable",
"http_status_code" : 400,
"message" : "Asset content could not be downloaded",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"asset_limit_exceeded" : {
"summary" : "asset_limit_exceeded",
"value" : {
"code" : "asset_limit_exceeded",
"http_status_code" : 400,
"message" : "The number of assets exceeds the limit",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"asset_mime_type_invalid" : {
"summary" : "asset_mime_type_invalid",
"value" : {
"code" : "asset_mime_type_invalid",
"http_status_code" : 400,
"message" : "The supplied asset has an invalid mime type",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"asset_not_found" : {
"summary" : "asset_not_found",
"value" : {
"code" : "asset_not_found",
"http_status_code" : 400,
"message" : "Asset not found",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"asset_size_invalid" : {
"summary" : "asset_size_invalid",
"value" : {
"code" : "asset_size_invalid",
"http_status_code" : 400,
"message" : "The supplied asset has an invalid size",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"binding_error" : {
"summary" : "binding_error",
"value" : {
"code" : "binding_error",
"http_status_code" : 400,
"message" : "Argument is not of the expected type",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"blocked_content_url" : {
"summary" : "blocked_content_url",
"value" : {
"code" : "blocked_content_url",
"http_status_code" : 403,
"message" : "Content url is blocked",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"client_param_not_found" : {
"summary" : "client_param_not_found",
"value" : {
"code" : "client_param_not_found",
"http_status_code" : 403,
"message" : "Parameter not found",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"client_params_name_length_out_of_range" : {
"summary" : "client_params_name_length_out_of_range",
"value" : {
"code" : "client_params_name_length_out_of_range",
"http_status_code" : 403,
"message" : "The name supplied is too long",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"client_params_value_length_out_of_range" : {
"summary" : "client_params_value_length_out_of_range",
"value" : {
"code" : "client_params_value_length_out_of_range",
"http_status_code" : 403,
"message" : "The value supplied is too long",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"code_contains_reserved_word" : {
"summary" : "code_contains_reserved_word",
"value" : {
"code" : "code_contains_reserved_word",
"http_status_code" : 403,
"message" : "Shareable code contains reserved word",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"code_illegal_character" : {
"summary" : "code_illegal_character",
"value" : {
"code" : "code_illegal_character",
"http_status_code" : 403,
"message" : "Code can only contain alphanumeric, dash and underscore",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"code_out_of_range" : {
"summary" : "code_out_of_range",
"value" : {
"code" : "code_out_of_range",
"http_status_code" : 403,
"message" : "Code length must be between 4 and 50 characters",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"code_profane_word" : {
"summary" : "code_profane_word",
"value" : {
"code" : "code_profane_word",
"http_status_code" : 400,
"message" : "Code contains profane word",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"code_taken_by_promotion" : {
"summary" : "code_taken_by_promotion",
"value" : {
"code" : "code_taken_by_promotion",
"http_status_code" : 400,
"message" : "The code associated with this shareable is already used by a promotion link",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"content_description_length_exceeded" : {
"summary" : "content_description_length_exceeded",
"value" : {
"code" : "content_description_length_exceeded",
"http_status_code" : 403,
"message" : "Content description length exceeded",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"content_image_url_invalid" : {
"summary" : "content_image_url_invalid",
"value" : {
"code" : "content_image_url_invalid",
"http_status_code" : 403,
"message" : "Invalid content image_url",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"content_url_length_out_of_range" : {
"summary" : "content_url_length_out_of_range",
"value" : {
"code" : "content_url_length_out_of_range",
"http_status_code" : 400,
"message" : "Content url is out of range",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"data_attribute_name_invalid" : {
"summary" : "data_attribute_name_invalid",
"value" : {
"code" : "data_attribute_name_invalid",
"http_status_code" : 403,
"message" : "Shareable data attribute name is invalid",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"data_attribute_name_length_out_of_range" : {
"summary" : "data_attribute_name_length_out_of_range",
"value" : {
"code" : "data_attribute_name_length_out_of_range",
"http_status_code" : 403,
"message" : "Shareable data attribute name length is out of range. Max 200 chars",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"data_attribute_value_invalid" : {
"summary" : "data_attribute_value_invalid",
"value" : {
"code" : "data_attribute_value_invalid",
"http_status_code" : 403,
"message" : "Shareable data value is invalid",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"data_attribute_value_length_out_of_range" : {
"summary" : "data_attribute_value_length_out_of_range",
"value" : {
"code" : "data_attribute_value_length_out_of_range",
"http_status_code" : 403,
"message" : "Shareable data attribute value length is out of range. Max 2000 chars",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"email_mismatch" : {
"summary" : "email_mismatch",
"value" : {
"code" : "email_mismatch",
"http_status_code" : 403,
"message" : "Mismatch in specified emails",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"email_not_applicable" : {
"summary" : "email_not_applicable",
"value" : {
"code" : "email_not_applicable",
"http_status_code" : 400,
"message" : "Email attribute is not applicable for current identity key",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"expired_access_token" : {
"summary" : "expired_access_token",
"value" : {
"code" : "expired_access_token",
"http_status_code" : 403,
"message" : "The access_token provided with this request has expired.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"extole_destination_length_out_of_range" : {
"summary" : "extole_destination_length_out_of_range",
"value" : {
"code" : "extole_destination_length_out_of_range",
"http_status_code" : 400,
"message" : "Extole destination length is out of range. Max 2000 chars",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_access_token" : {
"summary" : "invalid_access_token",
"value" : {
"code" : "invalid_access_token",
"http_status_code" : 403,
"message" : "The access_token provided with this request is invalid.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_access_token_duration" : {
"summary" : "invalid_access_token_duration",
"value" : {
"code" : "invalid_access_token_duration",
"http_status_code" : 400,
"message" : "The duration provided with this request is invalid.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_content_url" : {
"summary" : "invalid_content_url",
"value" : {
"code" : "invalid_content_url",
"http_status_code" : 403,
"message" : "Invalid content url",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_creative_result" : {
"summary" : "invalid_creative_result",
"value" : {
"code" : "invalid_creative_result",
"http_status_code" : 400,
"message" : "Configured creative did not return json.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_email" : {
"summary" : "invalid_email",
"value" : {
"code" : "invalid_email",
"http_status_code" : 400,
"message" : "Invalid email",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_json" : {
"summary" : "invalid_json",
"value" : {
"code" : "invalid_json",
"http_status_code" : 400,
"message" : "JSON is invalid",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_length_first_name" : {
"summary" : "invalid_length_first_name",
"value" : {
"code" : "invalid_length_first_name",
"http_status_code" : 400,
"message" : "First Name length greater than 50 characters",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_length_last_name" : {
"summary" : "invalid_length_last_name",
"value" : {
"code" : "invalid_length_last_name",
"http_status_code" : 400,
"message" : "Last Name length greater than 50 characters",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_name" : {
"summary" : "invalid_name",
"value" : {
"code" : "invalid_name",
"http_status_code" : 400,
"message" : "The provided client name was invalid",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_parameter" : {
"summary" : "invalid_parameter",
"value" : {
"code" : "invalid_parameter",
"http_status_code" : 400,
"message" : "Parameter is invalid.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_person_email" : {
"summary" : "invalid_person_email",
"value" : {
"code" : "invalid_person_email",
"http_status_code" : 400,
"message" : "Invalid person email",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_person_id" : {
"summary" : "invalid_person_id",
"value" : {
"code" : "invalid_person_id",
"http_status_code" : 400,
"message" : "Invalid person_id",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_profile_picture_url" : {
"summary" : "invalid_profile_picture_url",
"value" : {
"code" : "invalid_profile_picture_url",
"http_status_code" : 400,
"message" : "Malformed profile_picture_url",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_reward_filter" : {
"summary" : "invalid_reward_filter",
"value" : {
"code" : "invalid_reward_filter",
"http_status_code" : 400,
"message" : "Invalid reward filter, one of: polling_id, reward_name or partner_event_id are required",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_reward_id" : {
"summary" : "invalid_reward_id",
"value" : {
"code" : "invalid_reward_id",
"http_status_code" : 400,
"message" : "Invalid reward id. Reward not found.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_shareable_id" : {
"summary" : "invalid_shareable_id",
"value" : {
"code" : "invalid_shareable_id",
"http_status_code" : 400,
"message" : "Invalid shareable id",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_value" : {
"summary" : "invalid_value",
"value" : {
"code" : "invalid_value",
"http_status_code" : 400,
"message" : "Data value is invalid",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"invalid_zone_name" : {
"summary" : "invalid_zone_name",
"value" : {
"code" : "invalid_zone_name",
"http_status_code" : 403,
"message" : "Invalid zone name (not an EMAIL zone)",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"jwt_authentication_error" : {
"summary" : "jwt_authentication_error",
"value" : {
"code" : "jwt_authentication_error",
"http_status_code" : 403,
"message" : "The jwt authentication failed.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"jwt_error" : {
"summary" : "jwt_error",
"value" : {
"code" : "jwt_error",
"http_status_code" : 403,
"message" : "The jwt authentication verification failed.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"key_taken" : {
"summary" : "key_taken",
"value" : {
"code" : "key_taken",
"http_status_code" : 403,
"message" : "The key associated with this shareable has already been specified",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"label_name_contains_illegal_character" : {
"summary" : "label_name_contains_illegal_character",
"value" : {
"code" : "label_name_contains_illegal_character",
"http_status_code" : 403,
"message" : "Label name can only contain alphanumeric, dash and underscore characters",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"label_name_length_out_of_range" : {
"summary" : "label_name_length_out_of_range",
"value" : {
"code" : "label_name_length_out_of_range",
"http_status_code" : 403,
"message" : "Label name is not of valid length",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"label_name_out_of_range" : {
"summary" : "label_name_out_of_range",
"value" : {
"code" : "label_name_out_of_range",
"http_status_code" : 400,
"message" : "Label name is not of valid length",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"method_unauthorized" : {
"summary" : "method_unauthorized",
"value" : {
"code" : "method_unauthorized",
"http_status_code" : 401,
"message" : "Unauthorized access to this endpoint",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"missing_access_token" : {
"summary" : "missing_access_token",
"value" : {
"code" : "missing_access_token",
"http_status_code" : 403,
"message" : "No access_token was provided with this request.",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"missing_campaign_id" : {
"summary" : "missing_campaign_id",
"value" : {
"code" : "missing_campaign_id",
"http_status_code" : 403,
"message" : "Campaign must be provided",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"missing_request_body" : {
"summary" : "missing_request_body",
"value" : {
"code" : "missing_request_body",
"http_status_code" : 400,
"message" : "Missing request body",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"missing_zone_name" : {
"summary" : "missing_zone_name",
"value" : {
"code" : "missing_zone_name",
"http_status_code" : 400,
"message" : "Zone name must be present",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"partner_id_missing" : {
"summary" : "partner_id_missing",
"value" : {
"code" : "partner_id_missing",
"http_status_code" : 400,
"message" : "Please pass a partner id",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"partner_user_id_already_defined" : {
"summary" : "partner_user_id_already_defined",
"value" : {
"code" : "partner_user_id_already_defined",
"http_status_code" : 400,
"message" : "Partner user id already defined",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"partner_user_id_invalid_length" : {
"summary" : "partner_user_id_invalid_length",
"value" : {
"code" : "partner_user_id_invalid_length",
"http_status_code" : 400,
"message" : "Partner user id length greater than 255 characters",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"person_email_already_defined" : {
"summary" : "person_email_already_defined",
"value" : {
"code" : "person_email_already_defined",
"http_status_code" : 400,
"message" : "Person email already defined",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"person_not_found" : {
"summary" : "person_not_found",
"value" : {
"code" : "person_not_found",
"http_status_code" : 403,
"message" : "Person not found",
"parameters" : { },
"unique_id" : "00000000-0000-0000-0000-000000000000"
}
},
"profile_not_set" : {
"summary" : "profile_not_set",
"value"
# --- truncated at 32 KB (399 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/extole/refs/heads/main/openapi/extole-integration-consumer-to-extole-openapi.json